Package loci.poi.hssf.record
Class GutsRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.GutsRecord
Title: Guts Record
Description: Row/column gutter sizes
REFERENCE: PG 320 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
- Version:
- 2.0-pre
- Author:
- Andrew C. Oliver (acoliver at apache dot org), Jason Height (jheight at chariot dot net dot au)
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a Guts record and sets its fields appropriately. -
Method Summary
Modifier and TypeMethodDescriptionclone()protected voidcalled by the constructor, should set class level fields.shortget the maximum outline level for the col gutter.shortget the size of the gutter that appears at the left of the rowsintgives the current serialized size of the record.shortget the maximum outline level for the row gutter.shortgetSid()return the non static version of the id for this record.shortget the size of the gutter that appears at the above the columnsintserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.voidsetColLevelMax(short max) set the maximum outline level for the col gutter.voidsetLeftRowGutter(short gut) set the size of the gutter that appears at the left of the rowsvoidsetRowLevelMax(short max) set the maximum outline level for the row gutter.voidsetTopColGutter(short gut) set the size of the gutter that appears at the above the columnstoString()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
-
GutsRecord
public GutsRecord() -
GutsRecord
Constructs a Guts record and sets its fields appropriately.- Parameters:
in- the RecordInputstream to read the record from
-
-
Method Details
-
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
-
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
-
setLeftRowGutter
public void setLeftRowGutter(short gut) set the size of the gutter that appears at the left of the rows- Parameters:
gut- gutter size in screen units
-
setTopColGutter
public void setTopColGutter(short gut) set the size of the gutter that appears at the above the columns- Parameters:
gut- gutter size in screen units
-
setRowLevelMax
public void setRowLevelMax(short max) set the maximum outline level for the row gutter.- Parameters:
max- maximum outline level
-
setColLevelMax
public void setColLevelMax(short max) set the maximum outline level for the col gutter.- Parameters:
max- maximum outline level
-
getLeftRowGutter
public short getLeftRowGutter()get the size of the gutter that appears at the left of the rows- Returns:
- gutter size in screen units
-
getTopColGutter
public short getTopColGutter()get the size of the gutter that appears at the above the columns- Returns:
- gutter size in screen units
-
getRowLevelMax
public short getRowLevelMax()get the maximum outline level for the row gutter.- Returns:
- maximum outline level
-
getColLevelMax
public short getColLevelMax()get the maximum outline level for the col gutter.- Returns:
- maximum outline level
-
toString
Description copied from class:Recordget a string representation of the record (for biffview/debugging) -
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
-
getSid
public short getSid()Description copied from class:Recordreturn the non static version of the id for this record. -
clone
-