Package org.apache.poi.hssf.record
Class PaletteRecord
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.PaletteRecord
PaletteRecord (0x0092) - Supports custom palettes.
- Author:
- Andrew C. Oliver (acoliver at apache dot org), Brian Sanders (bsanders at risklabs dot com) - custom palette editing
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final short
The byte index of the first colorstatic final short
static final byte
The standard size of an XLS palette -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbyte[]
getColor
(int byteIndex) Returns the color value at a given indexprotected int
short
getSid()
return the non static version of the id for this record.void
Write the data content of this BIFF record.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.toString()
get a string representation of the record (for biffview/debugging)Methods inherited from class org.apache.poi.hssf.record.StandardRecord
getRecordSize, serialize
Methods inherited from class org.apache.poi.hssf.record.Record
clone, cloneViaReserialise, serialize
-
Field Details
-
sid
public static final short sid- See Also:
-
STANDARD_PALETTE_SIZE
public static final byte STANDARD_PALETTE_SIZEThe standard size of an XLS palette- See Also:
-
FIRST_COLOR_INDEX
public static final short FIRST_COLOR_INDEXThe byte index of the first color- See Also:
-
-
Constructor Details
-
PaletteRecord
public PaletteRecord() -
PaletteRecord
-
-
Method Details
-
toString
Description copied from class:Record
get a string representation of the record (for biffview/debugging) -
serialize
Description copied from class:StandardRecord
Write 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:
serialize
in classStandardRecord
- Parameters:
out
- the output object
-
getDataSize
protected int getDataSize()- Specified by:
getDataSize
in classStandardRecord
-
getSid
public short getSid()Description copied from class:Record
return the non static version of the id for this record. -
getColor
public byte[] getColor(int byteIndex) Returns the color value at a given index- Parameters:
byteIndex
- palette index, must be >= 0x8- Returns:
- the RGB triplet for the color, or
null
if the specified index does not exist
-
setColor
public 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.- Parameters:
byteIndex
- the index to set; if this index is less than 0x8 or greater than 0x40, then no modification is madered
- the red color partgreen
- the green color partblue
- the blue color part
-