Package loci.poi.hssf.record
Class TabIdRecord
- java.lang.Object
-
- loci.poi.hssf.record.Record
-
- loci.poi.hssf.record.TabIdRecord
-
public class TabIdRecord extends Record
Title: Sheet Tab Index Array RecordDescription: Contains an array of sheet id's. Sheets always keep their ID regardless of what their name is.
REFERENCE: PG 412 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 Modifier and Type Field Description short[]
field_1_tabids
static short
sid
-
Constructor Summary
Constructors Constructor Description TabIdRecord()
TabIdRecord(RecordInputStream in)
Constructs a TabID record and sets its fields appropriately.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
fillFields(RecordInputStream in)
called by the constructor, should set class level fields.int
getRecordSize()
gives the current serialized size of the record.short
getSid()
return the non static version of the id for this record.short[]
getTabIdArray()
get the tab array.int
serialize(int offset, byte[] data)
called by the class that is responsible for writing this sucker.void
setTabIdArray(short[] array)
set the tab array.String
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
clone, isInValueSection, isValue, serialize
-
-
-
-
Field Detail
-
sid
public static final short sid
- See Also:
- Constant Field Values
-
field_1_tabids
public short[] field_1_tabids
-
-
Constructor Detail
-
TabIdRecord
public TabIdRecord()
-
TabIdRecord
public TabIdRecord(RecordInputStream in)
Constructs a TabID 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
-
setTabIdArray
public void setTabIdArray(short[] array)
set the tab array. (0,1,2).- Parameters:
array
- of tab id's {0,1,2}
-
getTabIdArray
public short[] getTabIdArray()
get the tab array. (0,1,2).- Returns:
- array of tab id's {0,1,2}
-
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
-
-