DialValueIndicator

java.lang.Object
- org.jfree.chart.plot.dial.AbstractDialLayer
- - org.jfree.chart.plot.dial.DialValueIndicator

All Implemented Interfaces:

Serializable, Cloneable, DialLayer, org.jfree.util.PublicCloneable
```
public class DialValueIndicator
extends AbstractDialLayer
implements DialLayer, Cloneable, org.jfree.util.PublicCloneable, Serializable
```
A value indicator for a DialPlot.

Since:

1.0.7

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description
`DialValueIndicator()` Creates a new instance of `DialValueIndicator`.
`DialValueIndicator(int datasetIndex)` Creates a new instance of `DialValueIndicator`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`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.
`org.jfree.ui.RectangleAnchor`	`getFrameAnchor()` Returns the frame anchor.
`org.jfree.ui.RectangleInsets`	`getInsets()` Returns the insets.
`Number`	`getMaxTemplateValue()` Returns the template value for the maximum size of the indicator bounds.
`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.
`org.jfree.ui.TextAnchor`	`getTextAnchor()` Returns the text anchor.
`org.jfree.ui.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(org.jfree.ui.RectangleAnchor anchor)` Sets the frame anchor and sends a `DialLayerChangeEvent` to all registered listeners.
`void`	`setInsets(org.jfree.ui.RectangleInsets insets)` Sets the insets and sends a `DialLayerChangeEvent` to all registered listeners.
`void`	`setMaxTemplateValue(Number value)` Sets the template value for the maximum size of the indicator bounds 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(org.jfree.ui.TextAnchor anchor)` Sets the text anchor and sends a `DialLayerChangeEvent` to all registered listeners.
`void`	`setValueAnchor(org.jfree.ui.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, hasListener, isVisible, removeChangeListener, setVisible

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jfree.chart.plot.dial.DialLayer
addChangeListener, hasListener, isVisible, removeChangeListener

- 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
  - getDatasetIndex
```
public int getDatasetIndex()
```
    Returns the index of the dataset from which this indicator fetches its current value.
    
    Returns:
    
    The dataset index.
    
    See Also:
    
    setDatasetIndex(int)
  - 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()
  - 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:
    
    setAngle(double)
  - 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()
  - getRadius
```
public double getRadius()
```
    Returns the radius.
    
    Returns:
    
    The radius.
    
    See Also:
    
    setRadius(double)
  - setRadius
```
public void setRadius(double radius)
```
    Sets the radius and sends a DialLayerChangeEvent to all registered listeners.
    
    Parameters:
    
    radius - the radius.
    
    See Also:
    
    getRadius()
  - getFrameAnchor
```
public org.jfree.ui.RectangleAnchor getFrameAnchor()
```
    Returns the frame anchor.
    
    Returns:
    
    The frame anchor.
    
    See Also:
    
    setFrameAnchor(RectangleAnchor)
  - setFrameAnchor
```
public void setFrameAnchor(org.jfree.ui.RectangleAnchor anchor)
```
    Sets the frame anchor and sends a DialLayerChangeEvent to all registered listeners.
    
    Parameters:
    
    anchor - the anchor (null not permitted).
    
    See Also:
    
    getFrameAnchor()
  - getTemplateValue
```
public Number getTemplateValue()
```
    Returns the template value.
    
    Returns:
    
    The template value (never null).
    
    See Also:
    
    setTemplateValue(Number)
  - 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(Number)
  - getMaxTemplateValue
```
public Number getMaxTemplateValue()
```
    Returns the template value for the maximum size of the indicator bounds.
    
    Returns:
    
    The template value (possibly null).
    
    Since:
    
    1.0.14
    
    See Also:
    
    setMaxTemplateValue(java.lang.Number)
  - setMaxTemplateValue
```
public void setMaxTemplateValue(Number value)
```
    Sets the template value for the maximum size of the indicator bounds and sends a DialLayerChangeEvent to all registered listeners.
    
    Parameters:
    
    value - the value (null permitted).
    
    Since:
    
    1.0.14
    
    See Also:
    
    getMaxTemplateValue()
  - getNumberFormat
```
public NumberFormat getNumberFormat()
```
    Returns the formatter used to format the value.
    
    Returns:
    
    The formatter (never null).
    
    See Also:
    
    setNumberFormat(NumberFormat)
  - 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()
  - getFont
```
public Font getFont()
```
    Returns the font.
    
    Returns:
    
    The font (never null).
    
    See Also:
    
    getFont()
  - setFont
```
public void setFont(Font font)
```
    Sets the font and sends a DialLayerChangeEvent to all registered listeners.
    
    Parameters:
    
    font - the font (null not permitted).
  - getPaint
```
public Paint getPaint()
```
    Returns the paint.
    
    Returns:
    
    The paint (never null).
    
    See Also:
    
    setPaint(Paint)
  - 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()
  - getBackgroundPaint
```
public Paint getBackgroundPaint()
```
    Returns the background paint.
    
    Returns:
    
    The background paint.
    
    See Also:
    
    setBackgroundPaint(Paint)
  - 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()
  - getOutlineStroke
```
public Stroke getOutlineStroke()
```
    Returns the outline stroke.
    
    Returns:
    
    The outline stroke (never null).
    
    See Also:
    
    setOutlineStroke(Stroke)
  - 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()
  - getOutlinePaint
```
public Paint getOutlinePaint()
```
    Returns the outline paint.
    
    Returns:
    
    The outline paint (never null).
    
    See Also:
    
    setOutlinePaint(Paint)
  - 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()
  - getInsets
```
public org.jfree.ui.RectangleInsets getInsets()
```
    Returns the insets.
    
    Returns:
    
    The insets (never null).
    
    See Also:
    
    setInsets(RectangleInsets)
  - setInsets
```
public void setInsets(org.jfree.ui.RectangleInsets insets)
```
    Sets the insets and sends a DialLayerChangeEvent to all registered listeners.
    
    Parameters:
    
    insets - the insets (null not permitted).
    
    See Also:
    
    getInsets()
  - getValueAnchor
```
public org.jfree.ui.RectangleAnchor getValueAnchor()
```
    Returns the value anchor.
    
    Returns:
    
    The value anchor (never null).
    
    See Also:
    
    setValueAnchor(RectangleAnchor)
  - setValueAnchor
```
public void setValueAnchor(org.jfree.ui.RectangleAnchor anchor)
```
    Sets the value anchor and sends a DialLayerChangeEvent to all registered listeners.
    
    Parameters:
    
    anchor - the anchor (null not permitted).
    
    See Also:
    
    getValueAnchor()
  - getTextAnchor
```
public org.jfree.ui.TextAnchor getTextAnchor()
```
    Returns the text anchor.
    
    Returns:
    
    The text anchor (never null).
    
    See Also:
    
    setTextAnchor(TextAnchor)
  - setTextAnchor
```
public void setTextAnchor(org.jfree.ui.TextAnchor anchor)
```
    Sets the text anchor and sends a DialLayerChangeEvent to all registered listeners.
    
    Parameters:
    
    anchor - the anchor (null not permitted).
    
    See Also:
    
    getTextAnchor()
  - 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.
  - 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 class AbstractDialLayer
    
    Parameters:
    
    obj - the object (null permitted).
    
    Returns:
    
    A boolean.
  - hashCode
```
public int hashCode()
```
    Returns a hash code for this instance.
    
    Overrides:
    
    hashCode in class AbstractDialLayer
    
    Returns:
    
    The hash code.
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    Returns a clone of this instance.
    
    Specified by:
    
    clone in interface org.jfree.util.PublicCloneable
    
    Overrides:
    
    clone in class AbstractDialLayer
    
    Returns:
    
    The clone.
    
    Throws:
    
    CloneNotSupportedException - if some attribute of this instance cannot be cloned.

Class DialValueIndicator

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface org.jfree.chart.plot.dial.DialLayer

Constructor Detail

DialValueIndicator

DialValueIndicator

Method Detail

getDatasetIndex

setDatasetIndex

getAngle

setAngle

getRadius

setRadius

getFrameAnchor

setFrameAnchor

getTemplateValue

setTemplateValue

getMaxTemplateValue

setMaxTemplateValue

getNumberFormat

setNumberFormat

getFont

setFont

getPaint

setPaint

getBackgroundPaint

setBackgroundPaint

getOutlineStroke

setOutlineStroke

getOutlinePaint

setOutlinePaint

getInsets

setInsets

getValueAnchor

setValueAnchor

getTextAnchor

setTextAnchor

isClippedToWindow

draw

equals

hashCode

clone