public class

DialCap

extends AbstractDialLayer
implements Serializable Cloneable DialLayer
java.lang.Object
   ↳ org.jfree.chart.plot.dial.AbstractDialLayer
     ↳ org.jfree.chart.plot.dial.DialCap

Class Overview

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

Summary

Public Constructors
DialCap()
Creates a new instance of StandardDialBackground.
Public Methods
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.
[Expand]
Inherited Methods
From class org.jfree.chart.plot.dial.AbstractDialLayer
From class java.lang.Object
From interface org.jfree.chart.plot.dial.DialLayer

Public Constructors

public DialCap ()

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

Public Methods

public Object clone ()

Returns a clone of this instance.

Returns
  • A clone.
Throws
CloneNotSupportedException if some attribute of the cap cannot be cloned.

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

public boolean equals (Object obj)

Tests this instance for equality with an arbitrary object.

Parameters
obj the object (null permitted).
Returns
  • A boolean.

public Paint getFillPaint ()

Returns the paint used to fill the cap.

Returns
  • The paint (never null).
See Also

public Paint getOutlinePaint ()

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

Returns
  • The paint (never null).
See Also

public Stroke getOutlineStroke ()

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

Returns
  • The stroke (never null).
See Also

public double getRadius ()

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

Returns
  • The radius.
See Also

public int hashCode ()

Returns a hash code for this instance.

Returns
  • The hash code.

public boolean isClippedToWindow ()

Returns true to indicate that this layer should be clipped within the dial window.

Returns
  • true.

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

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

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

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