Class Color
- All Implemented Interfaces:
Paint
,Transparency
,Serializable
- Direct Known Subclasses:
ColorUIResource
,SystemColor
Color
class is used to encapsulate colors in the default
sRGB color space or colors in arbitrary color spaces identified by a
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 .
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Color
The color black.static final Color
The color black.static final Color
The color blue.static final Color
The color blue.static final Color
The color cyan.static final Color
The color cyan.static final Color
The color dark gray.static final Color
The color dark gray.static final Color
The color gray.static final Color
The color gray.static final Color
The color green.static final Color
The color green.static final Color
The color light gray.static final Color
The color light gray.static final Color
The color magenta.static final Color
The color magenta.static final Color
The color orange.static final Color
The color orange.static final Color
The color pink.static final Color
The color pink.static final Color
The color red.static final Color
The color red.static final Color
The color white.static final Color
The color white.static final Color
The color yellow.static final Color
The color yellow.Fields declared in interface java.awt.Transparency
BITMASK, OPAQUE, TRANSLUCENT
-
Constructor Summary
ConstructorDescriptionColor
(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).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).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.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.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).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).Color
(ColorSpace cspace, float[] components, float alpha) Creates a color in the specifiedColorSpace
with the color components specified in thefloat
array and the specified alpha. -
Method Summary
Modifier and TypeMethodDescriptionbrighter()
Creates a newColor
that is a brighter version of thisColor
.createContext
(ColorModel cm, Rectangle r, Rectangle2D r2d, AffineTransform xform, RenderingHints hints) Creates and returns aPaintContext
used to generate a solid color field pattern.darker()
Creates a newColor
that is a darker version of thisColor
.static Color
Converts aString
to an integer and returns the specified opaqueColor
.boolean
Determines whether another object is equal to thisColor
.int
getAlpha()
Returns the alpha component in the range 0-255.int
getBlue()
Returns the blue component in the range 0-255 in the default sRGB space.static Color
Finds a color in the system properties.static Color
Finds a color in the system properties.static Color
Finds a color in the system properties.float[]
getColorComponents
(float[] compArray) Returns afloat
array containing only the color components of theColor
, in theColorSpace
of theColor
.float[]
getColorComponents
(ColorSpace cspace, float[] compArray) Returns afloat
array containing only the color components of theColor
in theColorSpace
specified by thecspace
parameter.Returns theColorSpace
of thisColor
.float[]
getComponents
(float[] compArray) Returns afloat
array containing the color and alpha components of theColor
, in theColorSpace
of theColor
.float[]
getComponents
(ColorSpace cspace, float[] compArray) Returns afloat
array containing the color and alpha components of theColor
, in theColorSpace
specified by thecspace
parameter.int
getGreen()
Returns the green component in the range 0-255 in the default sRGB space.static Color
getHSBColor
(float h, float s, float b) Creates aColor
object based on the specified values for the HSB color model.int
getRed()
Returns the red component in the range 0-255 in the default sRGB space.int
getRGB()
Returns the RGB value representing the color in the default sRGBColorModel
.float[]
getRGBColorComponents
(float[] compArray) Returns afloat
array containing only the color components of theColor
, in the default sRGB color space.float[]
getRGBComponents
(float[] compArray) Returns afloat
array containing the color and alpha components of theColor
, as represented in the default sRGB color space.int
Returns the transparency mode for thisColor
.int
hashCode()
Computes the hash code for thisColor
.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.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.toString()
Returns a string representation of thisColor
.
-
Field Details
-
white
The color white. In the default sRGB space. -
WHITE
-
lightGray
The color light gray. In the default sRGB space. -
LIGHT_GRAY
-
gray
The color gray. In the default sRGB space. -
GRAY
-
darkGray
The color dark gray. In the default sRGB space. -
DARK_GRAY
-
black
The color black. In the default sRGB space. -
BLACK
-
red
The color red. In the default sRGB space. -
RED
-
pink
The color pink. In the default sRGB space. -
PINK
-
orange
The color orange. In the default sRGB space. -
ORANGE
-
yellow
The color yellow. In the default sRGB space. -
YELLOW
-
green
The color green. In the default sRGB space. -
GREEN
-
magenta
The color magenta. In the default sRGB space. -
MAGENTA
-
cyan
The color cyan. In the default sRGB space. -
CYAN
-
blue
The color blue. In the default sRGB space. -
BLUE
-
-
Constructor Details
-
Color
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.- Parameters:
r
- the red componentg
- the green componentb
- the blue component- Throws:
IllegalArgumentException
- ifr
,g
orb
are outside of the range 0 to 255, inclusive- See Also:
-
Color
Creates an sRGB color with the specified red, green, blue, and alpha values in the range (0 - 255).- Parameters:
r
- the red componentg
- the green componentb
- the blue componenta
- the alpha component- Throws:
IllegalArgumentException
- ifr
,g
,b
ora
are outside of the range 0 to 255, inclusive- See Also:
-
Color
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.- Parameters:
rgb
- the combined RGB components- See Also:
-
Color
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 thehasalpha
argument isfalse
, alpha is defaulted to 255.- Parameters:
rgba
- the combined RGBA componentshasalpha
-true
if the alpha bits are valid;false
otherwise- See Also:
-
Color
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.- Parameters:
r
- the red componentg
- the green componentb
- the blue component- Throws:
IllegalArgumentException
- ifr
,g
orb
are outside of the range 0.0 to 1.0, inclusive- See Also:
-
Color
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.- Parameters:
r
- the red componentg
- the green componentb
- the blue componenta
- the alpha component- Throws:
IllegalArgumentException
- ifr
,g
b
ora
are outside of the range 0.0 to 1.0, inclusive- See Also:
-
Color
Creates a color in the specifiedColorSpace
with the color components specified in thefloat
array and the specified alpha. The number of components is determined by the type of theColorSpace
. For example, RGB requires 3 components, but CMYK requires 4 components.- Parameters:
cspace
- theColorSpace
to be used to interpret the componentscomponents
- an arbitrary number of color components that is compatible with theColorSpace
alpha
- alpha value- Throws:
IllegalArgumentException
- if any of the values in thecomponents
array oralpha
is outside of the range 0.0 to 1.0- See Also:
-
-
Method Details
-
getRed
public int getRed()Returns the red component in the range 0-255 in the default sRGB space.- Returns:
- the red component.
- See Also:
-
getGreen
public int getGreen()Returns the green component in the range 0-255 in the default sRGB space.- Returns:
- the green component.
- See Also:
-
getBlue
public int getBlue()Returns the blue component in the range 0-255 in the default sRGB space.- Returns:
- the blue component.
- See Also:
-
getAlpha
public int getAlpha()Returns the alpha component in the range 0-255.- Returns:
- the alpha component.
- See Also:
-
getRGB
public int getRGB()Returns the RGB value representing the color in the default sRGBColorModel
. (Bits 24-31 are alpha, 16-23 are red, 8-15 are green, 0-7 are blue).- Returns:
- the RGB value of the color in the default sRGB
ColorModel
. - Since:
- 1.0
- See Also:
-
brighter
Creates a newColor
that is a brighter version of thisColor
.This method applies an arbitrary scale factor to each of the three RGB components of this
Color
to create a brighter version of thisColor
. Thealpha
value is preserved. Althoughbrighter
anddarker
are inverse operations, the results of a series of invocations of these two methods might be inconsistent because of rounding errors.- Returns:
- a new
Color
object that is a brighter version of thisColor
with the samealpha
value. - Since:
- 1.0
- See Also:
-
darker
Creates a newColor
that is a darker version of thisColor
.This method applies an arbitrary scale factor to each of the three RGB components of this
Color
to create a darker version of thisColor
. Thealpha
value is preserved. Althoughbrighter
anddarker
are inverse operations, the results of a series of invocations of these two methods might be inconsistent because of rounding errors.- Returns:
- a new
Color
object that is a darker version of thisColor
with the samealpha
value. - Since:
- 1.0
- See Also:
-
hashCode
-
equals
Determines whether another object is equal to thisColor
.The result is
true
if and only if the argument is notnull
and is aColor
object that has the same red, green, blue, and alpha values as this object. -
toString
Returns a string representation of thisColor
. 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 benull
. -
decode
Converts aString
to an integer and returns the specified opaqueColor
. This method handles string formats that are used to represent octal and hexadecimal numbers.- Parameters:
nm
- aString
that represents an opaque color as a 24-bit integer- Returns:
- the new
Color
object. - Throws:
NumberFormatException
- if the specified string cannot be interpreted as a decimal, octal, or hexadecimal integer.- Since:
- 1.1
- See Also:
-
getColor
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.- Parameters:
nm
- the name of the color property- Returns:
- the
Color
converted from the system property. - Since:
- 1.0
- See Also:
-
getColor
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.- Parameters:
nm
- the name of the color propertyv
- the defaultColor
- Returns:
- the
Color
converted from the system property, or the specifiedColor
. - Since:
- 1.0
- See Also:
-
getColor
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 aColor
object.- Parameters:
nm
- the name of the color propertyv
- the default color value, as an integer- Returns:
- the
Color
converted from the system property or theColor
converted from the specified integer. - Since:
- 1.0
- See Also:
-
HSBtoRGB
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
andbrightness
components should be floating-point values between zero and one (numbers in the range 0.0-1.0). Thehue
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 methodgetRGB
. This integer can be supplied as an argument to theColor
constructor that takes a single integer argument.- Parameters:
hue
- the hue component of the colorsaturation
- the saturation of the colorbrightness
- the brightness of the color- Returns:
- the RGB value of the color with the indicated hue, saturation, and brightness.
- Since:
- 1.0
- See Also:
-
RGBtoHSB
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 isnull
, then a new array is allocated to return the result. Otherwise, the method returns the arrayhsbvals
, with the values put into that array.- Parameters:
r
- the red component of the colorg
- the green component of the colorb
- the blue component of the colorhsbvals
- the array used to return the three HSB values, ornull
- Returns:
- an array of three elements containing the hue, saturation, and brightness (in that order), of the color with the indicated red, green, and blue components.
- Since:
- 1.0
- See Also:
-
getHSBColor
Creates aColor
object based on the specified values for the HSB color model.The
s
andb
components should be floating-point values between zero and one (numbers in the range 0.0-1.0). Theh
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.- Parameters:
h
- the hue components
- the saturation of the colorb
- the brightness of the color- Returns:
- a
Color
object with the specified hue, saturation, and brightness. - Since:
- 1.0
-
getRGBComponents
public float[] getRGBComponents(float[] compArray) Returns afloat
array containing the color and alpha components of theColor
, as represented in the default sRGB color space. IfcompArray
isnull
, 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.- Parameters:
compArray
- an array that this method fills with color and alpha components and returns- Returns:
- the RGBA components in a
float
array.
-
getRGBColorComponents
public float[] getRGBColorComponents(float[] compArray) Returns afloat
array containing only the color components of theColor
, in the default sRGB color space. IfcompArray
isnull
, 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.- Parameters:
compArray
- an array that this method fills with color components and returns- Returns:
- the RGB components in a
float
array.
-
getComponents
public float[] getComponents(float[] compArray) Returns afloat
array containing the color and alpha components of theColor
, in theColorSpace
of theColor
. IfcompArray
isnull
, an array with length equal to the number of components in the associatedColorSpace
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.- Parameters:
compArray
- an array that this method fills with the color and alpha components of thisColor
in itsColorSpace
and returns- Returns:
- the color and alpha components in a
float
array.
-
getColorComponents
public float[] getColorComponents(float[] compArray) Returns afloat
array containing only the color components of theColor
, in theColorSpace
of theColor
. IfcompArray
isnull
, an array with length equal to the number of components in the associatedColorSpace
is created for the return value. Otherwise,compArray
must have at least this length and it is filled in with the components and returned.- Parameters:
compArray
- an array that this method fills with the color components of thisColor
in itsColorSpace
and returns- Returns:
- the color components in a
float
array.
-
getComponents
Returns afloat
array containing the color and alpha components of theColor
, in theColorSpace
specified by thecspace
parameter. IfcompArray
isnull
, an array with length equal to the number of components incspace
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.- Parameters:
cspace
- a specifiedColorSpace
compArray
- an array that this method fills with the color and alpha components of thisColor
in the specifiedColorSpace
and returns- Returns:
- the color and alpha components in a
float
array.
-
getColorComponents
Returns afloat
array containing only the color components of theColor
in theColorSpace
specified by thecspace
parameter. IfcompArray
isnull
, an array with length equal to the number of components incspace
is created for the return value. Otherwise,compArray
must have at least this length, and it is filled in with the components and returned.- Parameters:
cspace
- a specifiedColorSpace
compArray
- an array that this method fills with the color components of thisColor
in the specifiedColorSpace
- Returns:
- the color components in a
float
array.
-
getColorSpace
Returns theColorSpace
of thisColor
.- Returns:
- this
Color
object'sColorSpace
.
-
createContext
public PaintContext createContext(ColorModel cm, Rectangle r, Rectangle2D r2d, AffineTransform xform, RenderingHints hints) Creates and returns aPaintContext
used to generate a solid color field pattern. See thespecification
of the method in thePaint
interface for information on null parameter handling.- Specified by:
createContext
in interfacePaint
- Parameters:
cm
- the preferredColorModel
which represents the most convenient format for the caller to receive the pixel data, ornull
if there is no preference.r
- the device space bounding box of the graphics primitive being rendered.r2d
- the user space bounding box of the graphics primitive being rendered.xform
- theAffineTransform
from user space into device space.hints
- the set of hints that the context object can use to choose between rendering alternatives.- Returns:
- the
PaintContext
for generating color patterns. - See Also:
-
getTransparency
public int getTransparency()Returns the transparency mode for thisColor
. This is required to implement thePaint
interface.- Specified by:
getTransparency
in interfaceTransparency
- Returns:
- this
Color
object's transparency mode. - See Also:
-