org.jfree.chart.plot.dial

Class DialCap

Implemented Interfaces:
Cloneable, DialLayer, PublicCloneable, Serializable

public class DialCap
extends AbstractDialLayer
implements DialLayer, Cloneable, PublicCloneable, Serializable

A regular dial layer that can be used to draw a cap over the center of the dial (the base of the dial pointer(s)).
Since:
1.0.7

Constructor Summary

DialCap()
Creates a new instance of StandardDialBackground.

Method Summary

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.
Paint
getFillPaint()
Returns the paint used to fill the cap.
Paint
getOutlinePaint()
Returns the paint used to draw the outline of the cap.
Stroke
getOutlineStroke()
Returns the stroke used to draw the outline of the cap.
double
getRadius()
Returns the radius of the cap, as a percentage of the dial's framing rectangle.
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
setFillPaint(Paint paint)
Sets the paint for the cap background and sends a DialLayerChangeEvent to all registered listeners.
void
setOutlinePaint(Paint paint)
Sets the paint used to draw the outline of the cap and sends a DialLayerChangeEvent to all registered listeners.
void
setOutlineStroke(Stroke stroke)
Sets the stroke used to draw the outline of the cap and sends a DialLayerChangeEvent to all registered listeners.
void
setRadius(double radius)
Sets the radius of the cap, as a percentage of the dial's framing rectangle, 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

DialCap

public DialCap()
Creates a new instance of StandardDialBackground. The default background paint is Color.white.

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 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 interface AbstractDialLayer
Parameters:
obj - the object (null permitted).
Returns:
A boolean.

getFillPaint

public Paint getFillPaint()
Returns the paint used to fill the cap.
Returns:
The paint (never null).

getOutlinePaint

public Paint getOutlinePaint()
Returns the paint used to draw the outline of the cap.
Returns:
The paint (never null).

getOutlineStroke

public Stroke getOutlineStroke()
Returns the stroke used to draw the outline of the cap.
Returns:
The stroke (never null).

getRadius

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

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 true to indicate that this layer should be clipped within the dial window.
Specified by:
isClippedToWindow in interface DialLayer
Returns:
true.

setFillPaint

public void setFillPaint(Paint paint)
Sets the paint for the cap background and sends a DialLayerChangeEvent to all registered listeners.
Parameters:
paint - the paint (null not permitted).

setOutlinePaint

public void setOutlinePaint(Paint paint)
Sets the paint used to draw the outline of the cap and sends a DialLayerChangeEvent to all registered listeners.
Parameters:
paint - the paint (null not permitted).

setOutlineStroke

public void setOutlineStroke(Stroke stroke)
Sets the stroke used to draw the outline of the cap and sends a DialLayerChangeEvent to all registered listeners.
Parameters:
stroke - the stroke (null not permitted).

setRadius

public void setRadius(double radius)
Sets the radius of the cap, as a percentage of the dial's framing rectangle, and sends a DialLayerChangeEvent to all registered listeners.
Parameters:
radius - the radius (must be greater than zero).
See Also:
getRadius()