|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.poi.hssf.record.RecordBase
org.apache.poi.hssf.record.Record
org.apache.poi.hssf.record.StandardRecord
org.apache.poi.hssf.record.BoundSheetRecord
public final class BoundSheetRecord
Title: Bound Sheet Record (aka BundleSheet) (0x0085)
Description: Defines a sheet within a workbook. Basically stores the sheet name and tells where the Beginning of file record is within the HSSF file.
REFERENCE: PG 291 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
Field Summary | |
---|---|
static short |
sid
|
Constructor Summary | |
---|---|
BoundSheetRecord(RecordInputStream in)
UTF8: sid + len + bof + flags + len(str) + unicode + str 2 + 2 + 4 + 2 + 1 + 1 + len(str) UNICODE: sid + len + bof + flags + len(str) + unicode + str 2 + 2 + 4 + 2 + 1 + 1 + 2 * len(str) |
|
BoundSheetRecord(java.lang.String sheetname)
|
Method Summary | |
---|---|
int |
getPositionOfBof()
get the offset in bytes of the Beginning of File Marker within the HSSF Stream part of the POIFS file |
java.lang.String |
getSheetname()
get the sheetname for this sheet. |
short |
getSid()
return the non static version of the id for this record. |
boolean |
isHidden()
Is the sheet hidden? Different from very hidden |
boolean |
isVeryHidden()
Is the sheet very hidden? Different from (normal) hidden |
static BoundSheetRecord[] |
orderByBofPosition(java.util.List boundSheetRecords)
Converts a List of BoundSheetRecord s to an array and sorts by the position of their
BOFs. |
void |
serialize(LittleEndianOutput out)
Write the data content of this BIFF record. |
void |
setHidden(boolean hidden)
Is the sheet hidden? Different from very hidden |
void |
setPositionOfBof(int pos)
set the offset in bytes of the Beginning of File Marker within the HSSF Stream part of the POIFS file |
void |
setSheetname(java.lang.String sheetName)
Set the sheetname for this sheet. |
void |
setVeryHidden(boolean veryHidden)
Is the sheet very hidden? Different from (normal) hidden |
java.lang.String |
toString()
get a string representation of the record (for biffview/debugging) |
Methods inherited from class org.apache.poi.hssf.record.StandardRecord |
---|
getRecordSize, serialize |
Methods inherited from class org.apache.poi.hssf.record.Record |
---|
clone, cloneViaReserialise, serialize |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final short sid
Constructor Detail |
---|
public BoundSheetRecord(java.lang.String sheetname)
public BoundSheetRecord(RecordInputStream in)
Method Detail |
---|
public void setPositionOfBof(int pos)
pos
- offset in bytespublic void setSheetname(java.lang.String sheetName)
sheetName
- the name of the sheet
java.lang.IllegalArgumentException
- if sheet name will cause excel to crash.for a safe way to create valid names
public int getPositionOfBof()
public java.lang.String getSheetname()
public java.lang.String toString()
Record
toString
in class Record
public void serialize(LittleEndianOutput out)
StandardRecord
RecordBase.getRecordSize()
}
public short getSid()
Record
getSid
in class Record
public boolean isHidden()
public void setHidden(boolean hidden)
public boolean isVeryHidden()
public void setVeryHidden(boolean veryHidden)
public static BoundSheetRecord[] orderByBofPosition(java.util.List boundSheetRecords)
BoundSheetRecord
s to an array and sorts by the position of their
BOFs.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |