Colorpublic class Color extends Object implements Paint, SerializableThe Color class is used to encapsulate colors in the default
sRGB color space or colors in arbitrary color spaces identified by a
{@link ColorSpace}. Every color has an implicit alpha value of 1.0 or
an explicit one provided in the constructor. The alpha value
defines the transparency of a color and can be represented by
a float value in the range 0.0 - 1.0 or 0 - 255.
An alpha value of 1.0 or 255 means that the color is completely
opaque and an alpha value of 0 or 0.0 means that the color is
completely transparent.
When constructing a Color with an explicit alpha or
getting the color/alpha components of a Color, the color
components are never premultiplied by the alpha component.
The default color space for the Java 2D(tm) API is sRGB, a proposed
standard RGB color space. For further information on sRGB,
see
http://www.w3.org/pub/WWW/Graphics/Color/sRGB.html
.
|
| Fields Summary |
|---|
| public static final Color | whiteThe color white. In the default sRGB space. | | public static final Color | WHITEThe color white. In the default sRGB space. | | public static final Color | lightGrayThe color light gray. In the default sRGB space. | | public static final Color | LIGHT_GRAYThe color light gray. In the default sRGB space. | | public static final Color | grayThe color gray. In the default sRGB space. | | public static final Color | GRAYThe color gray. In the default sRGB space. | | public static final Color | darkGrayThe color dark gray. In the default sRGB space. | | public static final Color | DARK_GRAYThe color dark gray. In the default sRGB space. | | public static final Color | blackThe color black. In the default sRGB space. | | public static final Color | BLACKThe color black. In the default sRGB space. | | public static final Color | redThe color red. In the default sRGB space. | | public static final Color | REDThe color red. In the default sRGB space. | | public static final Color | pinkThe color pink. In the default sRGB space. | | public static final Color | PINKThe color pink. In the default sRGB space. | | public static final Color | orangeThe color orange. In the default sRGB space. | | public static final Color | ORANGEThe color orange. In the default sRGB space. | | public static final Color | yellowThe color yellow. In the default sRGB space. | | public static final Color | YELLOWThe color yellow. In the default sRGB space. | | public static final Color | greenThe color green. In the default sRGB space. | | public static final Color | GREENThe color green. In the default sRGB space. | | public static final Color | magentaThe color magenta. In the default sRGB space. | | public static final Color | MAGENTAThe color magenta. In the default sRGB space. | | public static final Color | cyanThe color cyan. In the default sRGB space. | | public static final Color | CYANThe color cyan. In the default sRGB space. | | public static final Color | blueThe color blue. In the default sRGB space. | | public static final Color | BLUEThe color blue. In the default sRGB space. | | private transient long | pDataPrivate data. | | int | valueThe color value. | | private float[] | frgbvalueThe color value in the default sRGB ColorSpace as
float components (no alpha).
If null after object construction, this must be an
sRGB color constructed with 8-bit precision, so compute from the
int color value. | | private float[] | fvalueThe color value in the native ColorSpace as
float components (no alpha).
If null after object construction, this must be an
sRGB color constructed with 8-bit precision, so compute from the
int color value. | | private float | falphaThe alpha value as a float component.
If frgbvalue is null, this is not valid
data, so compute from the int color value. | | private ColorSpace | csThe ColorSpace. If null, then it's
default is sRGB. | | private static final long | serialVersionUID | | private static final double | FACTOR | | private transient PaintContext | theContextThe paint context used to generate a solid color pattern. |
| Constructors Summary |
|---|
public Color(ColorSpace cspace, float[] components, float alpha)Creates a color in the specified ColorSpace
with the color components specified in the float
array and the specified alpha. The number of components is
determined by the type of the ColorSpace. For
example, RGB requires 3 components, but CMYK requires 4
components.
boolean rangeError = false;
String badComponentString = "";
int n = cspace.getNumComponents();
fvalue = new float[n];
for (int i = 0; i < n; i++) {
if (components[i] < 0.0 || components[i] > 1.0) {
rangeError = true;
badComponentString = badComponentString + "Component " + i
+ " ";
} else {
fvalue[i] = components[i];
}
}
if (alpha < 0.0 || alpha > 1.0) {
rangeError = true;
badComponentString = badComponentString + "Alpha";
} else {
falpha = alpha;
}
if (rangeError) {
throw new IllegalArgumentException(
"Color parameter outside of expected range: " +
badComponentString);
}
frgbvalue = cspace.toRGB(fvalue);
cs = cspace;
value = ((((int)(falpha*255)) & 0xFF) << 24) |
((((int)(frgbvalue[0]*255)) & 0xFF) << 16) |
((((int)(frgbvalue[1]*255)) & 0xFF) << 8) |
((((int)(frgbvalue[2]*255)) & 0xFF) << 0);
| public Color(int r, int g, int b)Creates an opaque sRGB color with the specified red, green,
and blue values in the range (0 - 255).
The actual color used in rendering depends
on finding the best match given the color space
available for a given output device.
Alpha is defaulted to 255.
this(r, g, b, 255);
| public Color(int r, int g, int b, int a)Creates an sRGB color with the specified red, green, blue, and alpha
values in the range (0 - 255).
value = ((a & 0xFF) << 24) |
((r & 0xFF) << 16) |
((g & 0xFF) << 8) |
((b & 0xFF) << 0);
testColorValueRange(r,g,b,a);
| public Color(int rgb)Creates an opaque sRGB color with the specified combined RGB value
consisting of the red component in bits 16-23, the green component
in bits 8-15, and the blue component in bits 0-7. The actual color
used in rendering depends on finding the best match given the
color space available for a particular output device. Alpha is
defaulted to 255.
value = 0xff000000 | rgb;
| public Color(int rgba, boolean hasalpha)Creates an sRGB color with the specified combined RGBA value consisting
of the alpha component in bits 24-31, the red component in bits 16-23,
the green component in bits 8-15, and the blue component in bits 0-7.
If the hasalpha argument is false, alpha
is defaulted to 255.
if (hasalpha) {
value = rgba;
} else {
value = 0xff000000 | rgba;
}
| public Color(float r, float g, float b)Creates an opaque sRGB color with the specified red, green, and blue
values in the range (0.0 - 1.0). Alpha is defaulted to 1.0. The
actual color used in rendering depends on finding the best
match given the color space available for a particular output
device.
this( (int) (r*255+0.5), (int) (g*255+0.5), (int) (b*255+0.5));
testColorValueRange(r,g,b,1.0f);
frgbvalue = new float[3];
frgbvalue[0] = r;
frgbvalue[1] = g;
frgbvalue[2] = b;
falpha = 1.0f;
fvalue = frgbvalue;
| public Color(float r, float g, float b, float a)Creates an sRGB color with the specified red, green, blue, and
alpha values in the range (0.0 - 1.0). The actual color
used in rendering depends on finding the best match given the
color space available for a particular output device.
this((int)(r*255+0.5), (int)(g*255+0.5), (int)(b*255+0.5), (int)(a*255+0.5));
frgbvalue = new float[3];
frgbvalue[0] = r;
frgbvalue[1] = g;
frgbvalue[2] = b;
falpha = a;
fvalue = frgbvalue;
|
| Methods Summary |
|---|
| public static int | HSBtoRGB(float hue, float saturation, float brightness)Converts the components of a color, as specified by the HSB
model, to an equivalent set of values for the default RGB model.
The saturation and brightness components
should be floating-point values between zero and one
(numbers in the range 0.0-1.0). The hue component
can be any floating-point number. The floor of this number is
subtracted from it to create a fraction between 0 and 1. This
fractional number is then multiplied by 360 to produce the hue
angle in the HSB color model.
The integer that is returned by HSBtoRGB encodes the
value of a color in bits 0-23 of an integer value that is the same
format used by the method {@link #getRGB() getRGB}.
This integer can be supplied as an argument to the
Color constructor that takes a single integer argument.
int r = 0, g = 0, b = 0;
if (saturation == 0) {
r = g = b = (int) (brightness * 255.0f + 0.5f);
} else {
float h = (hue - (float)Math.floor(hue)) * 6.0f;
float f = h - (float)java.lang.Math.floor(h);
float p = brightness * (1.0f - saturation);
float q = brightness * (1.0f - saturation * f);
float t = brightness * (1.0f - (saturation * (1.0f - f)));
switch ((int) h) {
case 0:
r = (int) (brightness * 255.0f + 0.5f);
g = (int) (t * 255.0f + 0.5f);
b = (int) (p * 255.0f + 0.5f);
break;
case 1:
r = (int) (q * 255.0f + 0.5f);
g = (int) (brightness * 255.0f + 0.5f);
b = (int) (p * 255.0f + 0.5f);
break;
case 2:
r = (int) (p * 255.0f + 0.5f);
g = (int) (brightness * 255.0f + 0.5f);
b = (int) (t * 255.0f + 0.5f);
break;
case 3:
r = (int) (p * 255.0f + 0.5f);
g = (int) (q * 255.0f + 0.5f);
b = (int) (brightness * 255.0f + 0.5f);
break;
case 4:
r = (int) (t * 255.0f + 0.5f);
g = (int) (p * 255.0f + 0.5f);
b = (int) (brightness * 255.0f + 0.5f);
break;
case 5:
r = (int) (brightness * 255.0f + 0.5f);
g = (int) (p * 255.0f + 0.5f);
b = (int) (q * 255.0f + 0.5f);
break;
}
}
return 0xff000000 | (r << 16) | (g << 8) | (b << 0);
| | public static float[] | RGBtoHSB(int r, int g, int b, float[] hsbvals)Converts the components of a color, as specified by the default RGB
model, to an equivalent set of values for hue, saturation, and
brightness that are the three components of the HSB model.
If the hsbvals argument is null, then a
new array is allocated to return the result. Otherwise, the method
returns the array hsbvals, with the values put into
that array.
float hue, saturation, brightness;
if (hsbvals == null) {
hsbvals = new float[3];
}
int cmax = (r > g) ? r : g;
if (b > cmax) cmax = b;
int cmin = (r < g) ? r : g;
if (b < cmin) cmin = b;
brightness = ((float) cmax) / 255.0f;
if (cmax != 0)
saturation = ((float) (cmax - cmin)) / ((float) cmax);
else
saturation = 0;
if (saturation == 0)
hue = 0;
else {
float redc = ((float) (cmax - r)) / ((float) (cmax - cmin));
float greenc = ((float) (cmax - g)) / ((float) (cmax - cmin));
float bluec = ((float) (cmax - b)) / ((float) (cmax - cmin));
if (r == cmax)
hue = bluec - greenc;
else if (g == cmax)
hue = 2.0f + redc - bluec;
else
hue = 4.0f + greenc - redc;
hue = hue / 6.0f;
if (hue < 0)
hue = hue + 1.0f;
}
hsbvals[0] = hue;
hsbvals[1] = saturation;
hsbvals[2] = brightness;
return hsbvals;
| | public java.awt.Color | brighter()Creates a new Color that is a brighter version of this
Color.
This method applies an arbitrary scale factor to each of the three RGB
components of this Color to create a brighter version
of this Color. Although brighter and
darker are inverse operations, the results of a
series of invocations of these two methods might be inconsistent
because of rounding errors.
int r = getRed();
int g = getGreen();
int b = getBlue();
/* From 2D group:
* 1. black.brighter() should return grey
* 2. applying brighter to blue will always return blue, brighter
* 3. non pure color (non zero rgb) will eventually return white
*/
int i = (int)(1.0/(1.0-FACTOR));
if ( r == 0 && g == 0 && b == 0) {
return new Color(i, i, i);
}
if ( r > 0 && r < i ) r = i;
if ( g > 0 && g < i ) g = i;
if ( b > 0 && b < i ) b = i;
return new Color(Math.min((int)(r/FACTOR), 255),
Math.min((int)(g/FACTOR), 255),
Math.min((int)(b/FACTOR), 255));
| | public synchronized java.awt.PaintContext | createContext(java.awt.image.ColorModel cm, java.awt.Rectangle r, java.awt.geom.Rectangle2D r2d, java.awt.geom.AffineTransform xform, java.awt.RenderingHints hints)Creates and returns a {@link PaintContext} used to generate a solid
color pattern. This enables a Color object to be used
as an argument to any method requiring an object implementing the
{@link Paint} interface.
The same PaintContext is returned, regardless of
whether or not r, r2d,
xform, or hints are null.
PaintContext pc = theContext;
if (pc == null) {
pc = new ColorPaintContext(value, cm);
theContext = pc;
}
return pc;
| | public java.awt.Color | darker()Creates a new Color that is a darker version of this
Color.
This method applies an arbitrary scale factor to each of the three RGB
components of this Color to create a darker version of
this Color. Although brighter and
darker are inverse operations, the results of a series
of invocations of these two methods might be inconsistent because
of rounding errors.
return new Color(Math.max((int)(getRed() *FACTOR), 0),
Math.max((int)(getGreen()*FACTOR), 0),
Math.max((int)(getBlue() *FACTOR), 0));
| | public static java.awt.Color | decode(java.lang.String nm)Converts a String to an integer and returns the
specified opaque Color. This method handles string
formats that are used to represent octal and hexidecimal numbers.
Integer intval = Integer.decode(nm);
int i = intval.intValue();
return new Color((i >> 16) & 0xFF, (i >> 8) & 0xFF, i & 0xFF);
| | public boolean | equals(java.lang.Object obj)Determines whether another object is equal to this
Color.
The result is true if and only if the argument is not
null and is a Color object that has the same
red, green, blue, and alpha values as this object.
return obj instanceof Color && ((Color)obj).value == this.value;
| | public int | getAlpha()Returns the alpha component in the range 0-255.
return (getRGB() >> 24) & 0xff;
| | public int | getBlue()Returns the blue component in the range 0-255 in the default sRGB
space.
return (getRGB() >> 0) & 0xFF;
| | public static java.awt.Color | getColor(java.lang.String nm)Finds a color in the system properties.
The argument is treated as the name of a system property to
be obtained. The string value of this property is then interpreted
as an integer which is then converted to a Color
object.
If the specified property is not found or could not be parsed as
an integer then null is returned.
return getColor(nm, null);
| | public static java.awt.Color | getColor(java.lang.String nm, java.awt.Color v)Finds a color in the system properties.
The first argument is treated as the name of a system property to
be obtained. The string value of this property is then interpreted
as an integer which is then converted to a Color
object.
If the specified property is not found or cannot be parsed as
an integer then the Color specified by the second
argument is returned instead.
Integer intval = Integer.getInteger(nm);
if (intval == null) {
return v;
}
int i = intval.intValue();
return new Color((i >> 16) & 0xFF, (i >> 8) & 0xFF, i & 0xFF);
| | public static java.awt.Color | getColor(java.lang.String nm, int v)Finds a color in the system properties.
The first argument is treated as the name of a system property to
be obtained. The string value of this property is then interpreted
as an integer which is then converted to a Color
object.
If the specified property is not found or could not be parsed as
an integer then the integer value v is used instead,
and is converted to a Color object.
Integer intval = Integer.getInteger(nm);
int i = (intval != null) ? intval.intValue() : v;
return new Color((i >> 16) & 0xFF, (i >> 8) & 0xFF, (i >> 0) & 0xFF);
| | public float[] | getColorComponents(float[] compArray)Returns a float array containing only the color
components of the Color, in the
ColorSpace of the Color.
If compArray is null, an array with
length equal to the number of components in the associated
ColorSpace is created for
the return value. Otherwise, compArray must have at
least this length and it is filled in with the components and
returned.
if (fvalue == null)
return getRGBColorComponents(compArray);
float[] f;
int n = fvalue.length;
if (compArray == null) {
f = new float[n];
} else {
f = compArray;
}
for (int i = 0; i < n; i++) {
f[i] = fvalue[i];
}
return f;
| | public float[] | getColorComponents(java.awt.color.ColorSpace cspace, float[] compArray)Returns a float array containing only the color
components of the Color in the
ColorSpace specified by the cspace
parameter. If compArray is null, an array
with length equal to the number of components in
cspace is created for the return value. Otherwise,
compArray must have at least this length, and it is
filled in with the components and returned.
if (cs == null) {
cs = ColorSpace.getInstance(ColorSpace.CS_sRGB);
}
float f[];
if (fvalue == null) {
f = new float[3];
f[0] = ((float)getRed())/255f;
f[1] = ((float)getGreen())/255f;
f[2] = ((float)getBlue())/255f;
} else {
f = fvalue;
}
float tmp[] = cs.toCIEXYZ(f);
float tmpout[] = cspace.fromCIEXYZ(tmp);
if (compArray == null) {
return tmpout;
}
for (int i = 0 ; i < tmpout.length ; i++) {
compArray[i] = tmpout[i];
}
return compArray;
| | public java.awt.color.ColorSpace | getColorSpace()Returns the ColorSpace of this Color.
if (cs == null) {
cs = ColorSpace.getInstance(ColorSpace.CS_sRGB);
}
return cs;
| | public float[] | getComponents(float[] compArray)Returns a float array containing the color and alpha
components of the Color, in the
ColorSpace of the Color.
If compArray is null, an array with
length equal to the number of components in the associated
ColorSpace plus one is created for
the return value. Otherwise, compArray must have at
least this length and it is filled in with the components and
returned.
if (fvalue == null)
return getRGBComponents(compArray);
float[] f;
int n = fvalue.length;
if (compArray == null) {
f = new float[n + 1];
} else {
f = compArray;
}
for (int i = 0; i < n; i++) {
f[i] = fvalue[i];
}
f[n] = falpha;
return f;
| | public float[] | getComponents(java.awt.color.ColorSpace cspace, float[] compArray)Returns a float array containing the color and alpha
components of the Color, in the
ColorSpace specified by the cspace
parameter. If compArray is null, an
array with length equal to the number of components in
cspace plus one is created for the return value.
Otherwise, compArray must have at least this
length, and it is filled in with the components and returned.
if (cs == null) {
cs = ColorSpace.getInstance(ColorSpace.CS_sRGB);
}
float f[];
if (fvalue == null) {
f = new float[3];
f[0] = ((float)getRed())/255f;
f[1] = ((float)getGreen())/255f;
f[2] = ((float)getBlue())/255f;
} else {
f = fvalue;
}
float tmp[] = cs.toCIEXYZ(f);
float tmpout[] = cspace.fromCIEXYZ(tmp);
if (compArray == null) {
compArray = new float[tmpout.length + 1];
}
for (int i = 0 ; i < tmpout.length ; i++) {
compArray[i] = tmpout[i];
}
if (fvalue == null) {
compArray[tmpout.length] = ((float)getAlpha())/255f;
} else {
compArray[tmpout.length] = falpha;
}
return compArray;
| | public int | getGreen()Returns the green component in the range 0-255 in the default sRGB
space.
return (getRGB() >> 8) & 0xFF;
| | public static java.awt.Color | getHSBColor(float h, float s, float b)Creates a Color object based on the specified values
for the HSB color model.
The s and b components should be
floating-point values between zero and one
(numbers in the range 0.0-1.0). The h component
can be any floating-point number. The floor of this number is
subtracted from it to create a fraction between 0 and 1. This
fractional number is then multiplied by 360 to produce the hue
angle in the HSB color model.
return new Color(HSBtoRGB(h, s, b));
| | public int | getRGB()Returns the RGB value representing the color in the default sRGB
{@link ColorModel}.
(Bits 24-31 are alpha, 16-23 are red, 8-15 are green, 0-7 are
blue).
return value;
| | public float[] | getRGBColorComponents(float[] compArray)Returns a float array containing only the color
components of the Color, in the default sRGB color
space. If compArray is null, an array of
length 3 is created for the return value. Otherwise,
compArray must have length 3 or greater, and it is
filled in with the components and returned.
float[] f;
if (compArray == null) {
f = new float[3];
} else {
f = compArray;
}
if (frgbvalue == null) {
f[0] = ((float)getRed())/255f;
f[1] = ((float)getGreen())/255f;
f[2] = ((float)getBlue())/255f;
} else {
f[0] = frgbvalue[0];
f[1] = frgbvalue[1];
f[2] = frgbvalue[2];
}
return f;
| | public float[] | getRGBComponents(float[] compArray)Returns a float array containing the color and alpha
components of the Color, as represented in the default
sRGB color space.
If compArray is null, an array of length
4 is created for the return value. Otherwise,
compArray must have length 4 or greater,
and it is filled in with the components and returned.
float[] f;
if (compArray == null) {
f = new float[4];
} else {
f = compArray;
}
if (frgbvalue == null) {
f[0] = ((float)getRed())/255f;
f[1] = ((float)getGreen())/255f;
f[2] = ((float)getBlue())/255f;
f[3] = ((float)getAlpha())/255f;
} else {
f[0] = frgbvalue[0];
f[1] = frgbvalue[1];
f[2] = frgbvalue[2];
f[3] = falpha;
}
return f;
| | public int | getRed()Returns the red component in the range 0-255 in the default sRGB
space.
return (getRGB() >> 16) & 0xFF;
| | public int | getTransparency()Returns the transparency mode for this Color. This is
required to implement the Paint interface.
int alpha = getAlpha();
if (alpha == 0xff) {
return Transparency.OPAQUE;
}
else if (alpha == 0) {
return Transparency.BITMASK;
}
else {
return Transparency.TRANSLUCENT;
}
| | public int | hashCode()Computes the hash code for this Color.
return value;
| | private static native void | initIDs()Initialize JNI field and method IDs
| | private static void | testColorValueRange(int r, int g, int b, int a)Checks the color integer components supplied for validity.
Throws an {@link IllegalArgumentException} if the value is out of
range.
/** 4112352 - Calling getDefaultToolkit()
** here can cause this class to be accessed before it is fully
** initialized. DON'T DO IT!!!
**
** Toolkit.getDefaultToolkit();
**/
/* ensure that the necessary native libraries are loaded */
Toolkit.loadLibraries();
if (!GraphicsEnvironment.isHeadless()) {
initIDs();
}
boolean rangeError = false;
String badComponentString = "";
if ( a < 0 || a > 255) {
rangeError = true;
badComponentString = badComponentString + " Alpha";
}
if ( r < 0 || r > 255) {
rangeError = true;
badComponentString = badComponentString + " Red";
}
if ( g < 0 || g > 255) {
rangeError = true;
badComponentString = badComponentString + " Green";
}
if ( b < 0 || b > 255) {
rangeError = true;
badComponentString = badComponentString + " Blue";
}
if ( rangeError == true ) {
throw new IllegalArgumentException("Color parameter outside of expected range:"
+ badComponentString);
}
| | private static void | testColorValueRange(float r, float g, float b, float a)Checks the color float components supplied for
validity.
Throws an IllegalArgumentException if the value is out
of range.
boolean rangeError = false;
String badComponentString = "";
if ( a < 0.0 || a > 1.0) {
rangeError = true;
badComponentString = badComponentString + " Alpha";
}
if ( r < 0.0 || r > 1.0) {
rangeError = true;
badComponentString = badComponentString + " Red";
}
if ( g < 0.0 || g > 1.0) {
rangeError = true;
badComponentString = badComponentString + " Green";
}
if ( b < 0.0 || b > 1.0) {
rangeError = true;
badComponentString = badComponentString + " Blue";
}
if ( rangeError == true ) {
throw new IllegalArgumentException("Color parameter outside of expected range:"
+ badComponentString);
}
| | public java.lang.String | toString()Returns a string representation of this Color. This
method is intended to be used only for debugging purposes. The
content and format of the returned string might vary between
implementations. The returned string might be empty but cannot
be null.
return getClass().getName() + "[r=" + getRed() + ",g=" + getGreen() + ",b=" + getBlue() + "]";
|
|
