|
||||||||||
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.BOFRecord
public final class BOFRecord
Title: Beginning Of File (0x0809)
Description: Somewhat of a misnomer, its used for the beginning of a set of records that have a particular purpose or subject. Used in sheets and workbooks.
REFERENCE: PG 289 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
Field Summary | |
---|---|
static int |
BUILD
suggested default 0x10d3 |
static int |
BUILD_YEAR
suggested default 0x07CC (1996) |
static int |
HISTORY_MASK
suggested default for a normal sheet (0x41) |
static short |
sid
for BIFF8 files the BOF is 0x809. |
static int |
TYPE_CHART
|
static int |
TYPE_EXCEL_4_MACRO
|
static int |
TYPE_VB_MODULE
|
static int |
TYPE_WORKBOOK
|
static int |
TYPE_WORKSHEET
|
static int |
TYPE_WORKSPACE_FILE
|
static int |
VERSION
suggested default (0x0600 - BIFF8) |
Constructor Summary | |
---|---|
BOFRecord()
Constructs an empty BOFRecord with no fields set. |
|
BOFRecord(RecordInputStream in)
|
Method Summary | |
---|---|
java.lang.Object |
clone()
|
static BOFRecord |
createSheetBOF()
|
int |
getBuild()
get the build that wrote this file |
int |
getBuildYear()
Year of the build that wrote this file |
int |
getHistoryBitMask()
get the history bit mask (not very useful) |
int |
getRequiredVersion()
get the minimum version required to read this file |
short |
getSid()
return the non static version of the id for this record. |
int |
getType()
type of object this marks |
int |
getVersion()
Version number - for BIFF8 should be 0x06 |
void |
serialize(LittleEndianOutput out)
Write the data content of this BIFF record. |
void |
setBuild(int build)
build that wrote this file |
void |
setBuildYear(int year)
Year of the build that wrote this file |
void |
setHistoryBitMask(int bitmask)
set the history bit mask (not very useful) |
void |
setRequiredVersion(int version)
set the minimum version required to read this file |
void |
setType(int type)
type of object this marks |
void |
setVersion(int version)
Version number - for BIFF8 should be 0x06 |
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 |
---|
cloneViaReserialise, serialize |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final short sid
public static final int VERSION
public static final int BUILD
public static final int BUILD_YEAR
public static final int HISTORY_MASK
public static final int TYPE_WORKBOOK
public static final int TYPE_VB_MODULE
public static final int TYPE_WORKSHEET
public static final int TYPE_CHART
public static final int TYPE_EXCEL_4_MACRO
public static final int TYPE_WORKSPACE_FILE
Constructor Detail |
---|
public BOFRecord()
public BOFRecord(RecordInputStream in)
Method Detail |
---|
public static BOFRecord createSheetBOF()
public void setVersion(int version)
version
- version to be setVERSION
public void setType(int type)
type
- type to be setTYPE_WORKBOOK
,
TYPE_VB_MODULE
,
TYPE_WORKSHEET
,
TYPE_CHART
,
TYPE_EXCEL_4_MACRO
,
TYPE_WORKSPACE_FILE
public void setBuild(int build)
build
- build number to setBUILD
public void setBuildYear(int year)
year
- build year to setBUILD_YEAR
public void setHistoryBitMask(int bitmask)
bitmask
- bitmask to set for the historyHISTORY_MASK
public void setRequiredVersion(int version)
version
- version to setVERSION
public int getVersion()
VERSION
public int getType()
TYPE_WORKBOOK
,
TYPE_VB_MODULE
,
TYPE_WORKSHEET
,
TYPE_CHART
,
TYPE_EXCEL_4_MACRO
,
TYPE_WORKSPACE_FILE
public int getBuild()
BUILD
public int getBuildYear()
BUILD_YEAR
public int getHistoryBitMask()
HISTORY_MASK
public int getRequiredVersion()
VERSION
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 java.lang.Object clone()
clone
in class Record
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |