Modifier and Type	Class and Description
private static class	HSSFPalette.CustomColor

Modifier and Type	Field and Description
private PaletteRecord	_palette

Access	Constructor and Description
protected	HSSFPalette(PaletteRecord palette)

Method Summary

Modifier and Type	Method and Description
public HSSFColor	Returns: The new custom color. addColor(byte The red component red, byte The green component green, byte The blue component blue) Adds a new color into an empty color slot.
public HSSFColor	Returns: the color, or null if the color does not exist in this palette findColor(byte the RGB red component, between 0 and 255 inclusive red, byte the RGB green component, between 0 and 255 inclusive green, byte the RGB blue component, between 0 and 255 inclusive blue) Finds the first occurrence of a given color
public HSSFColor	Returns: The closest color or null if there are no custom colors currently defined. findSimilarColor(byte The red component of the color to match. red, byte The green component of the color to match. green, byte The blue component of the color to match. blue) Finds the closest matching color in the custom palette.
public HSSFColor	Returns: The closest color or null if there are no custom colors currently defined. findSimilarColor(int The red component of the color to match. red, int The green component of the color to match. green, int The blue component of the color to match. blue) Finds the closest matching color in the custom palette.
public HSSFColor	Returns: the color, or null if the index is not populated getColor(short the palette index, between 0x8 to 0x40 inclusive index) Retrieves the color at a given index
public HSSFColor	Returns: the color, or null if the index is not populated getColor(int the palette index, between 0x8 to 0x40 inclusive index) Retrieves the color at a given index
public void	setColorAtIndex(short the palette index, between 0x8 to 0x40 inclusive index, byte the RGB red component, between 0 and 255 inclusive red, byte the RGB green component, between 0 and 255 inclusive green, byte the RGB blue component, between 0 and 255 inclusive blue) Sets the color at the given offset
private int	unsignedInt(byte b) Turn a byte of between -127 and 127 into something between 0 and 255, so distance calculations work as expected.

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

Field Detail

_palette	back to summary
private PaletteRecord _palette

Constructor Detail

HSSFPalette	back to summary
protected HSSFPalette(PaletteRecord palette)

Method Detail

addColor	back to summary
public HSSFColor addColor(byte red, byte green, byte blue) Adds a new color into an empty color slot. Parameters red:byte The red component green:byte The green component blue:byte The blue component Returns:HSSFColor The new custom color. Exceptions IllegalStateException: if there are more more free color indexes.

addColor

back to summary

public HSSFColor addColor(byte red, byte green, byte blue)

Adds a new color into an empty color slot.

Parameters

red:byte: The red component
green:byte: The green component
blue:byte: The blue component

Returns:HSSFColor

The new custom color.

Exceptions

IllegalStateException:: if there are more more free color indexes.

findColor	back to summary
public HSSFColor findColor(byte red, byte green, byte blue) Finds the first occurrence of a given color Parameters red:byte the RGB red component, between 0 and 255 inclusive green:byte the RGB green component, between 0 and 255 inclusive blue:byte the RGB blue component, between 0 and 255 inclusive Returns:HSSFColor the color, or null if the color does not exist in this palette

findColor

back to summary

public HSSFColor findColor(byte red, byte green, byte blue)

Finds the first occurrence of a given color

Parameters

red:byte: the RGB red component, between 0 and 255 inclusive
green:byte: the RGB green component, between 0 and 255 inclusive
blue:byte: the RGB blue component, between 0 and 255 inclusive

Returns:HSSFColor

the color, or null if the color does not exist in this palette

findSimilarColor	back to summary
public HSSFColor findSimilarColor(byte red, byte green, byte blue) Finds the closest matching color in the custom palette. The method for finding the distance between the colors is fairly primative. Parameters red:byte The red component of the color to match. green:byte The green component of the color to match. blue:byte The blue component of the color to match. Returns:HSSFColor The closest color or null if there are no custom colors currently defined.

findSimilarColor

back to summary

public HSSFColor findSimilarColor(byte red, byte green, byte blue)

Finds the closest matching color in the custom palette. The method for finding the distance between the colors is fairly primative.

Parameters

red:byte: The red component of the color to match.
green:byte: The green component of the color to match.
blue:byte: The blue component of the color to match.

Returns:HSSFColor

The closest color or null if there are no custom colors currently defined.

findSimilarColor	back to summary
public HSSFColor findSimilarColor(int red, int green, int blue) Finds the closest matching color in the custom palette. The method for finding the distance between the colors is fairly primative. Parameters red:int The red component of the color to match. green:int The green component of the color to match. blue:int The blue component of the color to match. Returns:HSSFColor The closest color or null if there are no custom colors currently defined.

findSimilarColor

back to summary

public HSSFColor findSimilarColor(int red, int green, int blue)

Finds the closest matching color in the custom palette. The method for finding the distance between the colors is fairly primative.

Parameters

red:int: The red component of the color to match.
green:int: The green component of the color to match.
blue:int: The blue component of the color to match.

Returns:HSSFColor

The closest color or null if there are no custom colors currently defined.

getColor	back to summary
public HSSFColor getColor(short index) Retrieves the color at a given index Parameters index:short the palette index, between 0x8 to 0x40 inclusive Returns:HSSFColor the color, or null if the index is not populated

getColor

back to summary

public HSSFColor getColor(short index)

Retrieves the color at a given index

Parameters

index:short: the palette index, between 0x8 to 0x40 inclusive

Returns:HSSFColor

the color, or null if the index is not populated

getColor	back to summary
public HSSFColor getColor(int index) Retrieves the color at a given index Parameters index:int the palette index, between 0x8 to 0x40 inclusive Returns:HSSFColor the color, or null if the index is not populated

getColor

back to summary

public HSSFColor getColor(int index)

Retrieves the color at a given index

Parameters

index:int: the palette index, between 0x8 to 0x40 inclusive

Returns:HSSFColor

the color, or null if the index is not populated

setColorAtIndex	back to summary
public void setColorAtIndex(short index, byte red, byte green, byte blue) Sets the color at the given offset Parameters index:short the palette index, between 0x8 to 0x40 inclusive red:byte the RGB red component, between 0 and 255 inclusive green:byte the RGB green component, between 0 and 255 inclusive blue:byte the RGB blue component, between 0 and 255 inclusive

setColorAtIndex

back to summary

public void setColorAtIndex(short index, byte red, byte green, byte blue)

Sets the color at the given offset

Parameters

index:short: the palette index, between 0x8 to 0x40 inclusive
red:byte: the RGB red component, between 0 and 255 inclusive
green:byte: the RGB green component, between 0 and 255 inclusive
blue:byte: the RGB blue component, between 0 and 255 inclusive

unsignedInt	back to summary
private int unsignedInt(byte b) Turn a byte of between -127 and 127 into something between 0 and 255, so distance calculations work as expected.

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

private final Class HSSFPalette.CustomColor

Class Inheritance

extends HSSFColor

java.lang.Object
org.apache.poi.hssf.util.HSSFColor
org.apache.poi.hssf.usermodel.HSSFPalette.CustomColor

Field Summary

Modifier and Type	Field and Description
private byte	_blue
private short	_byteOffset
private byte	_green
private byte	_red

Constructor Summary

Access	Constructor and Description
public	CustomColor(short byteOffset, byte[] colors)
private	CustomColor(short byteOffset, byte red, byte green, byte blue)

Method Summary

Modifier and Type	Method and Description
private String	getGnumericPart(byte color)
public String	getHexString() Overrides org.apache.poi.hssf.util.HSSFColor.getHexString. returns colon-delimited hex string "0:0:0"
public short	getIndex() Overrides org.apache.poi.hssf.util.HSSFColor.getIndex. returns color standard palette index
public short[]	getTriplet() Overrides org.apache.poi.hssf.util.HSSFColor.getTriplet. returns RGB triplet (0, 0, 0)

Inherited from org.apache.poi.hssf.util.HSSFColor:: equals getIndex2 getIndexHash getMutableIndexHash getTripletHash hashCode toHSSFColor

Field Detail

_blue	back to summary
private byte _blue

_byteOffset	back to summary
private short _byteOffset

_green	back to summary
private byte _green

_red	back to summary
private byte _red

Constructor Detail

CustomColor	back to summary
public CustomColor(short byteOffset, byte[] colors)

CustomColor	back to summary
private CustomColor(short byteOffset, byte red, byte green, byte blue)

Method Detail

getGnumericPart	back to summary
private String getGnumericPart(byte color)

getHexString	back to summary
public String getHexString() Overrides org.apache.poi.hssf.util.HSSFColor.getHexString. Doc from org.apache.poi.hssf.util.HSSFColor.getHexString. returns colon-delimited hex string "0:0:0" Returns:String a hex string exactly like a gnumeric triplet Annotations @Override

getHexString

back to summary

public String getHexString()

Overrides org.apache.poi.hssf.util.HSSFColor.getHexString.

Doc from org.apache.poi.hssf.util.HSSFColor.getHexString.

returns colon-delimited hex string "0:0:0"

Returns:String

a hex string exactly like a gnumeric triplet

Annotations

@Override

getIndex	back to summary
public short getIndex() Overrides org.apache.poi.hssf.util.HSSFColor.getIndex. Doc from org.apache.poi.hssf.util.HSSFColor.getIndex. returns color standard palette index Returns:short index to the standard palette Annotations @Override

getIndex

back to summary

public short getIndex()

Overrides org.apache.poi.hssf.util.HSSFColor.getIndex.

Doc from org.apache.poi.hssf.util.HSSFColor.getIndex.

returns color standard palette index

Returns:short

index to the standard palette

Annotations

@Override

getTriplet	back to summary
public short[] getTriplet() Overrides org.apache.poi.hssf.util.HSSFColor.getTriplet. Doc from org.apache.poi.hssf.util.HSSFColor.getTriplet. returns RGB triplet (0, 0, 0) Returns:short[] triplet representation like that in Excel Annotations @Override

getTriplet

back to summary

public short[] getTriplet()

Overrides org.apache.poi.hssf.util.HSSFColor.getTriplet.

Doc from org.apache.poi.hssf.util.HSSFColor.getTriplet.

returns RGB triplet (0, 0, 0)

Returns:short[]

triplet representation like that in Excel

Annotations

@Override

public final Class HSSFPalette

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class HSSFPalette.CustomColor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail