Package loci.poi.hssf.record
Class PaletteRecord
java.lang.Object
loci.poi.hssf.record.Record
loci.poi.hssf.record.PaletteRecord
PaletteRecord - Supports custom palettes.
- Version:
- 2.0-pre
- 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 shortThe byte index of the first colorstatic final shortstatic final byteThe standard size of an XLS palette -
Constructor Summary
ConstructorsConstructorDescriptionConstructs a PaletteRecord record and sets its fields appropriately. -
Method Summary
Modifier and TypeMethodDescriptionprotected voidcalled by the constructor, should set class level fields.byte[]getColor(short byteIndex) Returns the color value at a given indexintgives the current serialized size of the record.shortgetSid()return the non static version of the id for this record.intserialize(int offset, byte[] data) called by the class that is responsible for writing this sucker.voidsetColor(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)protected voidvalidateSid(short id) called by constructor, should throw runtime exception in the event of a record passed with a differing ID.Methods inherited from class loci.poi.hssf.record.Record
clone, isInValueSection, isValue, 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
Constructs a PaletteRecord record and sets its fields appropriately.- Parameters:
in- the RecordInputstream to read the record from
-
-
Method Details
-
validateSid
protected void validateSid(short id) Description copied from class:Recordcalled by constructor, should throw runtime exception in the event of a record passed with a differing ID.- Specified by:
validateSidin classRecord- Parameters:
id- alleged id for this record
-
fillFields
Description copied from class:Recordcalled by the constructor, should set class level fields. Should throw runtime exception for bad/icomplete data.- Specified by:
fillFieldsin classRecord- Parameters:
in- the RecordInputstream to read the record from
-
toString
Description copied from class:Recordget a string representation of the record (for biffview/debugging) -
serialize
public int serialize(int offset, byte[] data) Description copied from class:Recordcalled by the class that is responsible for writing this sucker. Subclasses should implement this so that their data is passed back in a byte array. -
getRecordSize
public int getRecordSize()Description copied from class:Recordgives the current serialized size of the record. Should include the sid and reclength (4 bytes).- Overrides:
getRecordSizein classRecord
-
getSid
public short getSid()Description copied from class:Recordreturn the non static version of the id for this record. -
getColor
public byte[] getColor(short byteIndex) Returns the color value at a given index- 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 made
-