|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.poi.ss.usermodel.ExtendedColor
org.apache.poi.hssf.usermodel.HSSFExtendedColor
public class HSSFExtendedColor
The HSSF file format normally stores Color information in the Palette (see PaletteRecord), but for a few cases (eg Conditional Formatting, Sheet Extensions), this XSSF-style color record can be used.
Constructor Summary | |
---|---|
HSSFExtendedColor(ExtendedColor color)
|
Method Summary | |
---|---|
byte[] |
getARGB()
Standard Alpha Red Green Blue ctColor value (ARGB). |
protected ExtendedColor |
getExtendedColor()
|
short |
getIndex()
Indexed Color value, if ExtendedColor.isIndexed() is true |
byte[] |
getRGB()
Standard Red Green Blue ctColor value (RGB). |
protected byte[] |
getStoredRBG()
RGB or ARGB or null |
int |
getTheme()
Index of Theme color, if ExtendedColor.isThemed() is true |
double |
getTint()
Specifies the tint value applied to the ctColor. |
boolean |
isAuto()
A boolean value indicating the color is automatic |
boolean |
isIndexed()
A boolean value indicating the color is indexed |
boolean |
isRGB()
A boolean value indicating the color is RGB / ARGB |
boolean |
isThemed()
A boolean value indicating the color is from a Theme |
void |
setRGB(byte[] rgb)
Sets the Red Green Blue or Alpha Red Green Blue |
void |
setTint(double tint)
Specifies the tint value applied to the ctColor. |
Methods inherited from class org.apache.poi.ss.usermodel.ExtendedColor |
---|
getARGBHex, getRGBOrARGB, getRGBWithTint, setARGBHex, setColor |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public HSSFExtendedColor(ExtendedColor color)
Method Detail |
---|
protected ExtendedColor getExtendedColor()
public boolean isAuto()
ExtendedColor
isAuto
in class ExtendedColor
public boolean isIndexed()
ExtendedColor
isIndexed
in class ExtendedColor
public boolean isRGB()
ExtendedColor
isRGB
in class ExtendedColor
public boolean isThemed()
ExtendedColor
isThemed
in class ExtendedColor
public short getIndex()
ExtendedColor
ExtendedColor.isIndexed()
is true
getIndex
in class ExtendedColor
public int getTheme()
ExtendedColor
ExtendedColor.isThemed()
is true
getTheme
in class ExtendedColor
public byte[] getRGB()
ExtendedColor
getRGB
in class ExtendedColor
public byte[] getARGB()
ExtendedColor
getARGB
in class ExtendedColor
protected byte[] getStoredRBG()
ExtendedColor
getStoredRBG
in class ExtendedColor
public void setRGB(byte[] rgb)
ExtendedColor
setRGB
in class ExtendedColor
public double getTint()
ExtendedColor
If tint is supplied, then it is applied to the RGB value of the ctColor to determine the final ctColor applied.
The tint value is stored as a double from -1.0 .. 1.0, where -1.0 means 100% darken and 1.0 means 100% lighten. Also, 0.0 means no change.
In loading the RGB value, it is converted to HLS where HLS values are (0..HLSMAX), where HLSMAX is currently 255.
Here are some examples of how to apply tint to ctColor:If (tint < 0) Lum' = Lum * (1.0 + tint) For example: Lum = 200; tint = -0.5; Darken 50% Lum' = 200 * (0.5) => 100 For example: Lum = 200; tint = -1.0; Darken 100% (make black) Lum' = 200 * (1.0-1.0) => 0 If (tint > 0) Lum' = Lum * (1.0-tint) + (HLSMAX - HLSMAX * (1.0-tint)) For example: Lum = 100; tint = 0.75; Lighten 75% Lum' = 100 * (1-.75) + (HLSMAX - HLSMAX*(1-.75)) = 100 * .25 + (255 - 255 * .25) = 25 + (255 - 63) = 25 + 192 = 217 For example: Lum = 100; tint = 1.0; Lighten 100% (make white) Lum' = 100 * (1-1) + (HLSMAX - HLSMAX*(1-1)) = 100 * 0 + (255 - 255 * 0) = 0 + (255 - 0) = 255
getTint
in class ExtendedColor
public void setTint(double tint)
ExtendedColor
If tint is supplied, then it is applied to the RGB value of the ctColor to determine the final ctColor applied.
The tint value is stored as a double from -1.0 .. 1.0, where -1.0 means 100% darken and 1.0 means 100% lighten. Also, 0.0 means no change.
In loading the RGB value, it is converted to HLS where HLS values are (0..HLSMAX), where HLSMAX is currently 255.
Here are some examples of how to apply tint to ctColor:If (tint < 0) Lum' = Lum * (1.0 + tint) For example: Lum = 200; tint = -0.5; Darken 50% Lum' = 200 * (0.5) => 100 For example: Lum = 200; tint = -1.0; Darken 100% (make black) Lum' = 200 * (1.0-1.0) => 0 If (tint > 0) Lum' = Lum * (1.0-tint) + (HLSMAX - HLSMAX * (1.0-tint)) For example: Lum = 100; tint = 0.75; Lighten 75% Lum' = 100 * (1-.75) + (HLSMAX - HLSMAX*(1-.75)) = 100 * .25 + (255 - 255 * .25) = 25 + (255 - 63) = 25 + 192 = 217 For example: Lum = 100; tint = 1.0; Lighten 100% (make white) Lum' = 100 * (1-1) + (HLSMAX - HLSMAX*(1-1)) = 100 * 0 + (255 - 255 * 0) = 0 + (255 - 0) = 255
setTint
in class ExtendedColor
tint
- the tint value
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |