Package org.jfree.chart.plot.dial
Class StandardDialRange
- java.lang.Object
-
- org.jfree.chart.plot.dial.AbstractDialLayer
-
- org.jfree.chart.plot.dial.StandardDialRange
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,DialLayer
,PublicCloneable
public class StandardDialRange extends AbstractDialLayer implements DialLayer, java.lang.Cloneable, PublicCloneable, java.io.Serializable
A layer that draws a range highlight on a dial plot.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private double
innerRadius
The factor (in the range 0.0 to 1.0) that determines the inside limit of the range highlight.private double
lowerBound
The minimum data value for the scale.private double
outerRadius
The factor (in the range 0.0 to 1.0) that determines the outside limit of the range highlight.private java.awt.Paint
paint
The paint used to draw the range highlight.private int
scaleIndex
The scale index.(package private) static long
serialVersionUID
For serialization.private double
upperBound
The maximum data value for the scale.
-
Constructor Summary
Constructors Constructor Description StandardDialRange()
Creates a newStandardDialRange
instance.StandardDialRange(double lower, double upper, java.awt.Paint paint)
Creates a newStandardDialRange
instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
Returns a clone of this instance.void
draw(java.awt.Graphics2D g2, DialPlot plot, java.awt.geom.Rectangle2D frame, java.awt.geom.Rectangle2D view)
Draws the range.boolean
equals(java.lang.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.java.awt.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()
Returnstrue
to indicate that this layer should be clipped within the dial window.private void
readObject(java.io.ObjectInputStream stream)
Provides serialization support.void
setBounds(double lower, double upper)
Sets the bounds for the range and sends aDialLayerChangeEvent
to all registered listeners.void
setInnerRadius(double radius)
Sets the inner radius and sends aDialLayerChangeEvent
to all registered listeners.void
setLowerBound(double bound)
Sets the lower bound of the dial range and sends aDialLayerChangeEvent
to all registered listeners.void
setOuterRadius(double radius)
Sets the outer radius and sends aDialLayerChangeEvent
to all registered listeners.void
setPaint(java.awt.Paint paint)
Sets the paint used to highlight the range and sends aDialLayerChangeEvent
to all registered listeners.void
setScaleIndex(int index)
Sets the scale index and sends aDialLayerChangeEvent
to all registered listeners.void
setUpperBound(double bound)
Sets the upper bound of the dial range and sends aDialLayerChangeEvent
to all registered listeners.private void
writeObject(java.io.ObjectOutputStream stream)
Provides serialization support.-
Methods inherited from class org.jfree.chart.plot.dial.AbstractDialLayer
addChangeListener, hasListener, isVisible, notifyListeners, removeChangeListener, setVisible
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.jfree.chart.plot.dial.DialLayer
addChangeListener, hasListener, isVisible, removeChangeListener
-
-
-
-
Field Detail
-
serialVersionUID
static final long serialVersionUID
For serialization.- See Also:
- Constant Field Values
-
scaleIndex
private int scaleIndex
The scale index.
-
lowerBound
private double lowerBound
The minimum data value for the scale.
-
upperBound
private double upperBound
The maximum data value for the scale.
-
paint
private transient java.awt.Paint paint
The paint used to draw the range highlight. This field is transient because it requires special handling for serialization.
-
innerRadius
private double innerRadius
The factor (in the range 0.0 to 1.0) that determines the inside limit of the range highlight.
-
outerRadius
private double outerRadius
The factor (in the range 0.0 to 1.0) that determines the outside limit of the range highlight.
-
-
Constructor Detail
-
StandardDialRange
public StandardDialRange()
Creates a newStandardDialRange
instance.
-
StandardDialRange
public StandardDialRange(double lower, double upper, java.awt.Paint paint)
Creates a newStandardDialRange
instance.- Parameters:
lower
- the lower bound.upper
- the upper bound.paint
- the paint (null
not permitted).
-
-
Method Detail
-
getScaleIndex
public int getScaleIndex()
Returns the scale index.- Returns:
- The scale index.
- See Also:
setScaleIndex(int)
-
setScaleIndex
public void setScaleIndex(int index)
Sets the scale index and sends aDialLayerChangeEvent
to all registered listeners.- Parameters:
index
- the scale index.- See Also:
getScaleIndex()
-
getLowerBound
public double getLowerBound()
Returns the lower bound (a data value) of the dial range.- Returns:
- The lower bound of the dial range.
- See Also:
setLowerBound(double)
-
setLowerBound
public void setLowerBound(double bound)
Sets the lower bound of the dial range and sends aDialLayerChangeEvent
to all registered listeners.- Parameters:
bound
- the lower bound.- See Also:
getLowerBound()
-
getUpperBound
public double getUpperBound()
Returns the upper bound of the dial range.- Returns:
- The upper bound.
- See Also:
setUpperBound(double)
-
setUpperBound
public void setUpperBound(double bound)
Sets the upper bound of the dial range and sends aDialLayerChangeEvent
to all registered listeners.- Parameters:
bound
- the upper bound.- See Also:
getUpperBound()
-
setBounds
public void setBounds(double lower, double upper)
Sets the bounds for the range and sends aDialLayerChangeEvent
to all registered listeners.- Parameters:
lower
- the lower bound.upper
- the upper bound.
-
getPaint
public java.awt.Paint getPaint()
Returns the paint used to highlight the range.- Returns:
- The paint (never
null
). - See Also:
setPaint(Paint)
-
setPaint
public void setPaint(java.awt.Paint paint)
Sets the paint used to highlight the range and sends aDialLayerChangeEvent
to all registered listeners.- Parameters:
paint
- the paint (null
not permitted).- See Also:
getPaint()
-
getInnerRadius
public double getInnerRadius()
Returns the inner radius.- Returns:
- The inner radius.
- See Also:
setInnerRadius(double)
-
setInnerRadius
public void setInnerRadius(double radius)
Sets the inner radius and sends aDialLayerChangeEvent
to all registered listeners.- Parameters:
radius
- the radius.- See Also:
getInnerRadius()
-
getOuterRadius
public double getOuterRadius()
Returns the outer radius.- Returns:
- The outer radius.
- See Also:
setOuterRadius(double)
-
setOuterRadius
public void setOuterRadius(double radius)
Sets the outer radius and sends aDialLayerChangeEvent
to all registered listeners.- Parameters:
radius
- the radius.- See Also:
getOuterRadius()
-
isClippedToWindow
public boolean isClippedToWindow()
Returnstrue
to indicate that this layer should be clipped within the dial window.- Specified by:
isClippedToWindow
in interfaceDialLayer
- Returns:
true
.
-
draw
public void draw(java.awt.Graphics2D g2, DialPlot plot, java.awt.geom.Rectangle2D frame, java.awt.geom.Rectangle2D view)
Draws the range.
-
equals
public boolean equals(java.lang.Object obj)
Tests this instance for equality with an arbitrary object.- Overrides:
equals
in classAbstractDialLayer
- Parameters:
obj
- the object (null
permitted).- Returns:
- A boolean.
-
hashCode
public int hashCode()
Returns a hash code for this instance.- Overrides:
hashCode
in classAbstractDialLayer
- Returns:
- The hash code.
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
Returns a clone of this instance.- Specified by:
clone
in interfacePublicCloneable
- Overrides:
clone
in classAbstractDialLayer
- Returns:
- A clone.
- Throws:
java.lang.CloneNotSupportedException
- if any of the attributes of this instance cannot be cloned.
-
writeObject
private void writeObject(java.io.ObjectOutputStream stream) throws java.io.IOException
Provides serialization support.- Parameters:
stream
- the output stream.- Throws:
java.io.IOException
- if there is an I/O error.
-
readObject
private void readObject(java.io.ObjectInputStream stream) throws java.io.IOException, java.lang.ClassNotFoundException
Provides serialization support.- Parameters:
stream
- the input stream.- Throws:
java.io.IOException
- if there is an I/O error.java.lang.ClassNotFoundException
- if there is a classpath problem.
-
-