Package loci.poi.hssf.record
Class ColumnInfoRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.ColumnInfoRecord
Title: ColumnInfo Record
Description: Defines with width and formatting for a range of columns
REFERENCE: PG 293 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
- Version:
- 2.0-pre
- Author:
- Andrew C. Oliver (acoliver at apache dot org)
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a ColumnInfo record and sets its fields appropriately -
Method Summary
Modifier and TypeMethodDescriptionclone()protected voidcalled by the constructor, should set class level fields.booleanget whether the cells are collapsedshortget the columns' width in 1/256 of a character widthshortget the first column this record defines formatting info forbooleanget whether or not these cells are hiddenshortget the last column this record defines formatting info forshortget the options bitfield - use the bitsetters insteadshortget the outline level for the cellsintgives the current serialized size of the record.shortgetSid()return the non static version of the id for this record.shortget the columns' default format infointserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.voidsetCollapsed(boolean iscollapsed) set whether the cells are collapsedvoidsetColumnWidth(short cw) set the columns' width in 1/256 of a character widthvoidsetFirstColumn(short fc) set the first column this record defines formatting info forvoidsetHidden(boolean ishidden) set whether or not these cells are hiddenvoidsetLastColumn(short lc) set the last column this record defines formatting info forvoidsetOptions(short options) set the options bitfield - use the bitsetters insteadvoidsetOutlineLevel(short olevel) set the outline level for the cellsvoidsetXFIndex(short xfi) set the columns' default format infotoString()get a string representation of the record (for biffview/debugging)protected voidvalidateSid(short id) called by constructor, should throw runtime exception in the event of a record passed with a differing ID.Methods inherited from class loci.poi.hssf.record.Record
isInValueSection, isValue, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
-
Constructor Details
-
ColumnInfoRecord
public ColumnInfoRecord() -
ColumnInfoRecord
Constructs a ColumnInfo record and sets its fields appropriately- Parameters:
in- the RecordInputstream to read the record from
-
-
Method Details
-
fillFields
Description copied from class:Recordcalled by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.- Specified by:
fillFieldsin classRecord- Parameters:
in- the RecordInputstream to read the record from
-
validateSid
protected void validateSid(short id) Description copied from class:Recordcalled by constructor, should throw runtime exception in the event of a record passed with a differing ID.- Specified by:
validateSidin classRecord- Parameters:
id- alleged id for this record
-
setFirstColumn
public void setFirstColumn(short fc) set the first column this record defines formatting info for- Parameters:
fc- - the first column index (0-based)
-
setLastColumn
public void setLastColumn(short lc) set the last column this record defines formatting info for- Parameters:
lc- - the last column index (0-based)
-
setColumnWidth
public void setColumnWidth(short cw) set the columns' width in 1/256 of a character width- Parameters:
cw- - column width
-
setXFIndex
public void setXFIndex(short xfi) set the columns' default format info- Parameters:
xfi- - the extended format index- See Also:
-
setOptions
public void setOptions(short options) set the options bitfield - use the bitsetters instead- Parameters:
options- - the bitfield raw value
-
setHidden
public void setHidden(boolean ishidden) set whether or not these cells are hidden- Parameters:
ishidden- - whether the cells are hidden.- See Also:
-
setOutlineLevel
public void setOutlineLevel(short olevel) set the outline level for the cells- Parameters:
olevel- -outline level for the cells- See Also:
-
setCollapsed
public void setCollapsed(boolean iscollapsed) set whether the cells are collapsed- Parameters:
iscollapsed- - wether the cells are collapsed- See Also:
-
getFirstColumn
public short getFirstColumn()get the first column this record defines formatting info for- Returns:
- the first column index (0-based)
-
getLastColumn
public short getLastColumn()get the last column this record defines formatting info for- Returns:
- the last column index (0-based)
-
getColumnWidth
public short getColumnWidth()get the columns' width in 1/256 of a character width- Returns:
- column width
-
getXFIndex
public short getXFIndex()get the columns' default format info- Returns:
- the extended format index
- See Also:
-
getOptions
public short getOptions()get the options bitfield - use the bitsetters instead- Returns:
- the bitfield raw value
-
getHidden
public boolean getHidden()get whether or not these cells are hidden- Returns:
- whether the cells are hidden.
- See Also:
-
getOutlineLevel
public short getOutlineLevel()get the outline level for the cells- Returns:
- outline level for the cells
- See Also:
-
getCollapsed
public boolean getCollapsed()get whether the cells are collapsed- Returns:
- wether the cells are collapsed
- See Also:
-
getSid
public short getSid()Description copied from class:Recordreturn the non static version of the id for this record. -
serialize
public int serialize(int offset, byte[] data) Description copied from class:Recordcalled by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array. -
getRecordSize
public int getRecordSize()Description copied from class:Recordgives the current serialized size of the record. Should include the sid and reclength (4 bytes).- Overrides:
getRecordSizein classRecord
-
toString
Description copied from class:Recordget a string representation of the record (for biffview/debugging) -
clone
-