Package loci.poi.hssf.record
Class GridsetRecord
- java.lang.Object
-
- loci.poi.hssf.record.Record
-
- loci.poi.hssf.record.GridsetRecord
-
public class GridsetRecord extends Record
Title: Gridset Record.Description: flag denoting whether the user specified that gridlines are used when printing.
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), Glen Stampoultzis (glens at apache.org), Jason Height (jheight at chariot dot net dot au)
-
-
Field Summary
Fields Modifier and Type Field Description short
field_1_gridset_flag
static short
sid
-
Constructor Summary
Constructors Constructor Description GridsetRecord()
GridsetRecord(RecordInputStream in)
Constructs a GridSet record and sets its fields appropriately.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Object
clone()
protected void
fillFields(RecordInputStream in)
called by the constructor, should set class level fields.boolean
getGridset()
get whether the gridlines are shown during printing.int
getRecordSize()
gives the current serialized size of the record.short
getSid()
return the non static version of the id for this record.int
serialize(int offset, byte[] data)
called by the class that is responsible for writing this sucker.void
setGridset(boolean gridset)
set whether gridlines are visible when printingString
toString()
get a string representation of the record (for biffview/debugging)protected void
validateSid(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 Detail
-
sid
public static final short sid
- See Also:
- Constant Field Values
-
field_1_gridset_flag
public short field_1_gridset_flag
-
-
Constructor Detail
-
GridsetRecord
public GridsetRecord()
-
GridsetRecord
public GridsetRecord(RecordInputStream in)
Constructs a GridSet record and sets its fields appropriately.- Parameters:
in
- the RecordInputstream to read the record from
-
-
Method Detail
-
validateSid
protected void validateSid(short id)
Description copied from class:Record
called by constructor, should throw runtime exception in the event of a record passed with a differing ID.- Specified by:
validateSid
in classRecord
- Parameters:
id
- alleged id for this record
-
fillFields
protected void fillFields(RecordInputStream in)
Description copied from class:Record
called by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.- Specified by:
fillFields
in classRecord
- Parameters:
in
- the RecordInputstream to read the record from
-
setGridset
public void setGridset(boolean gridset)
set whether gridlines are visible when printing- Parameters:
gridset
- - true if no gridlines are print, false if gridlines are not print.
-
getGridset
public boolean getGridset()
get whether the gridlines are shown during printing.- Returns:
- gridset - true if gridlines are NOT printed, false if they are.
-
toString
public String toString()
Description copied from class:Record
get a string representation of the record (for biffview/debugging)
-
serialize
public int serialize(int offset, byte[] data)
Description copied from class:Record
called 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:Record
gives the current serialized size of the record. Should include the sid and reclength (4 bytes).- Overrides:
getRecordSize
in classRecord
-
getSid
public short getSid()
Description copied from class:Record
return the non static version of the id for this record.
-
-