org.jfree.chart.plot.dial

Class StandardDialFrame

Implemented Interfaces:
Cloneable, DialFrame, DialLayer, PublicCloneable, Serializable, DialLayer

public class StandardDialFrame
extends AbstractDialLayer
implements DialFrame, Cloneable, PublicCloneable, Serializable

A simple circular frame for the DialPlot class.
Since:
1.0.7

Constructor Summary

StandardDialFrame()
Creates a new instance of StandardDialFrame.

Method Summary

Object
clone()
Returns a clone of this instance.
void
draw(Graphics2D g2, DialPlot plot, Rectangle2D frame, Rectangle2D view)
Draws the frame.
boolean
equals(Object obj)
Tests this instance for equality with an arbitrary object.
Paint
getBackgroundPaint()
Returns the background paint.
Paint
getForegroundPaint()
Returns the foreground paint.
double
getRadius()
Returns the radius, relative to the framing rectangle.
Stroke
getStroke()
Returns the stroke for the frame.
Shape
getWindow(Rectangle2D frame)
Returns the shape for the window for this dial.
int
hashCode()
Returns a hash code for this instance.
boolean
isClippedToWindow()
Returns false to indicate that this dial layer is not clipped to the dial window.
void
setBackgroundPaint(Paint paint)
Sets the background paint and sends a DialLayerChangeEvent to all registered listeners.
void
setForegroundPaint(Paint paint)
Sets the foreground 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
setStroke(Stroke stroke)
Sets the stroke 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

StandardDialFrame

public StandardDialFrame()
Creates a new instance of StandardDialFrame.

Method Details

clone

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

draw

public void draw(Graphics2D g2,
                 DialPlot plot,
                 Rectangle2D frame,
                 Rectangle2D view)
Draws the frame. This method is called by the DialPlot class, you shouldn't need to call it directly.
Specified by:
draw in interface DialLayer
Parameters:
g2 - the graphics target (null not permitted).
plot - the plot (null not permitted).
frame - the frame (null not permitted).
view - the view (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.

getBackgroundPaint

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

getForegroundPaint

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

getRadius

public double getRadius()
Returns the radius, relative to the framing rectangle.
Returns:
The radius.

getStroke

public Stroke getStroke()
Returns the stroke for the frame.
Returns:
The stroke (never null).

getWindow

public Shape getWindow(Rectangle2D frame)
Returns the shape for the window for this dial. Some dial layers will request that their drawing be clipped within this window.
Specified by:
getWindow in interface DialFrame
Parameters:
frame - the reference frame (null not permitted).
Returns:
The shape of the dial's window.

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 false to indicate that this dial layer is not clipped to the dial window.
Specified by:
isClippedToWindow in interface DialLayer
Returns:
A boolean.

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

setForegroundPaint

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

setRadius

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

setStroke

public void setStroke(Stroke stroke)
Sets the stroke and sends a DialLayerChangeEvent to all registered listeners.
Parameters:
stroke - the stroke (null not permitted).
See Also:
getStroke()