Top Description Fields Constructors Methods
org.apache.poi.hssf.record

public final Class ColumnInfoRecord

extends StandardRecord
Class Inheritance
Imports
java.util.Map, java.util.function.Supplier, org.apache.poi.util.BitField, .BitFieldFactory, .GenericRecordUtil, .LittleEndianOutput
Defines with width and formatting for a range of columns

Field Summary

Modifier and TypeField and Description
private int
_colWidth

private int
_firstCol

private int
_lastCol

private int
_options

private int
_xfIndex

private static final BitField
collapsed

private int
field_6_reserved

private static final BitField
hidden

private static final BitField
outlevel

public static final short
sid

Constructor Summary

AccessConstructor and Description
public
ColumnInfoRecord()

Creates a column info record with default width and format

public
ColumnInfoRecord(ColumnInfoRecord other)

public
ColumnInfoRecord(RecordInputStream in)

Method Summary

Modifier and TypeMethod and Description
public boolean
containsColumn(int columnIndex)

public ColumnInfoRecord
copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

public boolean

Returns:

true if the format, options and column width match
formatMatches(ColumnInfoRecord
the format to match with
other)

public boolean

Returns:

whether the cells are collapsed
getCollapsed()

public int

Returns:

column width in units of 1/256 of a character width
getColumnWidth()

protected int
getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

public int

Returns:

the first column index (0-based)
getFirstColumn()

get the first column this record defines formatting info for

public Map<String, Supplier<?>>
getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

public HSSFRecordTypes
getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

public boolean

Returns:

whether the cells are hidden.
getHidden()

public int

Returns:

the last column index (0-based)
getLastColumn()

get the last column this record defines formatting info for

public int

Returns:

outline level for the cells
getOutlineLevel()

public short
getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

public int

Returns:

the extended format index
getXFIndex()

get the columns' default format info

public boolean
isAdjacentBefore(ColumnInfoRecord other)

public void
serialize(LittleEndianOutput
the output object
out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Write the data content of this BIFF record.

public void
setCollapsed(boolean
- whether the cells are collapsed
isCollapsed)

set whether the cells are collapsed

public void
setColumnWidth(int
- column width
cw)

set the columns' width in 1/256 of a character width

public void
setFirstColumn(int
- the first column index (0-based)
fc)

set the first column this record defines formatting info for

public void
setHidden(boolean
- whether the cells are hidden.
ishidden)

set whether or not these cells are hidden

public void
setLastColumn(int
- the last column index (0-based)
lc)

set the last column this record defines formatting info for

public void
setOutlineLevel(int
-outline level for the cells
olevel)

set the outline level for the cells

public void
setXFIndex(int
- the extended format index
xfi)

set the columns' default format info

Inherited from org.apache.poi.hssf.record.StandardRecord:
getRecordSizeserialize

Field Detail

_colWidthback to summary
private int _colWidth
_firstColback to summary
private int _firstCol
_lastColback to summary
private int _lastCol
_optionsback to summary
private int _options
_xfIndexback to summary
private int _xfIndex
collapsedback to summary
private static final BitField collapsed
field_6_reservedback to summary
private int field_6_reserved
hiddenback to summary
private static final BitField hidden
outlevelback to summary
private static final BitField outlevel
sidback to summary
public static final short sid

Constructor Detail

ColumnInfoRecordback to summary
public ColumnInfoRecord()

Creates a column info record with default width and format

ColumnInfoRecordback to summary
public ColumnInfoRecord(ColumnInfoRecord other)
ColumnInfoRecordback to summary
public ColumnInfoRecord(RecordInputStream in)

Method Detail

containsColumnback to summary
public boolean containsColumn(int columnIndex)
copyback to summary
public ColumnInfoRecord copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:ColumnInfoRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations
@Override
formatMatchesback to summary
public boolean formatMatches(ColumnInfoRecord other)
Parameters
other:ColumnInfoRecord

the format to match with

Returns:boolean

true if the format, options and column width match

getCollapsedback to summary
public boolean getCollapsed()
Returns:boolean

whether the cells are collapsed

getColumnWidthback to summary
public int getColumnWidth()
Returns:int

column width in units of 1/256 of a character width

getDataSizeback to summary
protected int getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

getFirstColumnback to summary
public int getFirstColumn()

get the first column this record defines formatting info for

Returns:int

the first column index (0-based)

getGenericPropertiesback to summary
public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations
@Override
getGenericRecordTypeback to summary
public HSSFRecordTypes getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

Annotations
@Override
getHiddenback to summary
public boolean getHidden()
Returns:boolean

whether the cells are hidden.

getLastColumnback to summary
public int getLastColumn()

get the last column this record defines formatting info for

Returns:int

the last column index (0-based)

getOutlineLevelback to summary
public int getOutlineLevel()
Returns:int

outline level for the cells

getSidback to summary
public short getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

Doc from org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

Returns:short

he id for this record

getXFIndexback to summary
public int getXFIndex()

get the columns' default format info

Returns:int

the extended format index

See Also
org.apache.poi.hssf.record.ExtendedFormatRecord
isAdjacentBeforeback to summary
public boolean isAdjacentBefore(ColumnInfoRecord other)
serializeback to summary
public void serialize(LittleEndianOutput out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Doc from org.apache.poi.hssf.record.StandardRecord.serialize.

Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.

The number of bytes written must equal the record size reported by org.apache.poi.hssf.record.Record#getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Parameters
out:LittleEndianOutput

the output object

setCollapsedback to summary
public void setCollapsed(boolean isCollapsed)

set whether the cells are collapsed

Parameters
isCollapsed:boolean

- whether the cells are collapsed

setColumnWidthback to summary
public void setColumnWidth(int cw)

set the columns' width in 1/256 of a character width

Parameters
cw:int

- column width

setFirstColumnback to summary
public void setFirstColumn(int fc)

set the first column this record defines formatting info for

Parameters
fc:int

- the first column index (0-based)

setHiddenback to summary
public void setHidden(boolean ishidden)

set whether or not these cells are hidden

Parameters
ishidden:boolean

- whether the cells are hidden.

setLastColumnback to summary
public void setLastColumn(int lc)

set the last column this record defines formatting info for

Parameters
lc:int

- the last column index (0-based)

setOutlineLevelback to summary
public void setOutlineLevel(int olevel)

set the outline level for the cells

Parameters
olevel:int

-outline level for the cells

setXFIndexback to summary
public void setXFIndex(int xfi)

set the columns' default format info

Parameters
xfi:int

- the extended format index

See Also
org.apache.poi.hssf.record.ExtendedFormatRecord