|
xmlgraphics-commons 1.5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.awt.Color
org.apache.xmlgraphics.java2d.color.ColorWithAlternatives
public class ColorWithAlternatives
Extended Color
class allowing to specify a prioritized list of alternative colors.
The alternative colors shall be the ones that are preferred if an output format supports them.
This is normally used for passing device-specific colors through to the output format.
This class only adds a single reference to a color array which should not increase memory consumption by much if no alternative colors are specified.
Important: Due to a flaw in Color.equals(Object)
, the equals()
method should not be used to compare two colors, especially when used to update the current
color for some output format. Color
only takes the sRGB values into account but not
more the advanced facets of this class. Use ColorUtil.isSameColor(Color, Color)
for
such a check.
Field Summary |
---|
Fields inherited from class java.awt.Color |
---|
black, BLACK, blue, BLUE, cyan, CYAN, DARK_GRAY, darkGray, gray, GRAY, green, GREEN, LIGHT_GRAY, lightGray, magenta, MAGENTA, orange, ORANGE, pink, PINK, red, RED, white, WHITE, yellow, YELLOW |
Fields inherited from interface java.awt.Transparency |
---|
BITMASK, OPAQUE, TRANSLUCENT |
Constructor Summary | |
---|---|
ColorWithAlternatives(ColorSpace cspace,
float[] components,
float alpha,
Color[] alternativeColors)
Constructor for colors with an arbitrary color space. |
|
ColorWithAlternatives(float r,
float g,
float b,
Color[] alternativeColors)
Constructor for RGB colors. |
|
ColorWithAlternatives(float r,
float g,
float b,
float a,
Color[] alternativeColors)
Constructor for RGBA colors. |
|
ColorWithAlternatives(int rgba,
boolean hasalpha,
Color[] alternativeColors)
Constructor for RGBA colors. |
|
ColorWithAlternatives(int rgb,
Color[] alternativeColors)
Constructor for RGB colors. |
|
ColorWithAlternatives(int r,
int g,
int b,
Color[] alternativeColors)
Constructor for RGB colors. |
|
ColorWithAlternatives(int r,
int g,
int b,
int a,
Color[] alternativeColors)
Constructor for RGBA colors. |
Method Summary | |
---|---|
Color[] |
getAlternativeColors()
Returns the list of alternative colors. |
Color |
getFirstAlternativeOfType(int colorSpaceType)
Returns the first alternative color found with the given color space type. |
boolean |
hasAlternativeColors()
Indicates whether alternative colors are available. |
boolean |
hasSameAlternativeColors(ColorWithAlternatives col)
Indicates whether another instance has the same alternative colors. |
Methods inherited from class java.awt.Color |
---|
brighter, createContext, darker, decode, equals, getAlpha, getBlue, getColor, getColor, getColor, getColorComponents, getColorComponents, getColorSpace, getComponents, getComponents, getGreen, getHSBColor, getRed, getRGB, getRGBColorComponents, getRGBComponents, getTransparency, hashCode, HSBtoRGB, RGBtoHSB, toString |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ColorWithAlternatives(float r, float g, float b, float a, Color[] alternativeColors)
r
- the red componentg
- the green componentb
- the blue componenta
- the alpha componentalternativeColors
- the prioritized list of alternative colors.Color.Color(float, float, float, float)
public ColorWithAlternatives(float r, float g, float b, Color[] alternativeColors)
r
- the red componentg
- the green componentb
- the blue componentalternativeColors
- the prioritized list of alternative colors.Color.Color(float, float, float)
public ColorWithAlternatives(int rgba, boolean hasalpha, Color[] alternativeColors)
rgba
- the combined RGBA valuehasalpha
- true if the alpha bits are valid, false otherwisealternativeColors
- the prioritized list of alternative colors.Color.Color(int, boolean)
public ColorWithAlternatives(int r, int g, int b, int a, Color[] alternativeColors)
r
- the red componentg
- the green componentb
- the blue componenta
- the alpha componentalternativeColors
- the prioritized list of alternative colors.Color.Color(int, int, int, int)
public ColorWithAlternatives(int r, int g, int b, Color[] alternativeColors)
r
- the red componentg
- the green componentb
- the blue componentalternativeColors
- the prioritized list of alternative colors.Color.Color(int, int, int)
public ColorWithAlternatives(int rgb, Color[] alternativeColors)
rgb
- the combined RGB componentsalternativeColors
- the prioritized list of alternative colors.Color.Color(int)
public ColorWithAlternatives(ColorSpace cspace, float[] components, float alpha, Color[] alternativeColors)
cspace
- the color spacecomponents
- the color componentsalpha
- the alpha componentalternativeColors
- the prioritized list of alternative colors.Color.Color(ColorSpace, float[], float)
Method Detail |
---|
public Color[] getAlternativeColors()
public boolean hasAlternativeColors()
public boolean hasSameAlternativeColors(ColorWithAlternatives col)
col
- the color to compare the alternatives to
public Color getFirstAlternativeOfType(int colorSpaceType)
colorSpaceType
- the color space type (ColorSpace
.TYPE_*).
|
xmlgraphics-commons 1.5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |