Package org.apache.poi.hssf.record
Class GutsRecord
java.lang.Object
org.apache.poi.hssf.record.RecordBase
org.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.StandardRecord
org.apache.poi.hssf.record.GutsRecord
- All Implemented Interfaces:
Cloneable
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
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()shortget the maximum outline level for the col gutter.protected intshortget the size of the gutter that appears at the left of the rowsshortget 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 columnsvoidWrite the data content of this BIFF record.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)Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serializeMethods inherited from class org.apache.poi.hssf.record.Record
cloneViaReserialise, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
-
Constructor Details
-
GutsRecord
public GutsRecord() -
GutsRecord
-
-
Method Details
-
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
Description copied from class:StandardRecordWrite 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
RecordBase.getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).- Specified by:
serializein classStandardRecord- Parameters:
out- the output object
-
getDataSize
protected int getDataSize()- Specified by:
getDataSizein classStandardRecord
-
getSid
public short getSid()Description copied from class:Recordreturn the non static version of the id for this record. -
clone
-