Package loci.poi.hssf.record
Class StyleRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.StyleRecord
Title: Style Record
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)
- Version:
- 2.0-pre
- Author:
- Andrew C. Oliver (acoliver at apache dot org), aviks : string fixes for UserDefined Style
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final shortstatic final shortstatic final short -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a Style record and sets its fields appropriately. -
Method Summary
Modifier and TypeMethodDescriptionprotected voidcalled by the constructor, should set class level fields.byteif this is a builtin style get the number of the built in styleshortgetIndex()get the entire index field (including the type) (see bit getters that reference this method)getName()get the style's nameshortif this is a user defined record get the length of the style namebyteget the row or column level of the style (if builtin 1||2)intgives the current serialized size of the record.shortgetSid()return the non static version of the id for this record.shortgetType()get the type of the style (builtin or user-defined)shortget the actual index of the style extended format recordintserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.voidsetBuiltin(byte builtin) if this is a builtin style set teh number of the built in stylevoidsetIndex(short index) set the entire index field (including the type) (see bit setters that reference this method)voidset the style's namevoidsetNameLength(byte length) if this is a user defined record set the length of the style namevoidsetOutlineStyleLevel(byte level) set the row or column level of the style (if builtin 1||2)voidsetType(short type) set the type of the style (builtin or user-defined)voidsetXFIndex(short index) set the actual index of the style extended format recordtoString()get a string representation of the record (for biffview/debugging)protected voidvalidateSid(short id) called by constructor, should throw runtime exception in the event of a record passed with a differing ID.Methods inherited from class loci.poi.hssf.record.Record
clone, isInValueSection, isValue, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
STYLE_USER_DEFINED
public static final short STYLE_USER_DEFINED- See Also:
-
STYLE_BUILT_IN
public static final short STYLE_BUILT_IN- See Also:
-
-
Constructor Details
-
StyleRecord
public StyleRecord() -
StyleRecord
Constructs a Style record and sets its fields appropriately.- Parameters:
in- the RecordInputstream to read the record from
-
-
Method Details
-
validateSid
protected void validateSid(short id) Description copied from class:Recordcalled by constructor, should throw runtime exception in the event of a record passed with a differing ID.- Specified by:
validateSidin classRecord- Parameters:
id- alleged id for this record
-
fillFields
Description copied from class:Recordcalled by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.- Specified by:
fillFieldsin classRecord- Parameters:
in- the RecordInputstream to read the record from
-
setIndex
public void setIndex(short index) set the entire index field (including the type) (see bit setters that reference this method)- Parameters:
index- bitmask
-
setType
public void setType(short type) set the type of the style (builtin or user-defined)- Parameters:
type- of style (userdefined/builtin)- See Also:
-
setXFIndex
public void setXFIndex(short index) set the actual index of the style extended format record- Parameters:
index- of the xf record- See Also:
-
setNameLength
public void setNameLength(byte length) if this is a user defined record set the length of the style name- Parameters:
length- of the style's name- See Also:
-
setName
set the style's name- Parameters:
name- of the style- See Also:
-
setBuiltin
public void setBuiltin(byte builtin) if this is a builtin style set teh number of the built in style- Parameters:
builtin- style number (0-7)
-
setOutlineStyleLevel
public void setOutlineStyleLevel(byte level) set the row or column level of the style (if builtin 1||2) -
getIndex
public short getIndex()get the entire index field (including the type) (see bit getters that reference this method)- Returns:
- bitmask
-
getType
public short getType()get the type of the style (builtin or user-defined)- Returns:
- type of style (userdefined/builtin)
- See Also:
-
getXFIndex
public short getXFIndex()get the actual index of the style extended format record- Returns:
- index of the xf record
- See Also:
-
getNameLength
public short getNameLength()if this is a user defined record get the length of the style name- Returns:
- length of the style's name
- See Also:
-
getName
get the style's name- Returns:
- name of the style
- See Also:
-
getBuiltin
public byte getBuiltin()if this is a builtin style get the number of the built in style- Returns:
- builtin style number (0-7)
-
getOutlineStyleLevel
public byte getOutlineStyleLevel()get the row or column level of the style (if builtin 1||2) -
toString
Description copied from class:Recordget a string representation of the record (for biffview/debugging) -
serialize
public int serialize(int offset, byte[] data) Description copied from class:Recordcalled by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array. -
getRecordSize
public int getRecordSize()Description copied from class:Recordgives the current serialized size of the record. Should include the sid and reclength (4 bytes).- Overrides:
getRecordSizein classRecord
-
getSid
public short getSid()Description copied from class:Recordreturn the non static version of the id for this record.
-