Paint
, Transparency
, Serializable
ColorUIResource
, SystemColor
public class Color extends Object implements Paint, Serializable
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 .
Modifier and Type | Field | Description |
---|---|---|
static final Color |
black |
The color black. |
static final Color |
BLACK |
The color black. |
static final Color |
blue |
The color blue. |
static final Color |
BLUE |
The color blue. |
static final Color |
cyan |
The color cyan. |
static final Color |
CYAN |
The color cyan. |
static final Color |
DARK_GRAY |
The color dark gray. |
static final Color |
darkGray |
The color dark gray. |
static final Color |
gray |
The color gray. |
static final Color |
GRAY |
The color gray. |
static final Color |
green |
The color green. |
static final Color |
GREEN |
The color green. |
static final Color |
LIGHT_GRAY |
The color light gray. |
static final Color |
lightGray |
The color light gray. |
static final Color |
magenta |
The color magenta. |
static final Color |
MAGENTA |
The color magenta. |
static final Color |
orange |
The color orange. |
static final Color |
ORANGE |
The color orange. |
static final Color |
pink |
The color pink. |
static final Color |
PINK |
The color pink. |
static final Color |
red |
The color red. |
static final Color |
RED |
The color red. |
static final Color |
white |
The color white. |
static final Color |
WHITE |
The color white. |
static final Color |
yellow |
The color yellow. |
static final Color |
YELLOW |
The color yellow. |
BITMASK, OPAQUE, TRANSLUCENT
Constructor | Description |
---|---|
Color |
Creates an opaque sRGB color with the specified red, green, and blue values in the range (0.0 - 1.0). |
Color |
Creates an sRGB color with the specified red, green, blue, and alpha values in the range (0.0 - 1.0). |
Color |
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 |
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 |
Creates an opaque sRGB color with the specified red, green, and blue values in the range (0 - 255). |
Color |
Creates an sRGB color with the specified red, green, blue, and alpha values in the range (0 - 255). |
Color |
Creates a color in the specified ColorSpace with the color components specified in the float array and the specified alpha. |
Modifier and Type | Method | Description |
---|---|---|
Color |
brighter() |
Creates a new Color that is a brighter version of this Color . |
PaintContext |
createContext |
Creates and returns a PaintContext used to generate a solid color field pattern. |
Color |
darker() |
Creates a new Color that is a darker version of this Color . |
static Color |
decode |
Converts a String to an integer and returns the specified opaque Color . |
boolean |
equals |
Determines whether another object is equal to this Color . |
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 |
getColor |
Finds a color in the system properties. |
static Color |
getColor |
Finds a color in the system properties. |
static Color |
getColor |
Finds a color in the system properties. |
float[] |
getColorComponents |
Returns a float array containing only the color components of the Color , in the ColorSpace of the Color . |
float[] |
getColorComponents |
Returns a float array containing only the color components of the Color in the ColorSpace specified by the cspace parameter. |
ColorSpace |
getColorSpace() |
Returns the ColorSpace of this Color . |
float[] |
getComponents |
Returns a float array containing the color and alpha components of the Color , in the ColorSpace of the Color . |
float[] |
getComponents |
Returns a float array containing the color and alpha components of the Color , in the ColorSpace specified by the cspace parameter. |
int |
getGreen() |
Returns the green component in the range 0-255 in the default sRGB space. |
static Color |
getHSBColor |
Creates a Color 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 sRGB ColorModel . |
float[] |
getRGBColorComponents |
Returns a float array containing only the color components of the Color , in the default sRGB color space. |
float[] |
getRGBComponents |
Returns a float array containing the color and alpha components of the Color , as represented in the default sRGB color space. |
int |
getTransparency() |
Returns the transparency mode for this Color . |
int |
hashCode() |
Computes the hash code for this Color . |
static int |
HSBtoRGB |
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 |
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. |
String |
toString() |
Returns a string representation of this Color . |
public static final Color white
public static final Color WHITE
public static final Color lightGray
public static final Color LIGHT_GRAY
public static final Color gray
public static final Color GRAY
public static final Color darkGray
public static final Color DARK_GRAY
public static final Color black
public static final Color BLACK
public static final Color red
public static final Color RED
public static final Color pink
public static final Color PINK
public static final Color orange
public static final Color ORANGE
public static final Color yellow
public static final Color YELLOW
public static final Color green
public static final Color GREEN
public static final Color magenta
public static final Color MAGENTA
public static final Color cyan
public static final Color CYAN
public static final Color blue
public static final Color BLUE
public Color(int r, int g, int b)
r
- the red componentg
- the green componentb
- the blue componentIllegalArgumentException
- if r
, g
or b
are outside of the range 0 to 255, inclusive@ConstructorProperties({"red","green","blue","alpha"}) public Color(int r, int g, int b, int a)
r
- the red componentg
- the green componentb
- the blue componenta
- the alpha componentIllegalArgumentException
- if r
, g
, b
or a
are outside of the range 0 to 255, inclusivepublic Color(int rgb)
rgb
- the combined RGB componentspublic Color(int rgba, boolean hasalpha)
hasalpha
argument is false
, alpha is defaulted to 255.rgba
- the combined RGBA componentshasalpha
- true
if the alpha bits are valid; false
otherwisepublic Color(float r, float g, float b)
r
- the red componentg
- the green componentb
- the blue componentIllegalArgumentException
- if r
, g
or b
are outside of the range 0.0 to 1.0, inclusivepublic Color(float r, float g, float b, float a)
r
- the red componentg
- the green componentb
- the blue componenta
- the alpha componentIllegalArgumentException
- if r
, g
b
or a
are outside of the range 0.0 to 1.0, inclusivepublic Color(ColorSpace cspace, float[] components, float alpha)
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.cspace
- the ColorSpace
to be used to interpret the componentscomponents
- an arbitrary number of color components that is compatible with the ColorSpace
alpha
- alpha valueIllegalArgumentException
- if any of the values in the components
array or alpha
is outside of the range 0.0 to 1.0public int getRed()
public int getGreen()
public int getBlue()
public int getAlpha()
public int getRGB()
ColorModel
. (Bits 24-31 are alpha, 16-23 are red, 8-15 are green, 0-7 are blue).ColorModel
.public Color brighter()
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
. The alpha
value is preserved. 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.
Color
object that is a brighter version of this Color
with the same alpha
value.public Color darker()
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
. The alpha
value is preserved. 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.
Color
object that is a darker version of this Color
with the same alpha
value.public int hashCode()
Color
.public boolean equals(Object obj)
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.
public String toString()
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
.public static Color decode(String nm) throws NumberFormatException
String
to an integer and returns the specified opaque Color
. This method handles string formats that are used to represent octal and hexadecimal numbers.nm
- a String
that represents an opaque color as a 24-bit integerColor
object.NumberFormatException
- if the specified string cannot be interpreted as a decimal, octal, or hexadecimal integer.public static Color getColor(String nm)
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.
nm
- the name of the color propertyColor
converted from the system property.public static Color getColor(String nm, Color v)
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.
nm
- the name of the color propertyv
- the default Color
Color
converted from the system property, or the specified Color
.public static Color getColor(String nm, int v)
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.
nm
- the name of the color propertyv
- the default color value, as an integerColor
converted from the system property or the Color
converted from the specified integer.public static int HSBtoRGB(float hue, float saturation, float brightness)
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 getRGB
. This integer can be supplied as an argument to the Color
constructor that takes a single integer argument.
hue
- the hue component of the colorsaturation
- the saturation of the colorbrightness
- the brightness of the colorpublic static float[] RGBtoHSB(int r, int g, int b, float[] hsbvals)
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.
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, or null
public static Color getHSBColor(float h, float s, float b)
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.
h
- the hue components
- the saturation of the colorb
- the brightness of the colorColor
object with the specified hue, saturation, and brightness.public float[] getRGBComponents(float[] compArray)
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.compArray
- an array that this method fills with color and alpha components and returnsfloat
array.public float[] getRGBColorComponents(float[] compArray)
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.compArray
- an array that this method fills with color components and returnsfloat
array.public float[] getComponents(float[] compArray)
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.compArray
- an array that this method fills with the color and alpha components of this Color
in its ColorSpace
and returnsfloat
array.public float[] getColorComponents(float[] compArray)
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.compArray
- an array that this method fills with the color components of this Color
in its ColorSpace
and returnsfloat
array.public float[] getComponents(ColorSpace cspace, float[] compArray)
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.cspace
- a specified ColorSpace
compArray
- an array that this method fills with the color and alpha components of this Color
in the specified ColorSpace
and returnsfloat
array.public float[] getColorComponents(ColorSpace cspace, float[] compArray)
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.cspace
- a specified ColorSpace
compArray
- an array that this method fills with the color components of this Color
in the specified ColorSpace
float
array.public ColorSpace getColorSpace()
ColorSpace
of this Color
.Color
object's ColorSpace
.public PaintContext createContext(ColorModel cm, Rectangle r, Rectangle2D r2d, AffineTransform xform, RenderingHints hints)
PaintContext
used to generate a solid color field pattern. See the specification
of the method in the Paint
interface for information on null parameter handling.createContext
in interface Paint
cm
- the preferred ColorModel
which represents the most convenient format for the caller to receive the pixel data, or null
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
- the AffineTransform
from user space into device space.hints
- the set of hints that the context object can use to choose between rendering alternatives.PaintContext
for generating color patterns.public int getTransparency()
Color
. This is required to implement the Paint
interface.getTransparency
in interface Transparency
Color
object's transparency mode.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/java/awt/Color.html