Module org.jfree.chart

Package org.jfree.chart.util

Class StandardGradientPaintTransformer

java.lang.Object

org.jfree.chart.util.StandardGradientPaintTransformer

All Implemented Interfaces:

Serializable, Cloneable, PublicCloneable, GradientPaintTransformer

public class StandardGradientPaintTransformer
extends Object
implements GradientPaintTransformer, Cloneable, PublicCloneable, Serializable

Transforms a GradientPaint to range over the width of a target shape. Instances of this class are immutable.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
StandardGradientPaintTransformer()	Creates a new transformer with the type GradientPaintTransformType.VERTICAL.
StandardGradientPaintTransformer(GradientPaintTransformType type)	Creates a new transformer with the specified type.

Method Summary

Modifier and Type	Method	Description
Object	clone()	Returns a clone of the transformer.
boolean	equals(Object obj)	Tests this instance for equality with an arbitrary object.
GradientPaintTransformType	getType()	Returns the type of transform.
int	hashCode()	Returns a hash code for this object.
GradientPaint	transform(GradientPaint paint, Shape target)	Transforms a GradientPaint instance to fit the specified target shape.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StandardGradientPaintTransformer

public StandardGradientPaintTransformer()

Creates a new transformer with the type GradientPaintTransformType.VERTICAL.

StandardGradientPaintTransformer

public StandardGradientPaintTransformer(GradientPaintTransformType type)

Creates a new transformer with the specified type.

Parameters:

type - the transform type (null not permitted).

Method Detail

getType

public GradientPaintTransformType getType()

Returns the type of transform.

Returns:

The type of transform (never null).

transform

public GradientPaint transform(GradientPaint paint,
                               Shape target)

Transforms a GradientPaint instance to fit the specified target shape.

Specified by:

transform in interface GradientPaintTransformer

Parameters:

paint - the original paint (null not permitted).

target - the target shape (null not permitted).

Returns:

The transformed paint.

equals

public boolean equals(Object obj)

Tests this instance for equality with an arbitrary object.

Overrides:

equals in class Object

Parameters:

obj - the object (null permitted).

Returns:

A boolean.

clone

public Object clone()
             throws CloneNotSupportedException

Returns a clone of the transformer. Note that instances of this class are immutable, so cloning an instance isn't really necessary.

Specified by:

clone in interface PublicCloneable

Overrides:

clone in class Object

Returns:

A clone.

Throws:

CloneNotSupportedException - not thrown by this class, but subclasses (if any) might.

hashCode

public int hashCode()

Returns a hash code for this object.

Overrides:

hashCode in class Object

Returns:

A hash code.