|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
java.lang.Objectorg.apache.poi.hssf.record.Record
org.apache.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)
| Field Summary | |
static short |
sid
|
static short |
STYLE_BUILT_IN
|
static short |
STYLE_USER_DEFINED
|
| Constructor Summary | |
StyleRecord()
|
|
StyleRecord(short id,
short size,
byte[] data)
Constructs a Style record and sets its fields appropriately. |
|
StyleRecord(short id,
short size,
byte[] data,
int offset)
Constructs a Style 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. |
byte |
getBuiltin()
if this is a builtin style get the number of the built in style |
short |
getIndex()
get the entire index field (including the type) (see bit getters that reference this method) |
java.lang.String |
getName()
get the style's name |
short |
getNameLength()
if this is a user defined record get the length of the style name |
byte |
getOutlineStyleLevel()
get the row or column level of the style (if builtin 1||2) |
int |
getRecordSize()
gives the current serialized size of the record. |
short |
getSid()
return the non static version of the id for this record. |
short |
getType()
get the type of the style (builtin or user-defined) |
short |
getXFIndex()
get the actual index of the style extended format record |
int |
serialize(int offset,
byte[] data)
called by the class that is responsible for writing this sucker. |
void |
setBuiltin(byte builtin)
if this is a builtin style set teh number of the built in style |
void |
setIndex(short index)
set the entire index field (including the type) (see bit setters that reference this method) |
void |
setName(java.lang.String name)
set the style's name |
void |
setNameLength(byte length)
if this is a user defined record set the length of the style name |
void |
setOutlineStyleLevel(byte level)
set the row or column level of the style (if builtin 1||2) |
void |
setType(short type)
set the type of the style (builtin or user-defined) |
void |
setXFIndex(short index)
set the actual index of the style extended format record |
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 |
clone, fillFields, isInValueSection, isValue, processContinueRecord, serialize |
| Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
public static final short sid
public static final short STYLE_USER_DEFINED
public static final short STYLE_BUILT_IN
| Constructor Detail |
public StyleRecord()
public StyleRecord(short id,
short size,
byte[] data)
id - id must be 0x293 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 StyleRecord(short id,
short size,
byte[] data,
int offset)
id - id must be 0x293 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 - | Method Detail |
protected void validateSid(short id)
Record
validateSid in class Recordid - alleged id for this record
protected void fillFields(byte[] data,
short size,
int offset)
Record
fillFields in class Recorddata - raw datasize - size of dataoffset - of the record's data (provided a big array of the file)public void setIndex(short index)
index - bitmaskpublic void setType(short type)
type - of style (userdefined/builtin)STYLE_USER_DEFINED,
STYLE_BUILT_IN,
setIndex(short)public void setXFIndex(short index)
index - of the xf recordsetIndex(short)public void setNameLength(byte length)
length - of the style's namesetName(String)public void setName(java.lang.String name)
name - of the stylesetNameLength(byte)public void setBuiltin(byte builtin)
builtin - style number (0-7)public void setOutlineStyleLevel(byte level)
public short getIndex()
public short getType()
STYLE_USER_DEFINED,
STYLE_BUILT_IN,
getIndex()public short getXFIndex()
getIndex()public short getNameLength()
getName()public java.lang.String getName()
getNameLength()public byte getBuiltin()
public byte getOutlineStyleLevel()
public java.lang.String toString()
Record
toString in class Record
public int serialize(int offset,
byte[] data)
Record
serialize in class Recordoffset - 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 | ||||||||||