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:
java.io.Serializable
,java.lang.Cloneable
,DialLayer
,PublicCloneable
public class DialCap extends AbstractDialLayer implements DialLayer, java.lang.Cloneable, PublicCloneable, java.io.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
-
-
Field Summary
Fields Modifier and Type Field Description private java.awt.Paint
fillPaint
The fill paint.private java.awt.Paint
outlinePaint
The paint used to draw the cap outline (this should never benull
).private java.awt.Stroke
outlineStroke
The stroke used to draw the cap outline (this should never benull
).private double
radius
The radius of the cap, as a percentage of the framing rectangle.(package private) static long
serialVersionUID
For serialization.
-
Constructor Summary
Constructors Constructor Description DialCap()
Creates a new instance ofStandardDialBackground
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
Returns a clone of this instance.void
draw(java.awt.Graphics2D g2, DialPlot plot, java.awt.geom.Rectangle2D frame, java.awt.geom.Rectangle2D view)
Draws the background to the specified graphics device.boolean
equals(java.lang.Object obj)
Tests this instance for equality with an arbitrary object.java.awt.Paint
getFillPaint()
Returns the paint used to fill the cap.java.awt.Paint
getOutlinePaint()
Returns the paint used to draw the outline of the cap.java.awt.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()
Returnstrue
to indicate that this layer should be clipped within the dial window.private void
readObject(java.io.ObjectInputStream stream)
Provides serialization support.void
setFillPaint(java.awt.Paint paint)
Sets the paint for the cap background and sends aDialLayerChangeEvent
to all registered listeners.void
setOutlinePaint(java.awt.Paint paint)
Sets the paint used to draw the outline of the cap and sends aDialLayerChangeEvent
to all registered listeners.void
setOutlineStroke(java.awt.Stroke stroke)
Sets the stroke used to draw the outline of the cap and sends aDialLayerChangeEvent
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 aDialLayerChangeEvent
to all registered listeners.private void
writeObject(java.io.ObjectOutputStream stream)
Provides serialization support.-
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
-
-
-
-
Field Detail
-
serialVersionUID
static final long serialVersionUID
For serialization.- See Also:
- Constant Field Values
-
radius
private double radius
The radius of the cap, as a percentage of the framing rectangle.
-
fillPaint
private transient java.awt.Paint fillPaint
The fill paint. This field is transient because it requires special handling for serialization.
-
outlinePaint
private transient java.awt.Paint 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
private transient java.awt.Stroke outlineStroke
The stroke used to draw the cap outline (this should never benull
). This field is transient because it requires special handling for serialization.
-
-
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 aDialLayerChangeEvent
to all registered listeners.- Parameters:
radius
- the radius (must be greater than zero).- See Also:
getRadius()
-
getFillPaint
public java.awt.Paint getFillPaint()
Returns the paint used to fill the cap.- Returns:
- The paint (never
null
). - See Also:
setFillPaint(Paint)
-
setFillPaint
public void setFillPaint(java.awt.Paint paint)
Sets the paint for the cap background and sends aDialLayerChangeEvent
to all registered listeners.- Parameters:
paint
- the paint (null
not permitted).- See Also:
getFillPaint()
-
getOutlinePaint
public java.awt.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(java.awt.Paint paint)
Sets the paint used to draw the outline of the cap and sends aDialLayerChangeEvent
to all registered listeners.- Parameters:
paint
- the paint (null
not permitted).- See Also:
getOutlinePaint()
-
getOutlineStroke
public java.awt.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(java.awt.Stroke stroke)
Sets the stroke used to draw the outline of the cap and sends aDialLayerChangeEvent
to all registered listeners.- Parameters:
stroke
- the stroke (null
not permitted).- See Also:
getOutlineStroke()
-
isClippedToWindow
public boolean isClippedToWindow()
Returnstrue
to indicate that this layer should be clipped within the dial window.- Specified by:
isClippedToWindow
in interfaceDialLayer
- Returns:
true
.
-
draw
public void draw(java.awt.Graphics2D g2, DialPlot plot, java.awt.geom.Rectangle2D frame, java.awt.geom.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.
-
equals
public boolean equals(java.lang.Object obj)
Tests this instance for equality with an arbitrary object.- Overrides:
equals
in classAbstractDialLayer
- Parameters:
obj
- the object (null
permitted).- Returns:
- A boolean.
-
hashCode
public int hashCode()
Returns a hash code for this instance.- Overrides:
hashCode
in classAbstractDialLayer
- Returns:
- The hash code.
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
Returns a clone of this instance.- Specified by:
clone
in interfacePublicCloneable
- Overrides:
clone
in classAbstractDialLayer
- Returns:
- A clone.
- Throws:
java.lang.CloneNotSupportedException
- if some attribute of the cap cannot be cloned.
-
writeObject
private void writeObject(java.io.ObjectOutputStream stream) throws java.io.IOException
Provides serialization support.- Parameters:
stream
- the output stream.- Throws:
java.io.IOException
- if there is an I/O error.
-
readObject
private void readObject(java.io.ObjectInputStream stream) throws java.io.IOException, java.lang.ClassNotFoundException
Provides serialization support.- Parameters:
stream
- the input stream.- Throws:
java.io.IOException
- if there is an I/O error.java.lang.ClassNotFoundException
- if there is a classpath problem.
-
-