org.jfree.chart.plot.dial

Class DialValueIndicator

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
Objectclone()
Returns a clone of this instance.
voiddraw(Graphics2D g2, DialPlot plot, Rectangle2D frame, Rectangle2D view)
Draws the background to the specified graphics device.
booleanequals(Object obj)
Tests this instance for equality with an arbitrary object.
doublegetAngle()
Returns the angle for the anchor point.
PaintgetBackgroundPaint()
Returns the background paint.
intgetDatasetIndex()
Returns the index of the dataset from which this indicator fetches its current value.
FontgetFont()
Returns the font.
RectangleAnchorgetFrameAnchor()
Returns the frame anchor.
RectangleInsetsgetInsets()
Returns the insets.
NumberFormatgetNumberFormat()
Returns the formatter used to format the value.
PaintgetOutlinePaint()
Returns the outline paint.
StrokegetOutlineStroke()
Returns the outline stroke.
PaintgetPaint()
Returns the paint.
doublegetRadius()
Returns the radius.
NumbergetTemplateValue()
Returns the template value.
TextAnchorgetTextAnchor()
Returns the text anchor.
RectangleAnchorgetValueAnchor()
Returns the value anchor.
inthashCode()
Returns a hash code for this instance.
booleanisClippedToWindow()
Returns true to indicate that this layer should be clipped within the dial window.
voidsetAngle(double angle)
Sets the angle for the anchor point and sends a DialLayerChangeEvent to all registered listeners.
voidsetBackgroundPaint(Paint paint)
Sets the background paint and sends a DialLayerChangeEvent to all registered listeners.
voidsetDatasetIndex(int index)
Sets the dataset index and sends a DialLayerChangeEvent to all registered listeners.
voidsetFont(Font font)
Sets the font and sends a DialLayerChangeEvent to all registered listeners.
voidsetFrameAnchor(RectangleAnchor anchor)
Sets the frame anchor and sends a DialLayerChangeEvent to all registered listeners.
voidsetInsets(RectangleInsets insets)
Sets the insets and sends a DialLayerChangeEvent to all registered listeners.
voidsetNumberFormat(NumberFormat formatter)
Sets the formatter used to format the value and sends a DialLayerChangeEvent to all registered listeners.
voidsetOutlinePaint(Paint paint)
Sets the outline paint and sends a DialLayerChangeEvent to all registered listeners.
voidsetOutlineStroke(Stroke stroke)
Sets the outline stroke and sends a DialLayerChangeEvent to all registered listeners.
voidsetPaint(Paint paint)
Sets the paint and sends a DialLayerChangeEvent to all registered listeners.
voidsetRadius(double radius)
Sets the radius and sends a DialLayerChangeEvent to all registered listeners.
voidsetTemplateValue(Number value)
Sets the template value and sends a DialLayerChangeEvent to all registered listeners.
voidsetTextAnchor(TextAnchor anchor)
Sets the text anchor and sends a DialLayerChangeEvent to all registered listeners.
voidsetValueAnchor(RectangleAnchor anchor)
Sets the value anchor and sends a DialLayerChangeEvent to all registered listeners.

Constructor Detail

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 Detail

clone

public Object clone()
Returns a clone of this instance.

Returns: The clone.

Throws: CloneNotSupportedException if some attribute of this instance cannot be cloned.

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.

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.

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).

See Also: DialValueIndicator

getBackgroundPaint

public Paint getBackgroundPaint()
Returns the background paint.

Returns: The background paint.

See Also: setBackgroundPaint

getDatasetIndex

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

Returns: The dataset index.

See Also: DialValueIndicator

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.

See Also: setFrameAnchor

getInsets

public RectangleInsets getInsets()
Returns the insets.

Returns: The insets (never null).

See Also: setInsets

getNumberFormat

public NumberFormat getNumberFormat()
Returns the formatter used to format the value.

Returns: The formatter (never null).

See Also: setNumberFormat

getOutlinePaint

public Paint getOutlinePaint()
Returns the outline paint.

Returns: The outline paint (never null).

See Also: setOutlinePaint

getOutlineStroke

public Stroke getOutlineStroke()
Returns the outline stroke.

Returns: The outline stroke (never null).

See Also: setOutlineStroke

getPaint

public Paint getPaint()
Returns the paint.

Returns: The paint (never null).

See Also: setPaint

getRadius

public double getRadius()
Returns the radius.

Returns: The radius.

See Also: DialValueIndicator

getTemplateValue

public Number getTemplateValue()
Returns the template value.

Returns: The template value (never null).

See Also: setTemplateValue

getTextAnchor

public TextAnchor getTextAnchor()
Returns the text anchor.

Returns: The text anchor (never null).

See Also: setTextAnchor

getValueAnchor

public RectangleAnchor getValueAnchor()
Returns the value anchor.

Returns: The value anchor (never null).

See Also: setValueAnchor

hashCode

public int hashCode()
Returns a hash code for this instance.

Returns: The hash code.

isClippedToWindow

public boolean isClippedToWindow()
Returns true to indicate that this layer should be clipped within the dial window.

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).

See Also: getBackgroundPaint

setDatasetIndex

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

Parameters: index the index.

See Also: getDatasetIndex

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).

See Also: getFrameAnchor

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).

See Also: getNumberFormat

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).

See Also: getOutlinePaint

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).

See Also: getOutlineStroke

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).

See Also: setTemplateValue

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).

See Also: getTextAnchor

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).

See Also: getValueAnchor