- java.lang.Object
-
- java.awt.Color
-
- All Implemented Interfaces:
Paint,Transparency,Serializable
- Direct Known Subclasses:
ColorUIResource,SystemColor
public class Color extends Object implements Paint, Serializable
TheColorclass is used to encapsulate colors in the default sRGB color space or colors in arbitrary color spaces identified by aColorSpace. 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 aColorwith an explicit alpha or getting the color/alpha components of aColor, 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:
ColorSpace,AlphaComposite, Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static ColorblackThe color black.static ColorBLACKThe color black.static ColorblueThe color blue.static ColorBLUEThe color blue.static ColorcyanThe color cyan.static ColorCYANThe color cyan.static ColorDARK_GRAYThe color dark gray.static ColordarkGrayThe color dark gray.static ColorgrayThe color gray.static ColorGRAYThe color gray.static ColorgreenThe color green.static ColorGREENThe color green.static ColorLIGHT_GRAYThe color light gray.static ColorlightGrayThe color light gray.static ColormagentaThe color magenta.static ColorMAGENTAThe color magenta.static ColororangeThe color orange.static ColorORANGEThe color orange.static ColorpinkThe color pink.static ColorPINKThe color pink.static ColorredThe color red.static ColorREDThe color red.static ColorwhiteThe color white.static ColorWHITEThe color white.static ColoryellowThe color yellow.static ColorYELLOWThe color yellow.-
Fields declared in interface java.awt.Transparency
BITMASK, OPAQUE, TRANSLUCENT
-
-
Constructor Summary
Constructors Constructor Description 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).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 specifiedColorSpacewith the color components specified in thefloatarray and the specified alpha.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Colorbrighter()Creates a newColorthat is a brighter version of thisColor.PaintContextcreateContext(ColorModel cm, Rectangle r, Rectangle2D r2d, AffineTransform xform, RenderingHints hints)Creates and returns aPaintContextused to generate a solid color field pattern.Colordarker()Creates a newColorthat is a darker version of thisColor.static Colordecode(String nm)Converts aStringto an integer and returns the specified opaqueColor.booleanequals(Object obj)Determines whether another object is equal to thisColor.intgetAlpha()Returns the alpha component in the range 0-255.intgetBlue()Returns the blue component in the range 0-255 in the default sRGB space.static ColorgetColor(String nm)Finds a color in the system properties.static ColorgetColor(String nm, int v)Finds a color in the system properties.static ColorgetColor(String nm, Color v)Finds a color in the system properties.float[]getColorComponents(float[] compArray)Returns afloatarray containing only the color components of theColor, in theColorSpaceof theColor.float[]getColorComponents(ColorSpace cspace, float[] compArray)Returns afloatarray containing only the color components of theColorin theColorSpacespecified by thecspaceparameter.ColorSpacegetColorSpace()Returns theColorSpaceof thisColor.float[]getComponents(float[] compArray)Returns afloatarray containing the color and alpha components of theColor, in theColorSpaceof theColor.float[]getComponents(ColorSpace cspace, float[] compArray)Returns afloatarray containing the color and alpha components of theColor, in theColorSpacespecified by thecspaceparameter.intgetGreen()Returns the green component in the range 0-255 in the default sRGB space.static ColorgetHSBColor(float h, float s, float b)Creates aColorobject based on the specified values for the HSB color model.intgetRed()Returns the red component in the range 0-255 in the default sRGB space.intgetRGB()Returns the RGB value representing the color in the default sRGBColorModel.float[]getRGBColorComponents(float[] compArray)Returns afloatarray containing only the color components of theColor, in the default sRGB color space.float[]getRGBComponents(float[] compArray)Returns afloatarray containing the color and alpha components of theColor, as represented in the default sRGB color space.intgetTransparency()Returns the transparency mode for thisColor.inthashCode()Computes the hash code for thisColor.static intHSBtoRGB(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.StringtoString()Returns a string representation of thisColor.
-
-
-
Field Detail
-
white
public static final Color white
The color white. In the default sRGB space.
-
WHITE
public static final Color WHITE
The color white. In the default sRGB space.- Since:
- 1.4
-
lightGray
public static final Color lightGray
The color light gray. In the default sRGB space.
-
LIGHT_GRAY
public static final Color LIGHT_GRAY
The color light gray. In the default sRGB space.- Since:
- 1.4
-
gray
public static final Color gray
The color gray. In the default sRGB space.
-
GRAY
public static final Color GRAY
The color gray. In the default sRGB space.- Since:
- 1.4
-
darkGray
public static final Color darkGray
The color dark gray. In the default sRGB space.
-
DARK_GRAY
public static final Color DARK_GRAY
The color dark gray. In the default sRGB space.- Since:
- 1.4
-
black
public static final Color black
The color black. In the default sRGB space.
-
BLACK
public static final Color BLACK
The color black. In the default sRGB space.- Since:
- 1.4
-
red
public static final Color red
The color red. In the default sRGB space.
-
RED
public static final Color RED
The color red. In the default sRGB space.- Since:
- 1.4
-
pink
public static final Color pink
The color pink. In the default sRGB space.
-
PINK
public static final Color PINK
The color pink. In the default sRGB space.- Since:
- 1.4
-
orange
public static final Color orange
The color orange. In the default sRGB space.
-
ORANGE
public static final Color ORANGE
The color orange. In the default sRGB space.- Since:
- 1.4
-
yellow
public static final Color yellow
The color yellow. In the default sRGB space.
-
YELLOW
public static final Color YELLOW
The color yellow. In the default sRGB space.- Since:
- 1.4
-
green
public static final Color green
The color green. In the default sRGB space.
-
GREEN
public static final Color GREEN
The color green. In the default sRGB space.- Since:
- 1.4
-
magenta
public static final Color magenta
The color magenta. In the default sRGB space.
-
MAGENTA
public static final Color MAGENTA
The color magenta. In the default sRGB space.- Since:
- 1.4
-
cyan
public static final Color cyan
The color cyan. In the default sRGB space.
-
CYAN
public static final Color CYAN
The color cyan. In the default sRGB space.- Since:
- 1.4
-
blue
public static final Color blue
The color blue. In the default sRGB space.
-
BLUE
public static final Color BLUE
The color blue. In the default sRGB space.- Since:
- 1.4
-
-
Constructor Detail
-
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,gorbare outside of the range 0 to 255, inclusive- See Also:
getRed(),getGreen(),getBlue(),getRGB()
-
Color
@ConstructorProperties({"red","green","blue","alpha"}) 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).- Parameters:
r- the red componentg- the green componentb- the blue componenta- the alpha component- Throws:
IllegalArgumentException- ifr,g,boraare outside of the range 0 to 255, inclusive- See Also:
getRed(),getGreen(),getBlue(),getAlpha(),getRGB()
-
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:
ColorModel.getRGBdefault(),getRed(),getGreen(),getBlue(),getRGB()
-
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 thehasalphaargument isfalse, alpha is defaulted to 255.- Parameters:
rgba- the combined RGBA componentshasalpha-trueif the alpha bits are valid;falseotherwise- See Also:
ColorModel.getRGBdefault(),getRed(),getGreen(),getBlue(),getAlpha(),getRGB()
-
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,gorbare outside of the range 0.0 to 1.0, inclusive- See Also:
getRed(),getGreen(),getBlue(),getRGB()
-
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,gboraare outside of the range 0.0 to 1.0, inclusive- See Also:
getRed(),getGreen(),getBlue(),getAlpha(),getRGB()
-
Color
public Color(ColorSpace cspace, float[] components, float alpha)
Creates a color in the specifiedColorSpacewith the color components specified in thefloatarray 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- theColorSpaceto be used to interpret the componentscomponents- an arbitrary number of color components that is compatible with theColorSpacealpha- alpha value- Throws:
IllegalArgumentException- if any of the values in thecomponentsarray oralphais outside of the range 0.0 to 1.0- See Also:
getComponents(float[]),getColorComponents(float[])
-
-
Method Detail
-
getRed
public int getRed()
Returns the red component in the range 0-255 in the default sRGB space.- Returns:
- the red component.
- See Also:
getRGB()
-
getGreen
public int getGreen()
Returns the green component in the range 0-255 in the default sRGB space.- Returns:
- the green component.
- See Also:
getRGB()
-
getBlue
public int getBlue()
Returns the blue component in the range 0-255 in the default sRGB space.- Returns:
- the blue component.
- See Also:
getRGB()
-
getAlpha
public int getAlpha()
Returns the alpha component in the range 0-255.- Returns:
- the alpha component.
- See Also:
getRGB()
-
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:
ColorModel.getRGBdefault(),getRed(),getGreen(),getBlue()
-
brighter
public Color brighter()
Creates a newColorthat is a brighter version of thisColor.This method applies an arbitrary scale factor to each of the three RGB components of this
Colorto create a brighter version of thisColor. Thealphavalue is preserved. Althoughbrighteranddarkerare inverse operations, the results of a series of invocations of these two methods might be inconsistent because of rounding errors.- Returns:
- a new
Colorobject that is a brighter version of thisColorwith the samealphavalue. - Since:
- 1.0
- See Also:
darker()
-
darker
public Color darker()
Creates a newColorthat is a darker version of thisColor.This method applies an arbitrary scale factor to each of the three RGB components of this
Colorto create a darker version of thisColor. Thealphavalue is preserved. Althoughbrighteranddarkerare inverse operations, the results of a series of invocations of these two methods might be inconsistent because of rounding errors.- Returns:
- a new
Colorobject that is a darker version of thisColorwith the samealphavalue. - Since:
- 1.0
- See Also:
brighter()
-
hashCode
public int hashCode()
Computes the hash code for thisColor.- Overrides:
hashCodein classObject- Returns:
- a hash code value for this object.
- Since:
- 1.0
- See Also:
Object.equals(java.lang.Object),System.identityHashCode(java.lang.Object)
-
equals
public boolean equals(Object obj)
Determines whether another object is equal to thisColor.The result is
trueif and only if the argument is notnulland is aColorobject that has the same red, green, blue, and alpha values as this object.- Overrides:
equalsin classObject- Parameters:
obj- the object to test for equality with thisColor- Returns:
trueif the objects are the same;falseotherwise.- Since:
- 1.0
- See Also:
Object.hashCode(),HashMap
-
toString
public String 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
public static Color decode(String nm) throws NumberFormatException
Converts aStringto an integer and returns the specified opaqueColor. This method handles string formats that are used to represent octal and hexadecimal numbers.- Parameters:
nm- aStringthat represents an opaque color as a 24-bit integer- Returns:
- the new
Colorobject. - Throws:
NumberFormatException- if the specified string cannot be interpreted as a decimal, octal, or hexadecimal integer.- Since:
- 1.1
- See Also:
Integer.decode(java.lang.String)
-
getColor
public static Color getColor(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
Colorobject.If the specified property is not found or could not be parsed as an integer then
nullis returned.- Parameters:
nm- the name of the color property- Returns:
- the
Colorconverted from the system property. - Since:
- 1.0
- See Also:
System.getProperty(java.lang.String),Integer.getInteger(java.lang.String),Color(int)
-
getColor
public static Color getColor(String nm, 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
Colorobject.If the specified property is not found or cannot be parsed as an integer then the
Colorspecified by the second argument is returned instead.- Parameters:
nm- the name of the color propertyv- the defaultColor- Returns:
- the
Colorconverted from the system property, or the specifiedColor. - Since:
- 1.0
- See Also:
System.getProperty(java.lang.String),Integer.getInteger(java.lang.String),Color(int)
-
getColor
public static Color getColor(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
Colorobject.If the specified property is not found or could not be parsed as an integer then the integer value
vis used instead, and is converted to aColorobject.- Parameters:
nm- the name of the color propertyv- the default color value, as an integer- Returns:
- the
Colorconverted from the system property or theColorconverted from the specified integer. - Since:
- 1.0
- See Also:
System.getProperty(java.lang.String),Integer.getInteger(java.lang.String),Color(int)
-
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
saturationandbrightnesscomponents should be floating-point values between zero and one (numbers in the range 0.0-1.0). Thehuecomponent 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
HSBtoRGBencodes 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 theColorconstructor 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:
getRGB(),Color(int),ColorModel.getRGBdefault()
-
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
hsbvalsargument 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:
getRGB(),Color(int),ColorModel.getRGBdefault()
-
getHSBColor
public static Color getHSBColor(float h, float s, float b)
Creates aColorobject based on the specified values for the HSB color model.The
sandbcomponents should be floating-point values between zero and one (numbers in the range 0.0-1.0). Thehcomponent 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
Colorobject with the specified hue, saturation, and brightness. - Since:
- 1.0
-
getRGBComponents
public float[] getRGBComponents(float[] compArray)
Returns afloatarray containing the color and alpha components of theColor, as represented in the default sRGB color space. IfcompArrayisnull, an array of length 4 is created for the return value. Otherwise,compArraymust 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
floatarray.
-
getRGBColorComponents
public float[] getRGBColorComponents(float[] compArray)
Returns afloatarray containing only the color components of theColor, in the default sRGB color space. IfcompArrayisnull, an array of length 3 is created for the return value. Otherwise,compArraymust 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
floatarray.
-
getComponents
public float[] getComponents(float[] compArray)
Returns afloatarray containing the color and alpha components of theColor, in theColorSpaceof theColor. IfcompArrayisnull, an array with length equal to the number of components in the associatedColorSpaceplus one is created for the return value. Otherwise,compArraymust 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 thisColorin itsColorSpaceand returns- Returns:
- the color and alpha components in a
floatarray.
-
getColorComponents
public float[] getColorComponents(float[] compArray)
Returns afloatarray containing only the color components of theColor, in theColorSpaceof theColor. IfcompArrayisnull, an array with length equal to the number of components in the associatedColorSpaceis created for the return value. Otherwise,compArraymust 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 thisColorin itsColorSpaceand returns- Returns:
- the color components in a
floatarray.
-
getComponents
public float[] getComponents(ColorSpace cspace, float[] compArray)
Returns afloatarray containing the color and alpha components of theColor, in theColorSpacespecified by thecspaceparameter. IfcompArrayisnull, an array with length equal to the number of components incspaceplus one is created for the return value. Otherwise,compArraymust have at least this length, and it is filled in with the components and returned.- Parameters:
cspace- a specifiedColorSpacecompArray- an array that this method fills with the color and alpha components of thisColorin the specifiedColorSpaceand returns- Returns:
- the color and alpha components in a
floatarray.
-
getColorComponents
public float[] getColorComponents(ColorSpace cspace, float[] compArray)
Returns afloatarray containing only the color components of theColorin theColorSpacespecified by thecspaceparameter. IfcompArrayisnull, an array with length equal to the number of components incspaceis created for the return value. Otherwise,compArraymust have at least this length, and it is filled in with the components and returned.- Parameters:
cspace- a specifiedColorSpacecompArray- an array that this method fills with the color components of thisColorin the specifiedColorSpace- Returns:
- the color components in a
floatarray.
-
getColorSpace
public ColorSpace getColorSpace()
Returns theColorSpaceof thisColor.- Returns:
- this
Colorobject'sColorSpace.
-
createContext
public PaintContext createContext(ColorModel cm, Rectangle r, Rectangle2D r2d, AffineTransform xform, RenderingHints hints)
Creates and returns aPaintContextused to generate a solid color field pattern. See thespecificationof the method in thePaintinterface for information on null parameter handling.- Specified by:
createContextin interfacePaint- Parameters:
cm- the preferredColorModelwhich represents the most convenient format for the caller to receive the pixel data, ornullif 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- theAffineTransformfrom user space into device space.hints- the set of hints that the context object can use to choose between rendering alternatives.- Returns:
- the
PaintContextfor generating color patterns. - See Also:
Paint,PaintContext,ColorModel,Rectangle,Rectangle2D,AffineTransform,RenderingHints
-
getTransparency
public int getTransparency()
Returns the transparency mode for thisColor. This is required to implement thePaintinterface.- Specified by:
getTransparencyin interfaceTransparency- Returns:
- this
Colorobject's transparency mode. - See Also:
Paint,Transparency,createContext(java.awt.image.ColorModel, java.awt.Rectangle, java.awt.geom.Rectangle2D, java.awt.geom.AffineTransform, java.awt.RenderingHints)
-
-