Modifier and Type	Class and Description
private static class	PaletteRecord.PColor PColor - element in the list of colors

Modifier and Type	Field and Description
private final ArrayList<PaletteRecord.PColor>	_colors
private static final int[]	DEFAULT_COLORS
public static final short	FIRST_COLOR_INDEX The byte index of the first color
public static final short	sid
public static final byte	STANDARD_PALETTE_SIZE The standard size of an XLS palette

Access	Constructor and Description
public	PaletteRecord()
public	PaletteRecord(PaletteRecord other)
public	PaletteRecord(RecordInputStream in)

Method Summary

Modifier and Type	Method and Description
public PaletteRecord	copy() Implements abstract org.apache.poi.hssf.record.StandardRecord.copy. Implements org.apache.poi.common.Duplicatable.copy.
public byte[]	Returns: the RGB triplet for the color, or `null` if the specified index does not exist getColor(int palette index, must be >= 0x8 byteIndex) Returns the color value at a given index
protected int	getDataSize() Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.
public Map<String, Supplier<?>>	getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.
public HSSFRecordTypes	getGenericRecordType() Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType. Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.
public short	getSid() Implements abstract org.apache.poi.hssf.record.Record.getSid. return the non static version of the id for this record.
public void	serialize(LittleEndianOutput the output object out) Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize. Write the data content of this BIFF record.
public void	setColor(short the index to set; if this index is less than 0x8 or greater than 0x40, then no modification is made byteIndex, byte the red color part red, byte the green color part green, byte the blue color part 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.

Inherited from org.apache.poi.hssf.record.StandardRecord:: getRecordSize serialize

Field Detail

_colors	back to summary
private final ArrayList<PaletteRecord.PColor> _colors

DEFAULT_COLORS	back to summary
private static final int[] DEFAULT_COLORS

FIRST_COLOR_INDEX	back to summary
public static final short FIRST_COLOR_INDEX The byte index of the first color

sid	back to summary
public static final short sid

STANDARD_PALETTE_SIZE	back to summary
public static final byte STANDARD_PALETTE_SIZE The standard size of an XLS palette

Constructor Detail

PaletteRecord	back to summary
public PaletteRecord()

PaletteRecord	back to summary
public PaletteRecord(PaletteRecord other)

PaletteRecord	back to summary
public PaletteRecord(RecordInputStream in)

Method Detail

copy	back to summary
public PaletteRecord copy() Implements abstract org.apache.poi.hssf.record.StandardRecord.copy. Implements org.apache.poi.common.Duplicatable.copy. Returns:PaletteRecord Doc from org.apache.poi.common.Duplicatable.copy. a deep copy of the implementing class / instance Annotations @Override

copy

back to summary

public PaletteRecord copy()

Implements abstract org.apache.poi.hssf.record.StandardRecord.copy.

Implements org.apache.poi.common.Duplicatable.copy.

Returns:PaletteRecord

Doc from org.apache.poi.common.Duplicatable.copy.

a deep copy of the implementing class / instance

Annotations

@Override

getColor back to summary

getColor	back to summary
public byte[] getColor(int byteIndex) Returns the color value at a given index Parameters byteIndex:int palette index, must be >= 0x8 Returns:byte[] the RGB triplet for the color, or `null` if the specified index does not exist

public byte[] getColor(int byteIndex)

Returns the color value at a given index

Parameters

byteIndex:int: palette index, must be >= 0x8

Returns:byte[]

the RGB triplet for the color, or null if the specified index does not exist

getDataSize	back to summary
protected int getDataSize() Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize. Annotations @Override

getDataSize

back to summary

protected int getDataSize()

Implements abstract org.apache.poi.hssf.record.StandardRecord.getDataSize.

Annotations

@Override

getGenericProperties	back to summary
public Map<String, Supplier<?>> getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties. Annotations @Override

getGenericProperties

back to summary

public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations

@Override

getGenericRecordType	back to summary
public HSSFRecordTypes getGenericRecordType() Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType. Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType. Annotations @Override

getGenericRecordType

back to summary

public HSSFRecordTypes getGenericRecordType()

Overrides default org.apache.poi.common.usermodel.GenericRecord.getGenericRecordType.

Implements abstract org.apache.poi.hssf.record.Record.getGenericRecordType.

Annotations

@Override

getSid	back to summary
public short getSid() Implements abstract org.apache.poi.hssf.record.Record.getSid. Doc from org.apache.poi.hssf.record.Record.getSid. return the non static version of the id for this record. Returns:short he id for this record Annotations @Override

getSid

back to summary

public short getSid()

Implements abstract org.apache.poi.hssf.record.Record.getSid.

Doc from org.apache.poi.hssf.record.Record.getSid.

return the non static version of the id for this record.

Returns:short

he id for this record

Annotations

@Override

serialize back to summary

serialize	back to summary
public void serialize(LittleEndianOutput out) Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize. Doc from org.apache.poi.hssf.record.StandardRecord.serialize. 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 `org.apache.poi.hssf.record.Record#getRecordSize()`} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass). Parameters out:LittleEndianOutput the output object Annotations @Override

public void serialize(LittleEndianOutput out)

Implements abstract org.apache.poi.hssf.record.StandardRecord.serialize.

Doc from org.apache.poi.hssf.record.StandardRecord.serialize.

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 org.apache.poi.hssf.record.Record#getRecordSize()} minus four ( record header consisting of a 'ushort sid' and 'ushort reclength' has already been written by their superclass).

Parameters

out:LittleEndianOutput: the output object

Annotations

@Override

setColor	back to summary
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:short the index to set; if this index is less than 0x8 or greater than 0x40, then no modification is made red:byte the red color part green:byte the green color part blue:byte the blue color part

setColor

back to summary

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:short: the index to set; if this index is less than 0x8 or greater than 0x40, then no modification is made
red:byte: the red color part
green:byte: the green color part
blue:byte: the blue color part

org.apache.poi.hssf.record back to summary

private final Class PaletteRecord.PColor

Class Inheritance

extends Object
implements GenericRecord

java.lang.Object
org.apache.poi.hssf.record.PaletteRecord.PColor

All Implemented Interfaces

org.apache.poi.common.usermodel.GenericRecord

PColor - element in the list of colors

Field Summary

Modifier and Type	Field and Description
private final int	_blue
private final int	_green
private final int	_red
public static final short	ENCODED_SIZE

Constructor Summary

Access	Constructor and Description
pack-priv	PColor(int rgb)
pack-priv	PColor(int red, int green, int blue)
pack-priv	PColor(PaletteRecord.PColor other)
pack-priv	PColor(RecordInputStream in)

Method Summary

Modifier and Type	Method and Description
public Map<String, Supplier<?>>	getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.
pack-priv byte[]	getTriplet()
pack-priv void	serialize(LittleEndianOutput out)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

_blue	back to summary
private final int _blue

_green	back to summary
private final int _green

_red	back to summary
private final int _red

ENCODED_SIZE	back to summary
public static final short ENCODED_SIZE

Constructor Detail

PColor	back to summary
pack-priv PColor(int rgb)

PColor	back to summary
pack-priv PColor(int red, int green, int blue)

PColor	back to summary
pack-priv PColor(PaletteRecord.PColor other)

PColor	back to summary
pack-priv PColor(RecordInputStream in)

Method Detail

getGenericProperties	back to summary
public Map<String, Supplier<?>> getGenericProperties() Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties. Annotations @Override

getGenericProperties

back to summary

public Map<String, Supplier<?>> getGenericProperties()

Implements org.apache.poi.common.usermodel.GenericRecord.getGenericProperties.

Annotations

@Override

getTriplet	back to summary
pack-priv byte[] getTriplet()

serialize	back to summary
pack-priv void serialize(LittleEndianOutput out)

public final Class PaletteRecord

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class PaletteRecord.PColor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail