GradientPaint JDK 1.6)

Description

public class GradientPaint

The GradientPaint class provides a way to fill a Shape with a linear color gradient pattern.

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.

See also: Paint Graphics2D.setPaint(java.awt.Paint)

Constructors

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

Constructs a simple acyclic GradientPaint object.

Constructs a simple acyclic GradientPaint object.
Parameters:
- x1 - x coordinate of the first specified Point in user space
- y1 - y coordinate of the first specified Point in user space
- color1 - Color at the first specified Point
- x2 - x coordinate of the second specified Point in user space
- y2 - y coordinate of the second specified Point in user space
- color2 - Color at the second specified Point
Throws:
- NullPointerException - if either one of colors is null

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.

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

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

Constructs a simple acyclic GradientPaint object.

Constructs a simple acyclic GradientPaint object.
Parameters:
- pt1 - the first specified Point in user space
- color1 - Color at the first specified Point
- pt2 - the second specified Point in user space
- color2 - Color at the second specified Point
Throws:
- 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.

Constructs either a cyclic or acyclic GradientPaint
object depending on the boolean parameter.
Parameters:
- pt1 - the first specified Point in user space
- color1 - Color at the first specified Point
- pt2 - the second specified Point in user space
- color2 - Color at the second specified Point
- cyclic - true if the gradient pattern should cycle repeatedly between the two colors; false otherwise
Throws:
- NullPointerException - if either one of colors or points is null

Methods

Hide/Show inherited methods

public PaintContext createContext (ColorModel cm, Rectangle deviceBounds, Rectangle2D userBounds, AffineTransform xform, RenderingHints hints) [Specified in Paint]

Creates and returns a context used to generate the color pattern.

Creates and returns a context used to generate the color pattern.
Returns: the {@link PaintContext} that generates color patterns.
Parameters:
- cm - {@link ColorModel} that receives the Paint data. This is used only as a hint.
- deviceBounds - the device space bounding box of the graphics primitive being rendered
- userBounds - the user space bounding box of the graphics primitive being rendered
- xform - the {@link AffineTransform} from user space into device space
- hints - the hints that the context object uses to choose between rendering alternatives
See Also: PaintContext,

public Color getColor1 ()

Returns the color C1 anchored by the point P1.

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

public Color getColor2 ()

Returns the color C2 anchored by the point P2.

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

public Point2D getPoint1 ()

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

Returns a copy of the point P1 that anchors the first color.
Returns: a {@link Point2D} object that is a copy of the point that anchors the first color of this GradientPaint.

public Point2D getPoint2 ()

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

Returns a copy of the point P2 which anchors the second color.
Returns: a {@link Point2D} object that is a copy of the point that anchors the second color of this GradientPaint.

public int getTransparency ()

Returns the transparency mode for this GradientPaint.

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

public boolean isCyclic ()

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

Returns true if the gradient cycles repeatedly
between the two colors C1 and C2.
Returns: true if the gradient cycles repeatedly between the two colors; false otherwise.