org.jfree.chart.plot.dial

Class DialValueIndicator

Implemented Interfaces:
Cloneable, DialLayer, PublicCloneable, Serializable

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

A value indicator for a DialPlot.
Since:
1.0.7

Constructor Summary

DialValueIndicator()
Creates a new instance of DialValueIndicator.
DialValueIndicator(int datasetIndex)
Creates a new instance of DialValueIndicator.

Method Summary

Object
clone()
Returns a clone of this instance.
void
draw(Graphics2D g2, DialPlot plot, Rectangle2D frame, Rectangle2D view)
Draws the background to the specified graphics device.
boolean
equals(Object obj)
Tests this instance for equality with an arbitrary object.
double
getAngle()
Returns the angle for the anchor point.
Paint
getBackgroundPaint()
Returns the background paint.
int
getDatasetIndex()
Returns the index of the dataset from which this indicator fetches its current value.
Font
getFont()
Returns the font.
RectangleAnchor
getFrameAnchor()
Returns the frame anchor.
RectangleInsets
getInsets()
Returns the insets.
NumberFormat
getNumberFormat()
Returns the formatter used to format the value.
Paint
getOutlinePaint()
Returns the outline paint.
Stroke
getOutlineStroke()
Returns the outline stroke.
Paint
getPaint()
Returns the paint.
double
getRadius()
Returns the radius.
Number
getTemplateValue()
Returns the template value.
TextAnchor
getTextAnchor()
Returns the text anchor.
RectangleAnchor
getValueAnchor()
Returns the value anchor.
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
setAngle(double angle)
Sets the angle for the anchor point and sends a DialLayerChangeEvent to all registered listeners.
void
setBackgroundPaint(Paint paint)
Sets the background paint and sends a DialLayerChangeEvent to all registered listeners.
void
setDatasetIndex(int index)
Sets the dataset index and sends a DialLayerChangeEvent to all registered listeners.
void
setFont(Font font)
Sets the font and sends a DialLayerChangeEvent to all registered listeners.
void
setFrameAnchor(RectangleAnchor anchor)
Sets the frame anchor and sends a DialLayerChangeEvent to all registered listeners.
void
setInsets(RectangleInsets insets)
Sets the insets and sends a DialLayerChangeEvent to all registered listeners.
void
setNumberFormat(NumberFormat formatter)
Sets the formatter used to format the value and sends a DialLayerChangeEvent to all registered listeners.
void
setOutlinePaint(Paint paint)
Sets the outline paint and sends a DialLayerChangeEvent to all registered listeners.
void
setOutlineStroke(Stroke stroke)
Sets the outline stroke and sends a DialLayerChangeEvent to all registered listeners.
void
setPaint(Paint paint)
Sets the paint and sends a DialLayerChangeEvent to all registered listeners.
void
setRadius(double radius)
Sets the radius and sends a DialLayerChangeEvent to all registered listeners.
void
setTemplateValue(Number value)
Sets the template value and sends a DialLayerChangeEvent to all registered listeners.
void
setTextAnchor(TextAnchor anchor)
Sets the text anchor and sends a DialLayerChangeEvent to all registered listeners.
void
setValueAnchor(RectangleAnchor anchor)
Sets the value anchor 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

DialValueIndicator

public DialValueIndicator()
Creates a new instance of DialValueIndicator.

DialValueIndicator

public DialValueIndicator(int datasetIndex)
Creates a new instance of DialValueIndicator.
Parameters:
datasetIndex - the dataset index.

Method Details

clone

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

draw

public void draw(Graphics2D g2,
                 DialPlot plot,
                 Rectangle2D frame,
                 Rectangle2D view)
Draws the background to the specified graphics device. If the dial frame specifies a window, the clipping region will already have been set to this window before this method is called.
Specified by:
draw in interface DialLayer
Parameters:
g2 - the graphics device (null not permitted).
plot - the plot (ignored here).
frame - the dial frame (ignored here).
view - the view rectangle (null not permitted).

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.

getAngle

public double getAngle()
Returns the angle for the anchor point. The angle is specified in degrees using the same orientation as Java's Arc2D class.
Returns:
The angle (in degrees).

getBackgroundPaint

public Paint getBackgroundPaint()
Returns the background paint.
Returns:
The background paint.

getDatasetIndex

public int getDatasetIndex()
Returns the index of the dataset from which this indicator fetches its current value.
Returns:
The dataset index.

getFont

public Font getFont()
Returns the font.
Returns:
The font (never null).
See Also:
getFont()

getFrameAnchor

public RectangleAnchor getFrameAnchor()
Returns the frame anchor.
Returns:
The frame anchor.

getInsets

public RectangleInsets getInsets()
Returns the insets.
Returns:
The insets (never null).

getNumberFormat

public NumberFormat getNumberFormat()
Returns the formatter used to format the value.
Returns:
The formatter (never null).

getOutlinePaint

public Paint getOutlinePaint()
Returns the outline paint.
Returns:
The outline paint (never null).

getOutlineStroke

public Stroke getOutlineStroke()
Returns the outline stroke.
Returns:
The outline stroke (never null).

getPaint

public Paint getPaint()
Returns the paint.
Returns:
The paint (never null).

getRadius

public double getRadius()
Returns the radius.
Returns:
The radius.

getTemplateValue

public Number getTemplateValue()
Returns the template value.
Returns:
The template value (never null).

getTextAnchor

public TextAnchor getTextAnchor()
Returns the text anchor.
Returns:
The text anchor (never null).

getValueAnchor

public RectangleAnchor getValueAnchor()
Returns the value anchor.
Returns:
The value anchor (never null).

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.

setAngle

public void setAngle(double angle)
Sets the angle for the anchor point and sends a DialLayerChangeEvent to all registered listeners.
Parameters:
angle - the angle (in degrees).
See Also:
getAngle()

setBackgroundPaint

public void setBackgroundPaint(Paint paint)
Sets the background paint and sends a DialLayerChangeEvent to all registered listeners.
Parameters:
paint - the paint (null not permitted).

setDatasetIndex

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

setFont

public void setFont(Font font)
Sets the font and sends a DialLayerChangeEvent to all registered listeners.
Parameters:
font - the font (null not permitted).

setFrameAnchor

public void setFrameAnchor(RectangleAnchor anchor)
Sets the frame anchor and sends a DialLayerChangeEvent to all registered listeners.
Parameters:
anchor - the anchor (null not permitted).

setInsets

public void setInsets(RectangleInsets insets)
Sets the insets and sends a DialLayerChangeEvent to all registered listeners.
Parameters:
insets - the insets (null not permitted).
See Also:
getInsets()

setNumberFormat

public void setNumberFormat(NumberFormat formatter)
Sets the formatter used to format the value and sends a DialLayerChangeEvent to all registered listeners.
Parameters:
formatter - the formatter (null not permitted).

setOutlinePaint

public void setOutlinePaint(Paint paint)
Sets the outline paint and sends a DialLayerChangeEvent to all registered listeners.
Parameters:
paint - the paint (null not permitted).

setOutlineStroke

public void setOutlineStroke(Stroke stroke)
Sets the outline stroke and sends a DialLayerChangeEvent to all registered listeners.
Parameters:
stroke - the stroke (null not permitted).

setPaint

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

setRadius

public void setRadius(double radius)
Sets the radius and sends a DialLayerChangeEvent to all registered listeners.
Parameters:
radius - the radius.
See Also:
getRadius()

setTemplateValue

public void setTemplateValue(Number value)
Sets the template value and sends a DialLayerChangeEvent to all registered listeners.
Parameters:
value - the value (null not permitted).

setTextAnchor

public void setTextAnchor(TextAnchor anchor)
Sets the text anchor and sends a DialLayerChangeEvent to all registered listeners.
Parameters:
anchor - the anchor (null not permitted).

setValueAnchor

public void setValueAnchor(RectangleAnchor anchor)
Sets the value anchor and sends a DialLayerChangeEvent to all registered listeners.
Parameters:
anchor - the anchor (null not permitted).