org.jfree.chart.plot.dial

Class DialCap

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
Objectclone()
Returns a clone of this instance.
voiddraw(Graphics2D g2, DialPlot plot, Rectangle2D frame, Rectangle2D view)
Draws the background to the specified graphics device.
booleanequals(Object obj)
Tests this instance for equality with an arbitrary object.
PaintgetFillPaint()
Returns the paint used to fill the cap.
PaintgetOutlinePaint()
Returns the paint used to draw the outline of the cap.
StrokegetOutlineStroke()
Returns the stroke used to draw the outline of the cap.
doublegetRadius()
Returns the radius of the cap, as a percentage of the dial's framing rectangle.
inthashCode()
Returns a hash code for this instance.
booleanisClippedToWindow()
Returns true to indicate that this layer should be clipped within the dial window.
voidsetFillPaint(Paint paint)
Sets the paint for the cap background and sends a DialLayerChangeEvent to all registered listeners.
voidsetOutlinePaint(Paint paint)
Sets the paint used to draw the outline of the cap and sends a DialLayerChangeEvent to all registered listeners.
voidsetOutlineStroke(Stroke stroke)
Sets the stroke used to draw the outline of the cap and sends a DialLayerChangeEvent to all registered listeners.
voidsetRadius(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.

Constructor Detail

DialCap

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

Method Detail

clone

public Object clone()
Returns a clone of this instance.

Returns: A clone.

Throws: CloneNotSupportedException if some attribute of the cap cannot be cloned.

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.

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.

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

See Also: setFillPaint

getOutlinePaint

public Paint getOutlinePaint()
Returns the paint used to draw the outline of the cap.

Returns: The paint (never null).

See Also: setOutlinePaint

getOutlineStroke

public Stroke getOutlineStroke()
Returns the stroke used to draw the outline of the cap.

Returns: The stroke (never null).

See Also: setOutlineStroke

getRadius

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

Returns: The radius.

See Also: DialCap

hashCode

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

Returns: The hash code.

isClippedToWindow

public boolean isClippedToWindow()
Returns true to indicate that this layer should be clipped within the dial window.

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

See Also: getFillPaint

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

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

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