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,DialLayer,PublicCloneable
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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate PaintThe fill paint.private PaintThe paint used to draw the cap outline (this should never benull).private StrokeThe stroke used to draw the cap outline (this should never benull).private doubleThe radius of the cap, as a percentage of the framing rectangle.(package private) static final longFor serialization. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()Returns a clone of this instance.voiddraw(Graphics2D g2, DialPlot plot, Rectangle2D frame, Rectangle2D view) Draws the background to the specified graphics device.booleanTests this instance for equality with an arbitrary object.Returns the paint used to fill the cap.Returns the paint used to draw the outline of the cap.Returns the stroke used to draw the outline of the cap.doubleReturns the radius of the cap, as a percentage of the dial's framing rectangle.inthashCode()Returns a hash code for this instance.booleanReturnstrueto indicate that this layer should be clipped within the dial window.private voidreadObject(ObjectInputStream stream) Provides serialization support.voidsetFillPaint(Paint paint) Sets the paint for the cap background and sends aDialLayerChangeEventto all registered listeners.voidsetOutlinePaint(Paint paint) Sets the paint used to draw the outline of the cap and sends aDialLayerChangeEventto all registered listeners.voidsetOutlineStroke(Stroke stroke) Sets the stroke used to draw the outline of the cap and sends aDialLayerChangeEventto all registered listeners.voidsetRadius(double radius) Sets the radius of the cap, as a percentage of the dial's framing rectangle, and sends aDialLayerChangeEventto all registered listeners.private voidwriteObject(ObjectOutputStream stream) Provides serialization support.Methods inherited from class org.jfree.chart.plot.dial.AbstractDialLayer
addChangeListener, hasListener, isVisible, notifyListeners, removeChangeListener, setVisibleMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.jfree.chart.plot.dial.DialLayer
addChangeListener, hasListener, isVisible, removeChangeListener
-
Field Details
-
serialVersionUID
static final long serialVersionUIDFor serialization.- See Also:
-
radius
private double radiusThe radius of the cap, as a percentage of the framing rectangle. -
fillPaint
The fill paint. This field is transient because it requires special handling for serialization. -
outlinePaint
The paint used to draw the cap outline (this should never benull). This field is transient because it requires special handling for serialization. -
outlineStroke
The stroke used to draw the cap outline (this should never benull). This field is transient because it requires special handling for serialization.
-
-
Constructor Details
-
DialCap
public DialCap()Creates a new instance ofStandardDialBackground. The default background paint isColor.WHITE.
-
-
Method Details
-
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
public void setRadius(double radius) Sets the radius of the cap, as a percentage of the dial's framing rectangle, and sends aDialLayerChangeEventto all registered listeners.- Parameters:
radius- the radius (must be greater than zero).- See Also:
-
getFillPaint
Returns the paint used to fill the cap.- Returns:
- The paint (never
null). - See Also:
-
setFillPaint
Sets the paint for the cap background and sends aDialLayerChangeEventto all registered listeners.- Parameters:
paint- the paint (nullnot permitted).- See Also:
-
getOutlinePaint
Returns the paint used to draw the outline of the cap.- Returns:
- The paint (never
null). - See Also:
-
setOutlinePaint
Sets the paint used to draw the outline of the cap and sends aDialLayerChangeEventto all registered listeners.- Parameters:
paint- the paint (nullnot permitted).- See Also:
-
getOutlineStroke
Returns the stroke used to draw the outline of the cap.- Returns:
- The stroke (never
null). - See Also:
-
setOutlineStroke
Sets the stroke used to draw the outline of the cap and sends aDialLayerChangeEventto all registered listeners.- Parameters:
stroke- the stroke (nullnot permitted).- See Also:
-
isClippedToWindow
public boolean isClippedToWindow()Returnstrueto indicate that this layer should be clipped within the dial window.- Specified by:
isClippedToWindowin interfaceDialLayer- Returns:
true.
-
draw
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. -
equals
Tests this instance for equality with an arbitrary object.- Overrides:
equalsin classAbstractDialLayer- Parameters:
obj- the object (nullpermitted).- Returns:
- A boolean.
-
hashCode
public int hashCode()Returns a hash code for this instance.- Overrides:
hashCodein classAbstractDialLayer- Returns:
- The hash code.
-
clone
Returns a clone of this instance.- Specified by:
clonein interfacePublicCloneable- Overrides:
clonein classAbstractDialLayer- Returns:
- A clone.
- Throws:
CloneNotSupportedException- if some attribute of the cap cannot be cloned.
-
writeObject
Provides serialization support.- Parameters:
stream- the output stream.- Throws:
IOException- if there is an I/O error.
-
readObject
Provides serialization support.- Parameters:
stream- the input stream.- Throws:
IOException- if there is an I/O error.ClassNotFoundException- if there is a classpath problem.
-