org.jfree.chart.plot.dial

Class AbstractDialLayer

Implemented Interfaces:
DialLayer
Known Direct Subclasses:
ArcDialFrame, DialBackground, DialCap, DialPointer, DialTextAnnotation, DialValueIndicator, StandardDialFrame, StandardDialRange, StandardDialScale

public abstract class AbstractDialLayer
extends java.lang.Object
implements DialLayer

A base class that can be used to implement a DialLayer. It includes an event notification mechanism.

Constructor Summary

AbstractDialLayer()
Creates a new instance.

Method Summary

void
addChangeListener(DialLayerChangeListener listener)
Registers an object for notification of changes to the dial layer.
Object
clone()
Returns a clone of this instance.
boolean
equals(Object obj)
Tests this instance for equality with an arbitrary object.
boolean
hasListener(EventListener listener)
Returns true if the specified object is registered with the dataset as a listener.
int
hashCode()
Returns a hash code for this instance.
boolean
isVisible()
Returns true if this layer is visible (should be displayed), and false otherwise.
protected void
notifyListeners(DialLayerChangeEvent event)
Notifies all registered listeners that the dial layer has changed.
void
removeChangeListener(DialLayerChangeListener listener)
Deregisters an object for notification of changes to the dial layer.
void
setVisible(boolean visible)
Sets the flag that determines whether or not this layer is drawn by the plot, and sends a DialLayerChangeEvent to all registered listeners.

Constructor Details

AbstractDialLayer

protected AbstractDialLayer()
Creates a new instance.

Method Details

addChangeListener

public void addChangeListener(DialLayerChangeListener listener)
Registers an object for notification of changes to the dial layer.
Specified by:
addChangeListener in interface DialLayer
Parameters:
listener - the object that is being registered.

clone

public Object clone()
            throws CloneNotSupportedException
Returns a clone of this instance.
Returns:
A clone.

equals

public boolean equals(Object obj)
Tests this instance for equality with an arbitrary object.
Parameters:
obj - the object (null permitted).
Returns:
A boolean.

hasListener

public boolean hasListener(EventListener listener)
Returns true if the specified object is registered with the dataset as a listener. Most applications won't need to call this method, it exists mainly for use by unit testing code.
Specified by:
hasListener in interface DialLayer
Parameters:
listener - the listener.
Returns:
A boolean.

hashCode

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

isVisible

public boolean isVisible()
Returns true if this layer is visible (should be displayed), and false otherwise.
Specified by:
isVisible in interface DialLayer
Returns:
A boolean.

notifyListeners

protected void notifyListeners(DialLayerChangeEvent event)
Notifies all registered listeners that the dial layer has changed. The DialLayerChangeEvent provides information about the change.
Parameters:
event - information about the change to the axis.

removeChangeListener

public void removeChangeListener(DialLayerChangeListener listener)
Deregisters an object for notification of changes to the dial layer.
Specified by:
removeChangeListener in interface DialLayer
Parameters:
listener - the object to deregister.

setVisible

public void setVisible(boolean visible)
Sets the flag that determines whether or not this layer is drawn by the plot, and sends a DialLayerChangeEvent to all registered listeners.
Parameters:
visible - the flag.
See Also:
isVisible()