org.jfree.chart.plot.dial

Class StandardDialRange

Implemented Interfaces:
Cloneable, DialLayer, PublicCloneable, Serializable

public class StandardDialRange
extends AbstractDialLayer
implements DialLayer, Cloneable, PublicCloneable, Serializable

A layer that draws a range highlight on a dial plot.

Constructor Summary

StandardDialRange()
Creates a new instance of StandardDialRange.
StandardDialRange(double lower, double upper, Paint paint)
Creates a new instance of StandardDialRange.

Method Summary

Object
clone()
Returns a clone of this instance.
void
draw(Graphics2D g2, DialPlot plot, Rectangle2D frame, Rectangle2D view)
Draws the range.
boolean
equals(Object obj)
Tests this instance for equality with an arbitrary object.
double
getInnerRadius()
Returns the inner radius.
double
getLowerBound()
Returns the lower bound (a data value) of the dial range.
double
getOuterRadius()
Returns the outer radius.
Paint
getPaint()
Returns the paint used to highlight the range.
int
getScaleIndex()
Returns the scale index.
double
getUpperBound()
Returns the upper bound of the dial range.
int
hashCode()
Returns a hash code for this instance.
boolean
isClippedToWindow()
Returns true to indicate that this layer should be clipped within the dial window.
void
setBounds(double lower, double upper)
Sets the bounds for the range and sends a DialLayerChangeEvent to all registered listeners.
void
setInnerRadius(double radius)
Sets the inner radius and sends a DialLayerChangeEvent to all registered listeners.
void
setLowerBound(double bound)
Sets the lower bound of the dial range and sends a DialLayerChangeEvent to all registered listeners.
void
setOuterRadius(double radius)
Sets the outer radius and sends a DialLayerChangeEvent to all registered listeners.
void
setPaint(Paint paint)
Sets the paint used to highlight the range and sends a DialLayerChangeEvent to all registered listeners.
void
setScaleIndex(int index)
Sets the scale index and sends a DialLayerChangeEvent to all registered listeners.
void
setUpperBound(double bound)
Sets the upper bound of the dial range and sends a DialLayerChangeEvent to all registered listeners.

Methods inherited from class org.jfree.chart.plot.dial.AbstractDialLayer

addChangeListener, clone, equals, hasListener, hashCode, isVisible, notifyListeners, removeChangeListener, setVisible

Constructor Details

StandardDialRange

public StandardDialRange()
Creates a new instance of StandardDialRange.

StandardDialRange

public StandardDialRange(double lower,
                         double upper,
                         Paint paint)
Creates a new instance of StandardDialRange.
Parameters:
lower - the lower bound.
upper - the upper bound.
paint - the paint (null not permitted).

Method Details

clone

public Object clone()
            throws CloneNotSupportedException
Returns a clone of this instance.
Overrides:
clone in interface AbstractDialLayer
Returns:
A clone.

draw

public void draw(Graphics2D g2,
                 DialPlot plot,
                 Rectangle2D frame,
                 Rectangle2D view)
Draws the range.
Specified by:
draw in interface DialLayer
Parameters:
g2 - the graphics target.
plot - the plot.
frame - the dial's reference frame (in Java2D space).
view - the dial's view rectangle (in Java2D space).

equals

public boolean equals(Object obj)
Tests this instance for equality with an arbitrary object.
Overrides:
equals in interface AbstractDialLayer
Parameters:
obj - the object (null permitted).
Returns:
A boolean.

getInnerRadius

public double getInnerRadius()
Returns the inner radius.
Returns:
The inner radius.

getLowerBound

public double getLowerBound()
Returns the lower bound (a data value) of the dial range.
Returns:
The lower bound of the dial range.

getOuterRadius

public double getOuterRadius()
Returns the outer radius.
Returns:
The outer radius.

getPaint

public Paint getPaint()
Returns the paint used to highlight the range.
Returns:
The paint (never null).

getScaleIndex

public int getScaleIndex()
Returns the scale index.
Returns:
The scale index.

getUpperBound

public double getUpperBound()
Returns the upper bound of the dial range.
Returns:
The upper bound.

hashCode

public int hashCode()
Returns a hash code for this instance.
Overrides:
hashCode in interface AbstractDialLayer
Returns:
The hash code.

isClippedToWindow

public boolean isClippedToWindow()
Returns true to indicate that this layer should be clipped within the dial window.
Specified by:
isClippedToWindow in interface DialLayer
Returns:
true.

setBounds

public void setBounds(double lower,
                      double upper)
Sets the bounds for the range and sends a DialLayerChangeEvent to all registered listeners.
Parameters:
lower - the lower bound.
upper - the upper bound.

setInnerRadius

public void setInnerRadius(double radius)
Sets the inner radius and sends a DialLayerChangeEvent to all registered listeners.
Parameters:
radius - the radius.

setLowerBound

public void setLowerBound(double bound)
Sets the lower bound of the dial range and sends a DialLayerChangeEvent to all registered listeners.
Parameters:
bound - the lower bound.

setOuterRadius

public void setOuterRadius(double radius)
Sets the outer radius and sends a DialLayerChangeEvent to all registered listeners.
Parameters:
radius - the radius.

setPaint

public void setPaint(Paint paint)
Sets the paint used to highlight the range and sends a DialLayerChangeEvent to all registered listeners.
Parameters:
paint - the paint (null not permitted).
See Also:
getPaint()

setScaleIndex

public void setScaleIndex(int index)
Sets the scale index and sends a DialLayerChangeEvent to all registered listeners.
Parameters:
index - the scale index.

setUpperBound

public void setUpperBound(double bound)
Sets the upper bound of the dial range and sends a DialLayerChangeEvent to all registered listeners.
Parameters:
bound - the upper bound.