| java.lang.Object
 com.xoetrope.batik.ext.awt.MultipleGradientPaint
com.xoetrope.batik.ext.awt.LinearGradientPaint
| LinearGradientPaint | | final public class LinearGradientPaint extends MultipleGradientPaint (Code) | | The LinearGradientPaint class provides a way to fill
a
java.awt.Shape with a linear color gradient pattern. The user may
specify 2 or more gradient colors, and this paint will provide an
interpolation between each color. The user also specifies start and end
points which define where in user space the color gradient should begin
and end.
The user must provide an array of floats specifying how to distribute the
colors along the gradient. These values should range from 0.0 to 1.0 and
act like keyframes along the gradient (they mark where the gradient should
be exactly a particular color).
For example:
Point2D start = new Point2D.Float(0, 0);
Point2D end = new Point2D.Float(100,100);
float[] dist = {0.0, 0.2, 1.0};
Color[] colors = {Color.red, Color.white, Color.blue};
LinearGradientPaint p = new LinearGradientPaint(start, end, dist, colors);
This code will create a LinearGradientPaint which interpolates between
red and white for the first 20% of the gradient and between white and blue
for the remaining 80%.
In the event that the user does not set the first keyframe value equal
to 0 and the last keyframe value equal to 1, keyframes will be created at
these positions and the first and last colors will be replicated there.
So, if a user specifies the following arrays to construct a gradient:
{Color.blue, Color.red}, {.3, .7}
this will be converted to a gradient with the following keyframes:
{Color.blue, Color.blue, Color.red, Color.red}, {0, .3, .7, 1}
The user may also select what action the LinearGradientPaint should take
when filling color outside the start and end points. If no cycle method is
specified, NO_CYCLE will be chosen by default, so the endpoint colors
will be used to fill the remaining area.
The following image demonstrates the options NO_CYCLE and REFLECT.
The colorSpace parameter allows the user to specify in which colorspace
the interpolation should be performed, default sRGB or linearized RGB.
author:
Nicholas Talian, Vincent Hardy, Jim Graham, Jerry Evans
author:
Vincent Hardy
version:
$Id: LinearGradientPaint.java,v 1.2 2006/08/31 09:28:43 val Exp $
See Also: java.awt.Paint
See Also: java.awt.Graphics2D.setPaint |
| Constructor Summary | |
| public | LinearGradientPaint(float startX, float startY, float endX, float endY, float[] fractions, Color[] colors)
Constructs an LinearGradientPaint with the default
NO_CYCLE repeating method and SRGB colorspace. | | public | LinearGradientPaint(float startX, float startY, float endX, float endY, float[] fractions, Color[] colors, CycleMethodEnum cycleMethod)
Constructs an LinearGradientPaint with default SRGB
colorspace. | | public | LinearGradientPaint(Point2D start, Point2D end, float[] fractions, Color[] colors)
Constructs a LinearGradientPaint with the default
NO_CYCLE repeating method and SRGB colorspace. | | public | LinearGradientPaint(Point2D start, Point2D end, float[] fractions, Color[] colors, CycleMethodEnum cycleMethod, ColorSpaceEnum colorSpace)
Constructs a LinearGradientPaint. | | public | LinearGradientPaint(Point2D start, Point2D end, float[] fractions, Color[] colors, CycleMethodEnum cycleMethod, ColorSpaceEnum colorSpace, AffineTransform gradientTransform)
Constructs a LinearGradientPaint. |
| LinearGradientPaint | | public LinearGradientPaint(float startX, float startY, float endX, float endY, float[] fractions, Color[] colors)(Code) | |
Constructs an LinearGradientPaint with the default
NO_CYCLE repeating method and SRGB colorspace.
Parameters:
startX - the x coordinate of the gradient axis start point in user space
Parameters:
startY - the y coordinate of the gradient axis start point in user space
Parameters:
endX - the x coordinate of the gradient axis end point in user space
Parameters:
endY - the y coordinate of the gradient axis end point in user space
Parameters:
fractions - numbers ranging from 0.0 to 1.0 specifying the distribution of colors along the gradient
Parameters:
colors - array of colors corresponding to each fractional value
throws:
IllegalArgumentException - if start and end points are the same points, or if fractions.length != colors.length, or if colors is less than 2 in size. |
| LinearGradientPaint | | public LinearGradientPaint(float startX, float startY, float endX, float endY, float[] fractions, Color[] colors, CycleMethodEnum cycleMethod)(Code) | |
Constructs an LinearGradientPaint with default SRGB
colorspace.
Parameters:
startX - the x coordinate of the gradient axis start point in user space
Parameters:
startY - the y coordinate of the gradient axis start point in user space
Parameters:
endX - the x coordinate of the gradient axis end point in user space
Parameters:
endY - the y coordinate of the gradient axis end point in user space
Parameters:
fractions - numbers ranging from 0.0 to 1.0 specifying the distribution of colors along the gradient
Parameters:
colors - array of colors corresponding to each fractional value
Parameters:
cycleMethod - either NO_CYCLE, REFLECT, or REPEAT
throws:
IllegalArgumentException - if start and end points are the same points, or if fractions.length != colors.length, or if colors is less than 2 in size. |
| LinearGradientPaint | | public LinearGradientPaint(Point2D start, Point2D end, float[] fractions, Color[] colors)(Code) | |
Constructs a LinearGradientPaint with the default
NO_CYCLE repeating method and SRGB colorspace.
Parameters:
start - the gradient axis start Point in user space
Parameters:
end - the gradient axis end Point in user space
Parameters:
fractions - numbers ranging from 0.0 to 1.0 specifying the distribution of colors along the gradient
Parameters:
colors - array of colors corresponding to each fractional value
throws:
NullPointerException - if one of the points is null
throws:
IllegalArgumentException - if start and end points are the same points, or if fractions.length != colors.length, or if colors is less than 2 in size. |
| LinearGradientPaint | | public LinearGradientPaint(Point2D start, Point2D end, float[] fractions, Color[] colors, CycleMethodEnum cycleMethod, ColorSpaceEnum colorSpace)(Code) | |
Constructs a LinearGradientPaint.
Parameters:
start - the gradient axis start Point in user space
Parameters:
end - the gradient axis end Point in user space
Parameters:
fractions - numbers ranging from 0.0 to 1.0 specifying the distribution of colors along the gradient
Parameters:
colors - array of colors corresponding to each fractional value
Parameters:
cycleMethod - either NO_CYCLE, REFLECT, or REPEAT
Parameters:
colorSpace - which colorspace to use for interpolation, either SRGB or LINEAR_RGB
throws:
NullPointerException - if one of the points is null
throws:
IllegalArgumentException - if start and end points are the same points, or if fractions.length != colors.length, or if colors is less than 2 in size. |
| LinearGradientPaint | | public LinearGradientPaint(Point2D start, Point2D end, float[] fractions, Color[] colors, CycleMethodEnum cycleMethod, ColorSpaceEnum colorSpace, AffineTransform gradientTransform)(Code) | |
Constructs a LinearGradientPaint.
Parameters:
start - the gradient axis start Point in user space
Parameters:
end - the gradient axis end Point in user space
Parameters:
fractions - numbers ranging from 0.0 to 1.0 specifying the distribution of colors along the gradient
Parameters:
colors - array of colors corresponding to each fractional value
Parameters:
cycleMethod - either NO_CYCLE, REFLECT, or REPEAT
Parameters:
colorSpace - which colorspace to use for interpolation, either SRGB or LINEAR_RGB
Parameters:
gradientTransform - transform to apply to the gradient
throws:
NullPointerException - if one of the points is null, or gradientTransform is null
throws:
IllegalArgumentException - if start and end points are the same points, or if fractions.length != colors.length, or if colors is less than 2 in size. |
| createContext | | public PaintContext createContext(ColorModel cm, Rectangle deviceBounds, Rectangle2D userBounds, AffineTransform transform, RenderingHints hints)(Code) | | Creates and returns a PaintContext used to generate the color pattern,
for use by the internal rendering engine.
Parameters:
cm - ColorModel that receivesthe Paint data. This is used only as a hint.
Parameters:
deviceBounds - the device space bounding box of the graphics primitive being rendered
Parameters:
userBounds - the user space bounding box of the graphics primitive being rendered
Parameters:
transform - the AffineTransform from userspace into device space
Parameters:
hints - the hints that the context object uses to choosebetween rendering alternatives the PaintContext that generates color patterns.
See Also: PaintContext |
| getEndPoint | | public Point2D getEndPoint()(Code) | | Returns a copy of the end point of the gradient axis
a Point2D object that is a copy of the pointthat anchors the last color of this LinearGradientPaint. |
| getStartPoint | | public Point2D getStartPoint()(Code) | | Returns a copy of the start point of the gradient axis
a Point2D object that is a copy of the pointthat anchors the first color of this LinearGradientPaint. |
|
|