|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.poi.hssf.record.Record | +--org.apache.poi.hssf.record.AreaFormatRecord
The area format record is used to define the colours and patterns for an area. NOTE: This source is automatically generated please do not modify this file. Either subclass or remove the record in src/records/definitions.
Field Summary | |
static short |
sid
|
Constructor Summary | |
AreaFormatRecord()
|
|
AreaFormatRecord(short id,
short size,
byte[] data)
Constructs a AreaFormat record and sets its fields appropriately. |
|
AreaFormatRecord(short id,
short size,
byte[] data,
int offset)
Constructs a AreaFormat 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. |
short |
getBackcolorIndex()
Get the backcolor index field for the AreaFormat record. |
int |
getBackgroundColor()
Get the background color field for the AreaFormat record. |
short |
getForecolorIndex()
Get the forecolor index field for the AreaFormat record. |
int |
getForegroundColor()
Get the foreground color field for the AreaFormat record. |
short |
getFormatFlags()
Get the format flags field for the AreaFormat record. |
short |
getPattern()
Get the pattern field for the AreaFormat record. |
int |
getRecordSize()
Size of record (exluding 4 byte header) |
short |
getSid()
return the non static version of the id for this record. |
boolean |
isAutomatic()
automatic formatting |
boolean |
isInvert()
swap foreground and background colours when data is negative |
int |
serialize(int offset,
byte[] data)
called by the class that is responsible for writing this sucker. |
void |
setAutomatic(boolean value)
Sets the automatic field value. |
void |
setBackcolorIndex(short field_6_backcolorIndex)
Set the backcolor index field for the AreaFormat record. |
void |
setBackgroundColor(int field_2_backgroundColor)
Set the background color field for the AreaFormat record. |
void |
setForecolorIndex(short field_5_forecolorIndex)
Set the forecolor index field for the AreaFormat record. |
void |
setForegroundColor(int field_1_foregroundColor)
Set the foreground color field for the AreaFormat record. |
void |
setFormatFlags(short field_4_formatFlags)
Set the format flags field for the AreaFormat record. |
void |
setInvert(boolean value)
Sets the invert field value. |
void |
setPattern(short field_3_pattern)
Set the pattern field for the AreaFormat record. |
java.lang.String |
toString()
get a string representation of the record (for biffview/debugging) |
protected void |
validateSid(short id)
Checks the sid matches the expected side for this record |
Methods inherited from class org.apache.poi.hssf.record.Record |
fillFields, isInValueSection, isValue, processContinueRecord, serialize |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final short sid
Constructor Detail |
public AreaFormatRecord()
public AreaFormatRecord(short id, short size, byte[] data)
id
- id must be 0x100a or an exception
will be throw upon validationsize
- size the size of the data area of the recorddata
- data of the record (should not contain sid/len)public AreaFormatRecord(short id, short size, byte[] data, int offset)
id
- id must be 0x100a or an exception
will be throw upon validationsize
- size the size of the data area of the recorddata
- data of the record (should not contain sid/len)offset
- of the record's dataMethod Detail |
protected void validateSid(short id)
validateSid
in class Record
id
- the expected sid.protected void fillFields(byte[] data, short size, int offset)
Record
fillFields
in class Record
org.apache.poi.hssf.record.Record
data
- raw datasize
- size of dataoffset
- of the record's data (provided a big array of the file)public java.lang.String toString()
Record
toString
in class Record
public int serialize(int offset, byte[] data)
Record
serialize
in class Record
org.apache.poi.hssf.record.Record
offset
- to begin writing atdata
- byte array containing instance datapublic int getRecordSize()
getRecordSize
in class Record
public short getSid()
Record
getSid
in class Record
public int getForegroundColor()
public void setForegroundColor(int field_1_foregroundColor)
public int getBackgroundColor()
public void setBackgroundColor(int field_2_backgroundColor)
public short getPattern()
public void setPattern(short field_3_pattern)
public short getFormatFlags()
public void setFormatFlags(short field_4_formatFlags)
public short getForecolorIndex()
public void setForecolorIndex(short field_5_forecolorIndex)
public short getBackcolorIndex()
public void setBackcolorIndex(short field_6_backcolorIndex)
public void setAutomatic(boolean value)
public boolean isAutomatic()
public void setInvert(boolean value)
public boolean isInvert()
|
jakarta-poi 1.6.0-dev | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |