org.jfree.chart.renderer

Class GrayPaintScale

java.lang.Object

org.jfree.chart.renderer.GrayPaintScale

All Implemented Interfaces:

Serializable, Cloneable, PaintScale, org.jfree.util.PublicCloneable

public class GrayPaintScale
extends Object
implements PaintScale, org.jfree.util.PublicCloneable, Serializable

A paint scale that returns shades of gray.

Since:

1.0.4

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GrayPaintScale() Creates a new GrayPaintScale instance with default values.
GrayPaintScale(double lowerBound, double upperBound) Creates a new paint scale for values in the specified range.
GrayPaintScale(double lowerBound, double upperBound, int alpha) Creates a new paint scale for values in the specified range.

Method Summary

Modifier and Type	Method and Description
Object	clone() Returns a clone of this GrayPaintScale instance.
boolean	equals(Object obj) Tests this GrayPaintScale instance for equality with an arbitrary object.
int	getAlpha() Returns the alpha transparency that was specified in the constructor.
double	getLowerBound() Returns the lower bound.
Paint	getPaint(double value) Returns a paint for the specified value.
double	getUpperBound() Returns the upper bound.
int	hashCode() Returns a hash code for this instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

GrayPaintScale

public GrayPaintScale()

Creates a new GrayPaintScale instance with default values.

GrayPaintScale

public GrayPaintScale(double lowerBound,
                      double upperBound)

Creates a new paint scale for values in the specified range.

Parameters:

lowerBound - the lower bound.

upperBound - the upper bound.

Throws:

IllegalArgumentException - if lowerBound is not less than upperBound.

GrayPaintScale

public GrayPaintScale(double lowerBound,
                      double upperBound,
                      int alpha)

Creates a new paint scale for values in the specified range.

Parameters:

lowerBound - the lower bound.

upperBound - the upper bound.

alpha - the alpha transparency (0-255).

Throws:

IllegalArgumentException - if lowerBound is not less than upperBound, or alpha is not in the range 0 to 255.

Since:

1.0.13

Method Detail

getLowerBound

public double getLowerBound()

Returns the lower bound.

Specified by:

getLowerBound in interface PaintScale

Returns:

The lower bound.

See Also:

getUpperBound()

getUpperBound

public double getUpperBound()

Returns the upper bound.

Specified by:

getUpperBound in interface PaintScale

Returns:

The upper bound.

See Also:

getLowerBound()

getAlpha

public int getAlpha()

Returns the alpha transparency that was specified in the constructor.

Returns:

The alpha transparency (in the range 0 to 255).

Since:

1.0.13

getPaint

public Paint getPaint(double value)

Returns a paint for the specified value.

Specified by:

getPaint in interface PaintScale

Parameters:

value - the value (must be within the range specified by the lower and upper bounds for the scale).

Returns:

A paint for the specified value.

equals

public boolean equals(Object obj)

Tests this GrayPaintScale instance for equality with an arbitrary object. This method returns true if and only if:

• obj is not null;
• obj is an instance of GrayPaintScale;

Overrides:

equals in class Object

Parameters:

obj - the object (null permitted).

Returns:

A boolean.

hashCode

public int hashCode()

Returns a hash code for this instance.

Overrides:

hashCode in class Object

Returns:

A hash code.

clone

public Object clone()
             throws CloneNotSupportedException

Returns a clone of this GrayPaintScale instance.

Specified by:

clone in interface org.jfree.util.PublicCloneable

Overrides:

clone in class Object

Returns:

A clone.

Throws:

CloneNotSupportedException - if there is a problem cloning this instance.