Package org.apache.poi.hssf.record
Class FormatRecord
- java.lang.Object
-
- org.apache.poi.hssf.record.RecordBase
-
- org.apache.poi.hssf.record.Record
-
- org.apache.poi.hssf.record.StandardRecord
-
- org.apache.poi.hssf.record.FormatRecord
-
- All Implemented Interfaces:
java.lang.Cloneable
public final class FormatRecord extends StandardRecord implements java.lang.Cloneable
Title: Format Record (0x041E)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
Fields Modifier and Type Field Description static short
sid
-
Constructor Summary
Constructors Constructor Description FormatRecord(int indexCode, java.lang.String fs)
FormatRecord(RecordInputStream in)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FormatRecord
clone()
protected int
getDataSize()
java.lang.String
getFormatString()
get the format stringint
getIndexCode()
get the format index code (for built in formats)short
getSid()
return the non static version of the id for this record.void
serialize(LittleEndianOutput out)
Write the data content of this BIFF record.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
-
-
-
-
Field Detail
-
sid
public static final short sid
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
FormatRecord
public FormatRecord(int indexCode, java.lang.String fs)
-
FormatRecord
public FormatRecord(RecordInputStream in)
-
-
Method Detail
-
getIndexCode
public int getIndexCode()
get the format index code (for built in formats)- Returns:
- the format index code
- See Also:
InternalWorkbook
-
getFormatString
public java.lang.String getFormatString()
get the format string- Returns:
- the format string
-
toString
public java.lang.String toString()
Description copied from class:Record
get a string representation of the record (for biffview/debugging)
-
serialize
public void serialize(LittleEndianOutput out)
Description copied from class:StandardRecord
Write the data content of this BIFF record. The 'ushort sid' and 'ushort size' header fields have already been written by the superclass.The number of bytes written must equal the record size reported by
RecordBase.getRecordSize()
} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).- Specified by:
serialize
in classStandardRecord
- Parameters:
out
- the output object
-
getDataSize
protected int getDataSize()
- Specified by:
getDataSize
in classStandardRecord
-
getSid
public short getSid()
Description copied from class:Record
return the non static version of the id for this record.
-
clone
public FormatRecord clone()
-
-