org.jfree.chart.plot.dial

Class ArcDialFrame

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

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

A standard frame for the DialPlot class.

Constructor Summary

ArcDialFrame()
Creates a new instance of ArcDialFrame that spans 180 degrees.
ArcDialFrame(double startAngle, double extent)
Creates a new instance of ArcDialFrame that spans the arc specified.

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 (never null).
double
getExtent()
Returns the extent.
Paint
getForegroundPaint()
Returns the foreground paint.
double
getInnerRadius()
Returns the inner radius, relative to the framing rectangle.
double
getOuterRadius()
Returns the outer radius, relative to the framing rectangle.
protected Shape
getOuterWindow(Rectangle2D frame)
Returns the outer window.
double
getStartAngle()
Returns the start angle.
Stroke
getStroke()
Returns the stroke.
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
setExtent(double extent)
Sets the extent 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
setInnerRadius(double radius)
Sets the inner radius and sends a DialLayerChangeEvent to all registered listeners.
void
setOuterRadius(double radius)
Sets the outer radius and sends a DialLayerChangeEvent to all registered listeners.
void
setStartAngle(double angle)
Sets the start angle 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

ArcDialFrame

public ArcDialFrame()
Creates a new instance of ArcDialFrame that spans 180 degrees.

ArcDialFrame

public ArcDialFrame(double startAngle,
                    double extent)
Creates a new instance of ArcDialFrame that spans the arc specified.
Parameters:
startAngle - the startAngle (in degrees).
extent - the extent of the arc (in degrees, counter-clockwise).

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.
Specified by:
draw in interface DialLayer
Parameters:
g2 - the graphics target.
plot - the plot.
frame - the dial's reference frame.
view - the dial's view rectangle.

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 (never null).
Returns:
The background paint.

getExtent

public double getExtent()
Returns the extent.
Returns:
The extent.

getForegroundPaint

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

getInnerRadius

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

getOuterRadius

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

getOuterWindow

protected Shape getOuterWindow(Rectangle2D frame)
Returns the outer window.
Parameters:
frame - the frame.
Returns:
The outer window.

getStartAngle

public double getStartAngle()
Returns the start angle.
Returns:
The start angle.

getStroke

public Stroke getStroke()
Returns the stroke.
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:
false.

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

setExtent

public void setExtent(double extent)
Sets the extent and sends a DialLayerChangeEvent to all registered listeners.
Parameters:
extent - the extent.
See Also:
getExtent()

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

setInnerRadius

public void setInnerRadius(double radius)
Sets the inner radius and sends a DialLayerChangeEvent to all registered listeners.
Parameters:
radius - the inner radius.

setOuterRadius

public void setOuterRadius(double radius)
Sets the outer radius and sends a DialLayerChangeEvent to all registered listeners.
Parameters:
radius - the outer radius.

setStartAngle

public void setStartAngle(double angle)
Sets the start angle and sends a DialLayerChangeEvent to all registered listeners.
Parameters:
angle - the angle.

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