Summary: Inherited Constants | Ctors | Methods | Inherited Methods | [Expand All]

public class

GradientPaint

extends Object
implements Paint

java.lang.Object
↳	java.awt.GradientPaint

Class Overview

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.

Summary

[Expand]

Inherited Constants

From interface java.awt.Transparency

Public Constructors
	GradientPaint(float x1, float y1, Color color1, float x2, float y2, Color color2) Constructs a simple acyclic `GradientPaint` object.
	GradientPaint(Point2D pt1, Color color1, Point2D pt2, Color color2) Constructs a simple acyclic `GradientPaint` object.
	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.
	GradientPaint(Point2D pt1, Color color1, Point2D pt2, Color color2, boolean cyclic) Constructs either a cyclic or acyclic `GradientPaint` object depending on the `boolean` parameter.

Public Methods
PaintContext	createContext(ColorModel cm, Rectangle deviceBounds, Rectangle2D userBounds, AffineTransform xform, RenderingHints hints) Creates and returns a `PaintContext` used to generate a linear color gradient pattern.
Color	getColor1() Returns the color C1 anchored by the point P1.
Color	getColor2() Returns the color C2 anchored by the point P2.
Point2D	getPoint1() Returns a copy of the point P1 that anchors the first color.
Point2D	getPoint2() Returns a copy of the point P2 which anchors the second color.
int	getTransparency() Returns the transparency mode for this `GradientPaint`.
boolean	isCyclic() Returns `true` if the gradient cycles repeatedly between the two colors C1 and C2.

[Expand]

Inherited Methods

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

From interface java.awt.Paint

From interface java.awt.Transparency

Public Constructors

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

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 (Point2D pt1, Color color1, Point2D pt2, Color color2)

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 (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	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, boolean cyclic)

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

Public Methods

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

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	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	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 `AffineTransform` 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.

public Color getColor1 ()

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

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 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 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

an integer value representing this GradientPaint object's transparency mode.

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; false otherwise.

Interfaces

Classes

Enums

Exceptions

Errors

GradientPaint

Class Overview

See Also

Summary

Public Constructors

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

Parameters

Throws

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

Parameters

Throws

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

Parameters

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

Parameters

Throws

Public Methods

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

Parameters

Returns

See Also

public Color getColor1 ()

Returns

public Color getColor2 ()

Returns

public Point2D getPoint1 ()

Returns

public Point2D getPoint2 ()

Returns

public int getTransparency ()

Returns

See Also

public boolean isCyclic ()

Returns