public class HSSFExtendedColor extends ExtendedColor
| Constructor and Description |
|---|
HSSFExtendedColor(ExtendedColor color) |
| Modifier and Type | Method and Description |
|---|---|
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.
|
getARGBHex, getRGBOrARGB, getRGBWithTint, setARGBHex, setColorpublic HSSFExtendedColor(ExtendedColor color)
protected ExtendedColor getExtendedColor()
public boolean isAuto()
ExtendedColorisAuto in class ExtendedColorpublic boolean isIndexed()
ExtendedColorisIndexed in class ExtendedColorpublic boolean isRGB()
ExtendedColorisRGB in class ExtendedColorpublic boolean isThemed()
ExtendedColorisThemed in class ExtendedColorpublic short getIndex()
ExtendedColorExtendedColor.isIndexed() is truegetIndex in class ExtendedColorpublic int getTheme()
ExtendedColorExtendedColor.isThemed() is truegetTheme in class ExtendedColorpublic byte[] getRGB()
ExtendedColorgetRGB in class ExtendedColorpublic byte[] getARGB()
ExtendedColorgetARGB in class ExtendedColorprotected byte[] getStoredRBG()
ExtendedColorgetStoredRBG in class ExtendedColorpublic void setRGB(byte[] rgb)
ExtendedColorsetRGB in class ExtendedColorpublic double getTint()
ExtendedColorIf 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 ExtendedColorpublic void setTint(double tint)
ExtendedColorIf 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 ExtendedColortint - the tint valueCopyright 2017 The Apache Software Foundation or its licensors, as applicable.