|
||||||||||
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
Description: Somewhat of a misnomer, its used for the beginning of a set of records that have a particular pupose or subject. Used in sheets and workbooks.
REFERENCE: PG 289 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
Field Summary | |
---|---|
static short |
BUILD
suggested default 0x10d3 |
static short |
BUILD_YEAR
suggested default 0x07CC (1996) |
static short |
HISTORY_MASK
suggested default for a normal sheet (0x41) |
static short |
sid
for BIFF8 files the BOF is 0x809. |
static short |
TYPE_CHART
|
static short |
TYPE_EXCEL_4_MACRO
|
static short |
TYPE_VB_MODULE
|
static short |
TYPE_WORKBOOK
|
static short |
TYPE_WORKSHEET
|
static short |
TYPE_WORKSPACE_FILE
|
static short |
VERSION
suggested default (0x06 - BIFF8) |
Constructor Summary | |
---|---|
BOFRecord()
Constructs an empty BOFRecord with no fields set. |
|
BOFRecord(RecordInputStream in)
|
Method Summary | |
---|---|
java.lang.Object |
clone()
|
short |
getBuild()
get the build that wrote this file |
short |
getBuildYear()
Year of the build that wrote this file |
protected int |
getDataSize()
|
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. |
short |
getType()
type of object this marks |
short |
getVersion()
Version number - for BIFF8 should be 0x06 |
void |
serialize(LittleEndianOutput out)
Write the data content of this BIFF record. |
void |
setBuild(short build)
build that wrote this file |
void |
setBuildYear(short 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(short type)
type of object this marks |
void |
setVersion(short 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 |
---|
serialize |
Methods inherited from class org.apache.poi.hssf.record.Record |
---|
cloneViaReserialise, getRecordSize, serialize |
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final short sid
public static final short VERSION
public static final short BUILD
public static final short BUILD_YEAR
public static final short HISTORY_MASK
public static final short TYPE_WORKBOOK
public static final short TYPE_VB_MODULE
public static final short TYPE_WORKSHEET
public static final short TYPE_CHART
public static final short TYPE_EXCEL_4_MACRO
public static final short TYPE_WORKSPACE_FILE
Constructor Detail |
---|
public BOFRecord()
public BOFRecord(RecordInputStream in)
Method Detail |
---|
public void setVersion(short version)
version
- version to be setVERSION
public void setType(short type)
type
- type to be setTYPE_WORKBOOK
,
TYPE_VB_MODULE
,
TYPE_WORKSHEET
,
TYPE_CHART
,
TYPE_EXCEL_4_MACRO
,
TYPE_WORKSPACE_FILE
public void setBuild(short build)
build
- build number to setBUILD
public void setBuildYear(short 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 short getVersion()
VERSION
public short getType()
TYPE_WORKBOOK
,
TYPE_VB_MODULE
,
TYPE_WORKSHEET
,
TYPE_CHART
,
TYPE_EXCEL_4_MACRO
,
TYPE_WORKSPACE_FILE
public short getBuild()
BUILD
public short 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
Record.getDataSize()
serialize
in class StandardRecord
protected int getDataSize()
getDataSize
in class Record
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 |