|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.poi.hssf.record.Record | +--org.apache.poi.hssf.record.FormatRecord
Title: Format Record
Description: describes a number format -- those goofy strings like $(#,###)
REFERENCE: PG 317 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
Field Summary | |
static short |
sid
|
Constructor Summary | |
FormatRecord()
|
|
FormatRecord(short id,
short size,
byte[] data)
Constructs a Format record and sets its fields appropriately. |
|
FormatRecord(short id,
short size,
byte[] data,
int offset)
Constructs a Format 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. |
java.lang.String |
getFormatString()
get the format string |
byte |
getFormatStringLength()
get the format string length |
short |
getIndexCode()
get the format index code (for built in formats) |
int |
getRecordSize()
gives the current serialized size of the record. |
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 |
setFormatString(java.lang.String fs)
set the format string |
void |
setFormatStringLength(byte len)
set the format string length |
void |
setIndexCode(short index)
set the format index code (for built in formats) |
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 |
fillFields, isInValueSection, isValue, processContinueRecord, serialize |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final short sid
Constructor Detail |
public FormatRecord()
public FormatRecord(short id, short size, byte[] data)
id
- id must be 0x41e 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 FormatRecord(short id, short size, byte[] data, int offset)
id
- id must be 0x41e 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 |
protected void validateSid(short id)
Record
validateSid
in class Record
org.apache.poi.hssf.record.Record
id
- alleged id for this recordprotected void fillFields(byte[] data, short size, int offset)
Record
fillFields
in class Record
org.apache.poi.hssf.record.Record
data
- raw datasize
- size of dataoffset
- of the record's data (provided a big array of the file)public void setIndexCode(short index)
index
- the format index codeWorkbook
public void setFormatStringLength(byte len)
len
- the length of the format stringsetFormatString(String)
public void setFormatString(java.lang.String fs)
fs
- the format stringsetFormatStringLength(byte)
public short getIndexCode()
Workbook
public byte getFormatStringLength()
getFormatString()
public java.lang.String getFormatString()
getFormatStringLength()
public java.lang.String toString()
Record
toString
in class Record
public int serialize(int offset, byte[] data)
Record
serialize
in class Record
org.apache.poi.hssf.record.Record
offset
- to begin writing atdata
- byte array containing instance datapublic int getRecordSize()
Record
getRecordSize
in class Record
public short getSid()
Record
getSid
in class Record
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |