Module org.jfree.chart

Package org.jfree.chart.plot.dial

Class DialCap

java.lang.Object

org.jfree.chart.plot.dial.AbstractDialLayer

org.jfree.chart.plot.dial.DialCap

All Implemented Interfaces:

Serializable, Cloneable, PublicCloneable, DialLayer

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DialCap()	Creates a new instance of StandardDialBackground.

Method Summary

Modifier and Type	Method	Description
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, hasListener, isVisible, notifyListeners, removeChangeListener, setVisible

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jfree.chart.plot.dial.DialLayer

addChangeListener, hasListener, isVisible, removeChangeListener

Constructor Detail

DialCap

public DialCap()

Creates a new instance of StandardDialBackground. The default background paint is Color.WHITE.

Method Detail

getRadius

public double getRadius()

Returns the radius of the cap, as a percentage of the dial's framing rectangle.

Returns:

The radius.

See Also:

setRadius(double)

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

getFillPaint

public Paint getFillPaint()

Returns the paint used to fill the cap.

Returns:

The paint (never null).

See Also:

setFillPaint(Paint)

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

See Also:

getFillPaint()

getOutlinePaint

public Paint getOutlinePaint()

Returns the paint used to draw the outline of the cap.

Returns:

The paint (never null).

See Also:

setOutlinePaint(Paint)

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

See Also:

getOutlinePaint()

getOutlineStroke

public Stroke getOutlineStroke()

Returns the stroke used to draw the outline of the cap.

Returns:

The stroke (never null).

See Also:

setOutlineStroke(Stroke)

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

See Also:

getOutlineStroke()

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.

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 class AbstractDialLayer

Parameters:

obj - the object (null permitted).

Returns:

A boolean.

hashCode

public int hashCode()

Returns a hash code for this instance.

Overrides:

hashCode in class AbstractDialLayer

Returns:

The hash code.

clone

public Object clone()
             throws CloneNotSupportedException

Returns a clone of this instance.

Specified by:

clone in interface PublicCloneable

Overrides:

clone in class AbstractDialLayer

Returns:

A clone.

Throws:

CloneNotSupportedException - if some attribute of the cap cannot be cloned.