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
-
public final class PaletteRecord extends StandardRecord
PaletteRecord (0x0092) - Supports custom palettes.
-
-
Field Summary
Fields Modifier and Type Field Description static short
FIRST_COLOR_INDEX
The byte index of the first colorstatic short
sid
static byte
STANDARD_PALETTE_SIZE
The standard size of an XLS palette
-
Constructor Summary
Constructors Constructor Description PaletteRecord()
PaletteRecord(RecordInputStream in)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description byte[]
getColor(int byteIndex)
Returns the color value at a given indexshort
getSid()
return the non static version of the id for this record.void
serialize(LittleEndianOutput out)
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.String
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 Detail
-
sid
public static final short sid
- See Also:
- Constant Field Values
-
STANDARD_PALETTE_SIZE
public static final byte STANDARD_PALETTE_SIZE
The standard size of an XLS palette- See Also:
- Constant Field Values
-
FIRST_COLOR_INDEX
public static final short FIRST_COLOR_INDEX
The byte index of the first color- See Also:
- Constant Field Values
-
-
Constructor Detail
-
PaletteRecord
public PaletteRecord()
-
PaletteRecord
public PaletteRecord(RecordInputStream in)
-
-
Method Detail
-
toString
public String toString()
Description copied from class:Record
get a string representation of the record (for biffview/debugging)
-
serialize
public void serialize(LittleEndianOutput out)
-
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
-
-