|
|||||||||||
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.PaletteRecord
PaletteRecord - Supports custom palettes.
Field Summary | |
static short |
FIRST_COLOR_INDEX
The byte index of the first color |
static short |
sid
|
static byte |
STANDARD_PALETTE_SIZE
The standard size of an XLS palette |
Constructor Summary | |
PaletteRecord()
|
|
PaletteRecord(short id)
Constructs a custom palette with the default set of colors |
|
PaletteRecord(short id,
short size,
byte[] data)
Constructs a PaletteRecord record and sets its fields appropriately. |
|
PaletteRecord(short id,
short size,
byte[] data,
int offset)
Constructs a PaletteRecord 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[] |
getColor(short byteIndex)
Returns the color value at a given index |
static byte[] |
getDefaultData()
Returns the default palette as PaletteRecord binary data |
int |
getRecordSize()
gives the current serialized size of the record. |
short |
getSid()
return the non static version of the id for this record. |
int |
serialize(int offset,
byte[] data)
called by the class that is responsible for writing this sucker. |
void |
setColor(short byteIndex,
byte red,
byte green,
byte blue)
Sets the color value at a given index If the given index is greater than the current last color index, then black is inserted at every index required to make the palette continuous. |
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 byte STANDARD_PALETTE_SIZE
public static final short FIRST_COLOR_INDEX
Constructor Detail |
public PaletteRecord()
public PaletteRecord(short id)
public PaletteRecord(short id, short size, byte[] data)
id
- id must be 0x92 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 PaletteRecord(short id, short size, byte[] data, int offset)
id
- id must be 0x0A 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
- of the record's dataMethod Detail |
protected void validateSid(short id)
Record
validateSid
in class Record
id
- alleged id for this recordprotected void fillFields(byte[] data, short size, int offset)
Record
fillFields
in class 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
offset
- to begin writing atdata
- byte array containing instance data
public int getRecordSize()
Record
getRecordSize
in class Record
public short getSid()
Record
getSid
in class Record
public byte[] getColor(short byteIndex)
public void setColor(short byteIndex, byte red, byte green, byte blue)
public static byte[] getDefaultData()
Workbook.createPalette()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |