OpenJDK 27 · java.awt.GradientPaint · APIdia, the JavaDoc alternative

The GradientPaint class provides a way to fill a Shape with a linear color gradient pattern. If Point P1 with Color C1 and Point P2 with Color C2 are specified in user space, the Color on the P1, P2 connecting line is proportionally changed from C1 to C2. Any point P not on the extended P1, P2 connecting line has the color of the point P' that is the perpendicular projection of P on the extended P1, P2 connecting line. Points on the extended line outside of the P1, P2 segment can be colored in one of two ways.

If the gradient is cyclic then the points on the extended P1, P2 connecting line cycle back and forth between the colors C1 and C2.
If the gradient is acyclic then points on the P1 side of the segment have the constant Color C1 while points on the P2 side have the constant Color C2.

Modifier and Type	Field and Description
pack-priv Color	color1
pack-priv Color	color2
pack-priv boolean	cyclic
pack-priv Point2D.Float	p1
pack-priv Point2D.Float	p2

Constructor Summary

Access	Constructor and Description
public	GradientPaint(float x coordinate of the first specified `Point` in user space x1, float y coordinate of the first specified `Point` in user space y1, Color `Color` at the first specified `Point` color1, float x coordinate of the second specified `Point` in user space x2, float y coordinate of the second specified `Point` in user space y2, Color `Color` at the second specified `Point` color2) Constructs a simple acyclic `GradientPaint` object.
public	GradientPaint(Point2D the first specified `Point` in user space pt1, Color `Color` at the first specified `Point` color1, Point2D the second specified `Point` in user space pt2, Color `Color` at the second specified `Point` color2) Constructs a simple acyclic `GradientPaint` object.
public	GradientPaint(float x coordinate of the first specified `Point` in user space x1, float y coordinate of the first specified `Point` in user space y1, Color `Color` at the first specified `Point` color1, float x coordinate of the second specified `Point` in user space x2, float y coordinate of the second specified `Point` in user space y2, Color `Color` at the second specified `Point` color2, boolean `true` if the gradient pattern should cycle repeatedly between the two colors; `false` otherwise cyclic) Constructs either a cyclic or acyclic `GradientPaint` object depending on the `boolean` parameter.
public	GradientPaint(Point2D the first specified `Point` in user space pt1, Color `Color` at the first specified `Point` color1, Point2D the second specified `Point` in user space pt2, Color `Color` at the second specified `Point` color2, boolean `true` if the gradient pattern should cycle repeatedly between the two colors; `false` otherwise cyclic) Constructs either a cyclic or acyclic `GradientPaint` object depending on the `boolean` parameter.

Method Summary

Modifier and Type	Method and Description
public PaintContext	Returns: the `PaintContext` for generating color patterns. createContext(ColorModel the preferred `ColorModel` which represents the most convenient format for the caller to receive the pixel data, or `null` if there is no preference. cm, Rectangle the device space bounding box of the graphics primitive being rendered. deviceBounds, Rectangle2D the user space bounding box of the graphics primitive being rendered. userBounds, AffineTransform the `AffineTransform` from user space into device space. xform, RenderingHints the set of hints that the context object can use to choose between rendering alternatives. hints) Implements java.awt.Paint.createContext. Creates and returns a `PaintContext` used to generate a linear color gradient pattern.
public Color	Returns: a `Color` object that is the color anchored by P1. getColor1() Returns the color C1 anchored by the point P1.
public Color	Returns: a `Color` object that is the color anchored by P2. getColor2() Returns the color C2 anchored by the point P2.
public Point2D	Returns: a `Point2D` object that is a copy of the point that anchors the first color of this `GradientPaint`. getPoint1() Returns a copy of the point P1 that anchors the first color.
public Point2D	Returns: a `Point2D` object that is a copy of the point that anchors the second color of this `GradientPaint`. getPoint2() Returns a copy of the point P2 which anchors the second color.
public int	Returns: an integer value representing this `GradientPaint` object's transparency mode. getTransparency() Implements java.awt.Transparency.getTransparency. Returns the transparency mode for this `GradientPaint`.
public boolean	Returns: `true` if the gradient cycles repeatedly between the two colors; `false` otherwise. isCyclic() Returns `true` if the gradient cycles repeatedly between the two colors C1 and C2.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

color1	back to summary
pack-priv Color color1

color2	back to summary
pack-priv Color color2

cyclic	back to summary
pack-priv boolean cyclic

p1	back to summary
pack-priv Point2D.Float p1

p2	back to summary
pack-priv Point2D.Float p2

Constructor Detail

GradientPaint back to summary

GradientPaint	back to summary
public GradientPaint(float x1, float y1, Color color1, float x2, float y2, Color color2) Constructs a simple acyclic `GradientPaint` object. Parameters x1:float x coordinate of the first specified `Point` in user space y1:float y coordinate of the first specified `Point` in user space color1:Color `Color` at the first specified `Point` x2:float x coordinate of the second specified `Point` in user space y2:float y coordinate of the second specified `Point` in user space color2:Color `Color` at the second specified `Point` Exceptions NullPointerException: if either one of colors is null

public GradientPaint(float x1, float y1, Color color1, float x2, float y2, Color color2)

Constructs a simple acyclic GradientPaint object.

Parameters

x1:float: x coordinate of the first specified Point in user space
y1:float: y coordinate of the first specified Point in user space
color1:Color: Color at the first specified Point
x2:float: x coordinate of the second specified Point in user space
y2:float: y coordinate of the second specified Point in user space
color2:Color: Color at the second specified Point

Exceptions

NullPointerException:: if either one of colors is null

GradientPaint back to summary

GradientPaint	back to summary
public GradientPaint(Point2D pt1, Color color1, Point2D pt2, Color color2) Constructs a simple acyclic `GradientPaint` object. Parameters pt1:Point2D the first specified `Point` in user space color1:Color `Color` at the first specified `Point` pt2:Point2D the second specified `Point` in user space color2:Color `Color` at the second specified `Point` Exceptions NullPointerException: if either one of colors or points is null

public GradientPaint(Point2D pt1, Color color1, Point2D pt2, Color color2)

Constructs a simple acyclic GradientPaint object.

Parameters

pt1:Point2D: the first specified Point in user space
color1:Color: Color at the first specified Point
pt2:Point2D: the second specified Point in user space
color2:Color: Color at the second specified Point

Exceptions

NullPointerException:: if either one of colors or points is null

GradientPaint back to summary

GradientPaint	back to summary
public GradientPaint(float x1, float y1, Color color1, float x2, float y2, Color color2, boolean cyclic) Constructs either a cyclic or acyclic `GradientPaint` object depending on the `boolean` parameter. Parameters x1:float x coordinate of the first specified `Point` in user space y1:float y coordinate of the first specified `Point` in user space color1:Color `Color` at the first specified `Point` x2:float x coordinate of the second specified `Point` in user space y2:float y coordinate of the second specified `Point` in user space color2:Color `Color` at the second specified `Point` cyclic:boolean `true` if the gradient pattern should cycle repeatedly between the two colors; `false` otherwise

public GradientPaint(float x1, float y1, Color color1, float x2, float y2, Color color2, boolean cyclic)

Constructs either a cyclic or acyclic GradientPaint object depending on the boolean parameter.

Parameters

x1:float: x coordinate of the first specified Point in user space
y1:float: y coordinate of the first specified Point in user space
color1:Color: Color at the first specified Point
x2:float: x coordinate of the second specified Point in user space
y2:float: y coordinate of the second specified Point in user space
color2:Color: Color at the second specified Point
cyclic:boolean: true if the gradient pattern should cycle repeatedly between the two colors; false otherwise

GradientPaint back to summary

GradientPaint	back to summary
public GradientPaint(Point2D pt1, Color color1, Point2D pt2, Color color2, boolean cyclic) Constructs either a cyclic or acyclic `GradientPaint` object depending on the `boolean` parameter. Parameters pt1:Point2D the first specified `Point` in user space color1:Color `Color` at the first specified `Point` pt2:Point2D the second specified `Point` in user space color2:Color `Color` at the second specified `Point` cyclic:boolean `true` if the gradient pattern should cycle repeatedly between the two colors; `false` otherwise Annotations @ConstructorProperties:point1, color1, point2, color2, cyclic Exceptions NullPointerException: if either one of colors or points is null

public GradientPaint(Point2D pt1, Color color1, Point2D pt2, Color color2, boolean cyclic)

Constructs either a cyclic or acyclic GradientPaint object depending on the boolean parameter.

Parameters

pt1:Point2D: the first specified Point in user space
color1:Color: Color at the first specified Point
pt2:Point2D: the second specified Point in user space
color2:Color: Color at the second specified Point
cyclic:boolean: true if the gradient pattern should cycle repeatedly between the two colors; false otherwise

Annotations

@ConstructorProperties:point1, color1, point2, color2, cyclic

Exceptions

NullPointerException:: if either one of colors or points is null

Method Detail

createContext back to summary

createContext	back to summary
public PaintContext createContext(ColorModel cm, Rectangle deviceBounds, Rectangle2D userBounds, AffineTransform xform, RenderingHints hints) Implements java.awt.Paint.createContext. Creates and returns a `PaintContext` used to generate a linear color gradient pattern. See the `specification` of the method in the `Paint` interface for information on null parameter handling. Parameters cm:ColorModel the preferred `ColorModel` which represents the most convenient format for the caller to receive the pixel data, or `null` if there is no preference. deviceBounds:Rectangle the device space bounding box of the graphics primitive being rendered. userBounds:Rectangle2D the user space bounding box of the graphics primitive being rendered. xform:AffineTransform the `AffineTransform` from user space into device space. hints:RenderingHints the set of hints that the context object can use to choose between rendering alternatives. Returns:PaintContext the `PaintContext` for generating color patterns. See Also `Paint`, `PaintContext`, `ColorModel`, `Rectangle`, `Rectangle2D`, `AffineTransform`, `RenderingHints`

public PaintContext createContext(ColorModel cm, Rectangle deviceBounds, Rectangle2D userBounds, AffineTransform xform, RenderingHints hints)

Implements java.awt.Paint.createContext.

Creates and returns a PaintContext used to generate a linear color gradient pattern. See the specification of the method in the Paint interface for information on null parameter handling.

Parameters

cm:ColorModel: the preferred ColorModel which represents the most convenient format for the caller to receive the pixel data, or null if there is no preference.
deviceBounds:Rectangle: the device space bounding box of the graphics primitive being rendered.
userBounds:Rectangle2D: the user space bounding box of the graphics primitive being rendered.
xform:AffineTransform: the AffineTransform from user space into device space.
hints:RenderingHints: the set of hints that the context object can use to choose between rendering alternatives.

Returns:PaintContext

the PaintContext for generating color patterns.

getColor1 back to summary

getColor1	back to summary
public Color getColor1() Returns the color C1 anchored by the point P1. Returns:Color a `Color` object that is the color anchored by P1.

public Color getColor1()

Returns the color C1 anchored by the point P1.

Returns:Color: a Color object that is the color anchored by P1.

getColor2 back to summary

getColor2	back to summary
public Color getColor2() Returns the color C2 anchored by the point P2. Returns:Color a `Color` object that is the color anchored by P2.

public Color getColor2()

Returns the color C2 anchored by the point P2.

Returns:Color: a Color object that is the color anchored by P2.

getPoint1 back to summary

getPoint1	back to summary
public Point2D getPoint1() Returns a copy of the point P1 that anchors the first color. Returns:Point2D a `Point2D` object that is a copy of the point that anchors the first color of this `GradientPaint`.

public Point2D getPoint1()

Returns a copy of the point P1 that anchors the first color.

Returns:Point2D: a Point2D object that is a copy of the point that anchors the first color of this GradientPaint.

getPoint2 back to summary

getPoint2	back to summary
public Point2D getPoint2() Returns a copy of the point P2 which anchors the second color. Returns:Point2D a `Point2D` object that is a copy of the point that anchors the second color of this `GradientPaint`.

public Point2D getPoint2()

Returns a copy of the point P2 which anchors the second color.

Returns:Point2D: a Point2D object that is a copy of the point that anchors the second color of this GradientPaint.

getTransparency back to summary

getTransparency	back to summary
public int getTransparency() Implements java.awt.Transparency.getTransparency. Returns the transparency mode for this `GradientPaint`. Returns:int an integer value representing this `GradientPaint` object's transparency mode. See Also `Transparency`

public int getTransparency()

Implements java.awt.Transparency.getTransparency.

Returns the transparency mode for this GradientPaint.

Returns:int: an integer value representing this GradientPaint object's transparency mode.
See Also: Transparency

isCyclic back to summary

isCyclic	back to summary
public boolean isCyclic() Returns `true` if the gradient cycles repeatedly between the two colors C1 and C2. Returns:boolean `true` if the gradient cycles repeatedly between the two colors; `false` otherwise.

public boolean isCyclic()

Returns true if the gradient cycles repeatedly between the two colors C1 and C2.

Returns:boolean: true if the gradient cycles repeatedly between the two colors; false otherwise.

public Class GradientPaint

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail