org.jfree.chart.plot.dial

Class DialPointer

public abstract class DialPointer extends AbstractDialLayer implements DialLayer, Cloneable, PublicCloneable, Serializable

A base class for the pointer in a DialPlot.

Since: 1.0.7

Nested Class Summary
static classDialPointer.Pin
A dial pointer that draws a thin line (like a pin).
static classDialPointer.Pointer
A dial pointer.
Constructor Summary
protected DialPointer()
Creates a new DialPointer instance.
protected DialPointer(int datasetIndex)
Creates a new pointer for the specified dataset.
Method Summary
Objectclone()
Returns a clone of the pointer.
booleanequals(Object obj)
Checks this instance for equality with an arbitrary object.
intgetDatasetIndex()
Returns the dataset index that the pointer maps to.
doublegetRadius()
Returns the radius of the pointer, as a percentage of the dial's framing rectangle.
inthashCode()
Returns a hash code.
booleanisClippedToWindow()
Returns true to indicate that this layer should be clipped within the dial window.
voidsetDatasetIndex(int index)
Sets the dataset index for the pointer and sends a DialLayerChangeEvent to all registered listeners.
voidsetRadius(double radius)
Sets the radius of the pointer and sends a DialLayerChangeEvent to all registered listeners.

Constructor Detail

DialPointer

protected DialPointer()
Creates a new DialPointer instance.

DialPointer

protected DialPointer(int datasetIndex)
Creates a new pointer for the specified dataset.

Parameters: datasetIndex the dataset index.

Method Detail

clone

public Object clone()
Returns a clone of the pointer.

Returns: a clone.

Throws: CloneNotSupportedException if one of the attributes cannot be cloned.

equals

public boolean equals(Object obj)
Checks this instance for equality with an arbitrary object.

Parameters: obj the object (null not permitted).

Returns: A boolean.

getDatasetIndex

public int getDatasetIndex()
Returns the dataset index that the pointer maps to.

Returns: The dataset index.

See Also: getDatasetIndex

getRadius

public double getRadius()
Returns the radius of the pointer, as a percentage of the dial's framing rectangle.

Returns: The radius.

See Also: DialPointer

hashCode

public int hashCode()
Returns a hash code.

Returns: A hash code.

isClippedToWindow

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

Returns: true.

setDatasetIndex

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

Parameters: index the index.

See Also: getDatasetIndex

setRadius

public void setRadius(double radius)
Sets the radius of the pointer and sends a DialLayerChangeEvent to all registered listeners.

Parameters: radius the radius.

See Also: getRadius

Copyright © 2000-2009 by Object Refinery Limited. All Rights Reserved.