|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.ExternSheetSubRecord
Title: A sub Record for Extern Sheet
Description: Defines a named range within a workbook.
REFERENCE:
Field Summary | |
static short |
sid
|
Constructor Summary | |
ExternSheetSubRecord()
a Constractor for making new sub record |
|
ExternSheetSubRecord(short id,
short size,
byte[] data)
Constructs a Extern Sheet Sub Record record and sets its fields appropriately. |
|
ExternSheetSubRecord(short id,
short size,
byte[] data,
int offset)
Constructs a Extern Sheet Sub Record record and sets its fields appropriately. |
Method Summary | |
protected void |
fillFields(byte[] data,
short size,
int offset)
called by the constructor, should set class level fields. |
short |
getIndexToFirstSupBook()
gets the index to first sheet from supbook |
short |
getIndexToLastSupBook()
gets the index to last sheet in supbook |
short |
getIndexToSupBook()
gets the index to sup book |
int |
getRecordSize()
returns the record size |
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 |
setIndexToFirstSupBook(short index)
sets the index to first sheet in supbook |
void |
setIndexToLastSupBook(short index)
sets the index to last sheet in supbook |
void |
setIndexToSupBook(short index)
Sets the Index to the sup book |
java.lang.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 org.apache.poi.hssf.record.Record |
clone, fillFields, isInValueSection, isValue, processContinueRecord, serialize |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final short sid
Constructor Detail |
public ExternSheetSubRecord()
public ExternSheetSubRecord(short id, short size, byte[] data)
id
- id must be 0x18 or an exception will be throw upon validationsize
- the size of the data area of the recorddata
- data of the record (should not contain sid/len)public ExternSheetSubRecord(short id, short size, byte[] data, int offset)
id
- id must be 0x18 or an exception will be throw upon validationsize
- the size of the data area of the recorddata
- data of the record (should not contain sid/len)offset
- of the record's dataMethod Detail |
public void setIndexToSupBook(short index)
index
- sup book indexpublic short getIndexToSupBook()
public void setIndexToFirstSupBook(short index)
index
- index to first sheetpublic short getIndexToFirstSupBook()
public void setIndexToLastSupBook(short index)
index
- index to last sheetpublic short getIndexToLastSupBook()
protected void validateSid(short id)
validateSid
in class Record
id
- alleged id for this recordprotected void fillFields(byte[] data, short size, int offset)
fillFields
in class Record
data
- raw datasize
- size of dataoffset
- of the record's data (provided a big array of the file)public java.lang.String toString()
Record
toString
in class Record
public int serialize(int offset, byte[] data)
serialize
in class Record
offset
- to begin writing atdata
- byte array containing instance data
public int getRecordSize()
getRecordSize
in class Record
public short getSid()
getSid
in class Record
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |