Home » openjdk-7 » java » awt » [javadoc | source]
java.awt
public class: GradientPaint [javadoc | source]
java.lang.Object
   java.awt.GradientPaint

All Implemented Interfaces:
    Paint

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.
Field Summary
 Float p1     
 Float p2     
 Color color1     
 Color color2     
 boolean cyclic     
Constructor:
 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(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 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(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
Method from java.awt.GradientPaint Summary:
createContext,   getColor1,   getColor2,   getPoint1,   getPoint2,   getTransparency,   isCyclic
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from java.awt.GradientPaint Detail:
 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.
 public Color getColor1() 
    Returns the color C1 anchored by the point P1.
 public Color getColor2() 
    Returns the color C2 anchored by the point P2.
 public Point2D getPoint1() 
    Returns a copy of the point P1 that anchors the first color.
 public Point2D getPoint2() 
    Returns a copy of the point P2 which anchors the second color.
 public int getTransparency() 
    Returns the transparency mode for this GradientPaint.
 public boolean isCyclic() 
    Returns true if the gradient cycles repeatedly between the two colors C1 and C2.