Package org.apache.poi.hssf.record
Class StyleRecord
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.StyleRecord
Title: Style Record (0x0293)
Description: Describes a builtin to the gui or user defined style
REFERENCE: PG 390 Microsoft Excel 97 Developer's Kit (ISBN: 1-57231-498-2)
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptioncreates a new style record, initially set to 'built-in' -
Method Summary
Modifier and TypeMethodDescriptionprotected intgetName()get the style's nameshortgetSid()return the non static version of the id for this record.intget the actual index of the style extended format recordbooleanvoidWrite the data content of this BIFF record.voidsetBuiltinStyle(int builtinStyleId) if this is a builtin style set the number of the built in stylevoidset the style's namevoidsetOutlineStyleLevel(int level) set the row or column level of the style (if builtin 1||2)voidsetXFIndex(int xfIndex) set the actual index of the style extended format recordtoString()get a string representation of the record (for biffview/debugging)Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serializeMethods inherited from class org.apache.poi.hssf.record.Record
clone, cloneViaReserialise, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
-
Constructor Details
-
StyleRecord
public StyleRecord()creates a new style record, initially set to 'built-in' -
StyleRecord
-
-
Method Details
-
setXFIndex
public void setXFIndex(int xfIndex) set the actual index of the style extended format record- Parameters:
xfIndex- of the xf record
-
getXFIndex
public int getXFIndex()get the actual index of the style extended format record- Returns:
- index of the xf record
- See Also:
-
setName
set the style's name- Parameters:
name- of the style
-
setBuiltinStyle
public void setBuiltinStyle(int builtinStyleId) if this is a builtin style set the number of the built in style- Parameters:
builtinStyleId- style number (0-7)
-
setOutlineStyleLevel
public void setOutlineStyleLevel(int level) set the row or column level of the style (if builtin 1||2) -
isBuiltin
public boolean isBuiltin() -
getName
get the style's name- Returns:
- name of the style
-
toString
Description copied from class:Recordget a string representation of the record (for biffview/debugging) -
getDataSize
protected int getDataSize()- Specified by:
getDataSizein classStandardRecord
-
serialize
Description copied from class:StandardRecordWrite 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:
serializein classStandardRecord- Parameters:
out- the output object
-
getSid
public short getSid()Description copied from class:Recordreturn the non static version of the id for this record.
-