Package loci.poi.hssf.record
Class ExternSheetSubRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.ExternSheetSubRecord
Title: A sub Record for Extern Sheet
Description: Defines a named range within a workbook.
REFERENCE:
- Version:
- 1.0-pre
- Author:
- Libin Roman (Vista Portal LDT. Developer)
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptiona Constractor for making new sub recordConstructs a Extern Sheet Sub Record record and sets its fields appropriately. -
Method Summary
Modifier and TypeMethodDescriptionprotected voidcalled by the constructor, should set class level fields.shortgets the index to first sheet from supbookshortgets the index to last sheet in supbookshortgets the index to sup bookintreturns the record sizeshortgetSid()return the non static version of the id for this record.intserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.voidsetIndexToFirstSupBook(short index) sets the index to first sheet in supbookvoidsetIndexToLastSupBook(short index) sets the index to last sheet in supbookvoidsetIndexToSupBook(short index) Sets the Index to the sup booktoString()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
clone, isInValueSection, isValue, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
-
Constructor Details
-
ExternSheetSubRecord
public ExternSheetSubRecord()a Constractor for making new sub record -
ExternSheetSubRecord
Constructs a Extern Sheet Sub Record record and sets its fields appropriately.- Parameters:
in- the RecordInputstream to read the record from
-
-
Method Details
-
setIndexToSupBook
public void setIndexToSupBook(short index) Sets the Index to the sup book- Parameters:
index- sup book index
-
getIndexToSupBook
public short getIndexToSupBook()gets the index to sup book- Returns:
- sup book index
-
setIndexToFirstSupBook
public void setIndexToFirstSupBook(short index) sets the index to first sheet in supbook- Parameters:
index- index to first sheet
-
getIndexToFirstSupBook
public short getIndexToFirstSupBook()gets the index to first sheet from supbook- Returns:
- index to first supbook
-
setIndexToLastSupBook
public void setIndexToLastSupBook(short index) sets the index to last sheet in supbook- Parameters:
index- index to last sheet
-
getIndexToLastSupBook
public short getIndexToLastSupBook()gets the index to last sheet in supbook- Returns:
- index to last supbook
-
validateSid
protected void validateSid(short id) called 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
-
toString
Description copied from class:Recordget a string representation of the record (for biffview/debugging) -
serialize
public int serialize(int offset, byte[] data) 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()returns the record size- Overrides:
getRecordSizein classRecord
-
getSid
public short getSid()return the non static version of the id for this record.
-