Package org.jfree.chart.plot.dial
Class DialBackground
- java.lang.Object
-
- org.jfree.chart.plot.dial.AbstractDialLayer
-
- org.jfree.chart.plot.dial.DialBackground
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,DialLayer
,PublicCloneable
public class DialBackground extends AbstractDialLayer implements DialLayer, java.lang.Cloneable, PublicCloneable, java.io.Serializable
A regular dial layer that can be used to draw the background for a dial.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private GradientPaintTransformer
gradientPaintTransformer
The transformer used when the background paint is an instance ofGradientPaint
.private java.awt.Paint
paint
The background paint.(package private) static long
serialVersionUID
For serialization.
-
Constructor Summary
Constructors Constructor Description DialBackground()
Creates a new instance ofDialBackground
.DialBackground(java.awt.Paint paint)
Creates a new instance ofDialBackground
.
-
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.GradientPaintTransformer
getGradientPaintTransformer()
Returns the transformer used to adjust the coordinates of anyGradientPaint
instance used for the background paint.java.awt.Paint
getPaint()
Returns the paint used to fill the background.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
setGradientPaintTransformer(GradientPaintTransformer t)
Sets the transformer used to adjust the coordinates of anyGradientPaint
instance used for the background paint, and sends aDialLayerChangeEvent
to all registered listeners.void
setPaint(java.awt.Paint paint)
Sets the paint for the dial background 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
-
paint
private transient java.awt.Paint paint
The background paint. This field is transient because serialization requires special handling.
-
gradientPaintTransformer
private GradientPaintTransformer gradientPaintTransformer
The transformer used when the background paint is an instance ofGradientPaint
.
-
-
Constructor Detail
-
DialBackground
public DialBackground()
Creates a new instance ofDialBackground
. The default background paint isColor.WHITE
.
-
DialBackground
public DialBackground(java.awt.Paint paint)
Creates a new instance ofDialBackground
.- Parameters:
paint
- the paint (null
not permitted).- Throws:
java.lang.IllegalArgumentException
- ifPaint
isnull
.
-
-
Method Detail
-
getPaint
public java.awt.Paint getPaint()
Returns the paint used to fill the background.- Returns:
- The paint (never
null
). - See Also:
setPaint(Paint)
-
setPaint
public void setPaint(java.awt.Paint paint)
Sets the paint for the dial background and sends aDialLayerChangeEvent
to all registered listeners.- Parameters:
paint
- the paint (null
not permitted).- See Also:
getPaint()
-
getGradientPaintTransformer
public GradientPaintTransformer getGradientPaintTransformer()
Returns the transformer used to adjust the coordinates of anyGradientPaint
instance used for the background paint.- Returns:
- The transformer (never
null
). - See Also:
setGradientPaintTransformer(GradientPaintTransformer)
-
setGradientPaintTransformer
public void setGradientPaintTransformer(GradientPaintTransformer t)
Sets the transformer used to adjust the coordinates of anyGradientPaint
instance used for the background paint, and sends aDialLayerChangeEvent
to all registered listeners.- Parameters:
t
- the transformer (null
not permitted).- See Also:
getGradientPaintTransformer()
-
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:
- The clone.
- Throws:
java.lang.CloneNotSupportedException
- if some attribute of this instance 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.
-
-