|
||||||||||
| 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.FormatRecord
public class 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(RecordInputStream in)
|
|
| Method Summary | |
|---|---|
java.lang.String |
getFormatString()
get the format string |
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. |
boolean |
getUnicodeFlag()
get whether the string is unicode |
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) |
void |
setUnicodeFlag(boolean unicode)
set whether the string is unicode |
java.lang.String |
toString()
get a string representation of the record (for biffview/debugging) |
| Methods inherited from class org.apache.poi.hssf.record.Record |
|---|
clone, cloneViaReserialise, 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 FormatRecord()
public FormatRecord(RecordInputStream in)
| Method Detail |
|---|
public void setIndexCode(short index)
index - the format index codeWorkbookpublic void setFormatStringLength(byte len)
len - the length of the format stringsetFormatString(String)public void setUnicodeFlag(boolean unicode)
unicode - flag for whether string is unicodepublic void setFormatString(java.lang.String fs)
fs - the format stringsetFormatStringLength(byte)public short getIndexCode()
Workbookpublic boolean getUnicodeFlag()
public java.lang.String getFormatString()
public java.lang.String toString()
Record
toString in class Record
public int serialize(int offset,
byte[] data)
RecordBase
serialize in class RecordBaseoffset - to begin writing atdata - byte array containing instance data
public int getRecordSize()
Record
getRecordSize in class Recordpublic short getSid()
Record
getSid in class Record
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||