Apache POI - Common 5.3.0 · org.apache.poi.sl.usermodel.ColorStyle

Method Summary

Modifier and Type	Method and Description
public int	Returns: opacity in percents in the range [0..100000] or -1 if the value is not set getAlpha() the opacity as expressed by a percentage value
public Color	getColor()
public int	Returns: hue in percents in the range [0..100000] (usually ...) or -1 if the value is not set getHueMod() the hue as expressed by a percentage relative to the input color.
public int	Returns: hue shift in percents in the range [0..100000] (usually ...) or -1 if the value is not set getHueOff() the hue shift as expressed by a percentage relative to the input color.
public int	Returns: luminance in percents in the range [0..100000] (usually ...) or -1 if the value is not set getLumMod() the luminance as expressed by a percentage relative to the input color.
public int	Returns: luminance shift in percents in the range [0..100000] (usually ...) or -1 if the value is not set getLumOff() the luminance shift as expressed by a percentage relative to the input color.
public int	Returns: saturation in percents in the range [0..100000] (usually ...) or -1 if the value is not set getSatMod() the saturation as expressed by a percentage relative to the input color.
public int	Returns: saturation shift in percents in the range [0..100000] (usually ...) or -1 if the value is not set getSatOff() the saturation shift as expressed by a percentage relative to the input color.
public int	Returns: the value of the shade specified as percents in the range [0..100000] (usually ...) with 0% indicating minimal shade and 100% indicating maximum or -1 if the value is not set getShade() specifies a darker version of its input color.
public int	Returns: the value of the tint specified as percents in the range [0..100000] (usually ...) with 0% indicating minimal tint and 100% indicating maximum or -1 if the value is not set getTint() specifies a lighter version of its input color.

Method Detail

getAlpha	back to summary
public int getAlpha() the opacity as expressed by a percentage value Returns:int opacity in percents in the range [0..100000] or -1 if the value is not set

getAlpha

back to summary

public int getAlpha()

the opacity as expressed by a percentage value

Returns:int: opacity in percents in the range [0..100000] or -1 if the value is not set

getColor	back to summary
public Color getColor()

getHueMod	back to summary
public int getHueMod() the hue as expressed by a percentage relative to the input color. Be aware that OOXML also returns values greater than 100% Returns:int hue in percents in the range [0..100000] (usually ...) or -1 if the value is not set

getHueMod

back to summary

public int getHueMod()

the hue as expressed by a percentage relative to the input color. Be aware that OOXML also returns values greater than 100%

Returns:int: hue in percents in the range [0..100000] (usually ...) or -1 if the value is not set

getHueOff	back to summary
public int getHueOff() the hue shift as expressed by a percentage relative to the input color. Be aware that OOXML also returns values greater than 100% Returns:int hue shift in percents in the range [0..100000] (usually ...) or -1 if the value is not set

getHueOff

back to summary

public int getHueOff()

the hue shift as expressed by a percentage relative to the input color. Be aware that OOXML also returns values greater than 100%

Returns:int: hue shift in percents in the range [0..100000] (usually ...) or -1 if the value is not set

getLumMod	back to summary
public int getLumMod() the luminance as expressed by a percentage relative to the input color. Be aware that OOXML also returns values greater than 100%. Returns:int luminance in percents in the range [0..100000] (usually ...) or -1 if the value is not set

getLumMod

back to summary

public int getLumMod()

the luminance as expressed by a percentage relative to the input color. Be aware that OOXML also returns values greater than 100%.

Returns:int: luminance in percents in the range [0..100000] (usually ...) or -1 if the value is not set

getLumOff	back to summary
public int getLumOff() the luminance shift as expressed by a percentage relative to the input color. Be aware that OOXML also returns values greater than 100% Returns:int luminance shift in percents in the range [0..100000] (usually ...) or -1 if the value is not set

getLumOff

back to summary

public int getLumOff()

the luminance shift as expressed by a percentage relative to the input color. Be aware that OOXML also returns values greater than 100%

Returns:int: luminance shift in percents in the range [0..100000] (usually ...) or -1 if the value is not set

getSatMod	back to summary
public int getSatMod() the saturation as expressed by a percentage relative to the input color. Be aware that OOXML also returns values greater than 100% Returns:int saturation in percents in the range [0..100000] (usually ...) or -1 if the value is not set

getSatMod

back to summary

public int getSatMod()

the saturation as expressed by a percentage relative to the input color. Be aware that OOXML also returns values greater than 100%

Returns:int: saturation in percents in the range [0..100000] (usually ...) or -1 if the value is not set

getSatOff	back to summary
public int getSatOff() the saturation shift as expressed by a percentage relative to the input color. Be aware that OOXML also returns values greater than 100% Returns:int saturation shift in percents in the range [0..100000] (usually ...) or -1 if the value is not set

getSatOff

back to summary

public int getSatOff()

the saturation shift as expressed by a percentage relative to the input color. Be aware that OOXML also returns values greater than 100%

Returns:int: saturation shift in percents in the range [0..100000] (usually ...) or -1 if the value is not set

getShade	back to summary
public int getShade() specifies a darker version of its input color. A 10% shade is 10% of the input color combined with 90% black. Be aware that OOXML also returns values greater than 100%. Returns:int the value of the shade specified as percents in the range [0..100000] (usually ...) with 0% indicating minimal shade and 100% indicating maximum or -1 if the value is not set

getShade

back to summary

public int getShade()

specifies a darker version of its input color. A 10% shade is 10% of the input color combined with 90% black. Be aware that OOXML also returns values greater than 100%.

Returns:int: the value of the shade specified as percents in the range [0..100000] (usually ...) with 0% indicating minimal shade and 100% indicating maximum or -1 if the value is not set

getTint	back to summary
public int getTint() specifies a lighter version of its input color. A 10% tint is 10% of the input color combined with 90% white. Be aware that OOXML also returns values greater than 100% Returns:int the value of the tint specified as percents in the range [0..100000] (usually ...) with 0% indicating minimal tint and 100% indicating maximum or -1 if the value is not set

getTint

back to summary

public int getTint()

specifies a lighter version of its input color. A 10% tint is 10% of the input color combined with 90% white. Be aware that OOXML also returns values greater than 100%

Returns:int: the value of the tint specified as percents in the range [0..100000] (usually ...) with 0% indicating minimal tint and 100% indicating maximum or -1 if the value is not set

public Interface ColorStyle

Method Summary

Method Detail