public class XSSFColor extends ExtendedColor
| Constructor and Description |
|---|
XSSFColor()
Create an new instance of XSSFColor
|
XSSFColor(byte[] rgb) |
XSSFColor(java.awt.Color clr) |
XSSFColor(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color)
Create an instance of XSSFColor from the supplied XML bean
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(java.lang.Object o) |
byte[] |
getARGB()
Standard Alpha Red Green Blue ctColor value (ARGB).
|
org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor |
getCTColor()
Returns the underlying XML bean
|
short |
getIndex()
Indexed ctColor value.
|
short |
getIndexed()
Indexed ctColor value.
|
byte[] |
getRGB()
Standard Red Green Blue ctColor value (RGB).
|
protected byte[] |
getStoredRBG()
RGB or ARGB or null
|
int |
getTheme()
Index into the
|
double |
getTint()
Specifies the tint value applied to the ctColor.
|
int |
hashCode() |
boolean |
hasTint()
A boolean value indicating if the ctColor has a tint or not
|
boolean |
isAuto()
A boolean value indicating the ctColor is automatic and system ctColor dependent.
|
boolean |
isIndexed()
A boolean value indicating the ctColor is Indexed
|
boolean |
isRGB()
A boolean value indicating the ctColor is RGB or ARGB based
|
boolean |
isThemed()
A boolean value indicating the ctColor is Theme based
|
void |
setAuto(boolean auto)
A boolean value indicating the ctColor is automatic and system ctColor dependent.
|
void |
setIndexed(int indexed)
Indexed ctColor value.
|
void |
setRGB(byte[] rgb)
Standard Alpha Red Green Blue ctColor value (ARGB).
|
void |
setTheme(int theme)
Index into the
|
void |
setTint(double tint)
Specifies the tint value applied to the ctColor.
|
static XSSFColor |
toXSSFColor(Color color) |
getARGBHex, getRGBOrARGB, getRGBWithTint, setARGBHex, setColorpublic XSSFColor(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor color)
public XSSFColor()
public XSSFColor(java.awt.Color clr)
public XSSFColor(byte[] rgb)
public boolean isAuto()
isAuto in class ExtendedColorpublic void setAuto(boolean auto)
public boolean isIndexed()
isIndexed in class ExtendedColorpublic boolean isRGB()
isRGB in class ExtendedColorpublic boolean isThemed()
isThemed in class ExtendedColorpublic boolean hasTint()
public short getIndex()
getIndex in class ExtendedColorpublic short getIndexed()
public void setIndexed(int indexed)
public byte[] getRGB()
getRGB in class ExtendedColorpublic byte[] getARGB()
getARGB in class ExtendedColorprotected byte[] getStoredRBG()
ExtendedColorgetStoredRBG in class ExtendedColorpublic void setRGB(byte[] rgb)
setRGB in class ExtendedColorpublic int getTheme()
getTheme in class ExtendedColorpublic void setTheme(int theme)
public double getTint()
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 ExtendedColorpublic void setTint(double tint)
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 ExtendedColortint - the tint value@Internal public org.openxmlformats.schemas.spreadsheetml.x2006.main.CTColor getCTColor()
public int hashCode()
hashCode in class java.lang.Objectpublic boolean equals(java.lang.Object o)
equals in class java.lang.ObjectCopyright 2017 The Apache Software Foundation or its licensors, as applicable.