Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.jfree.chart.plot.dial

Class DialBackground

Implemented Interfaces:
Cloneable, DialLayer, PublicCloneable, Serializable
public class DialBackground
extends AbstractDialLayer
implements DialLayer, Cloneable, PublicCloneable, Serializable
A regular dial layer that can be used to draw the background for a dial.
Since:
1.0.7

Constructor Summary

DialBackground()
Creates a new instance of DialBackground.
DialBackground(Paint paint)
Creates a new instance of DialBackground.

Method Summary

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.
GradientPaintTransformer
getGradientPaintTransformer()
Returns the transformer used to adjust the coordinates of any GradientPaint instance used for the background paint.
Paint
getPaint()
Returns the paint used to fill the background.
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
setGradientPaintTransformer(GradientPaintTransformer t)
Sets the transformer used to adjust the coordinates of any GradientPaint instance used for the background paint, and sends a DialLayerChangeEvent to all registered listeners.
void
setPaint(Paint paint)
Sets the paint for the dial background and sends a DialLayerChangeEvent to all registered listeners.

Methods inherited from class org.jfree.chart.plot.dial.AbstractDialLayer

addChangeListener, clone, equals, hasListener, hashCode, isVisible, notifyListeners, removeChangeListener, setVisible

Constructor Details

DialBackground

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

DialBackground

public DialBackground(Paint paint)
Creates a new instance of DialBackground. The
Parameters:
paint - the paint (null not permitted).

Method Details

clone

public Object clone()
            throws CloneNotSupportedException
Returns a clone of this instance.
Overrides:
clone in interface AbstractDialLayer
Returns:
The clone.

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.
Specified by:
draw in interface DialLayer
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.
Overrides:
equals in interface AbstractDialLayer
Parameters:
obj - the object (null permitted).
Returns:
A boolean.

getGradientPaintTransformer

public GradientPaintTransformer getGradientPaintTransformer()
Returns the transformer used to adjust the coordinates of any GradientPaint instance used for the background paint.
Returns:
The transformer (never null).
See Also:
setGradientPaintTransformer(GradientPaintTransformer)

getPaint

public Paint getPaint()
Returns the paint used to fill the background.
Returns:
The paint (never null).
See Also:
setPaint(Paint)

hashCode

public int hashCode()
Returns a hash code for this instance.
Overrides:
hashCode in interface AbstractDialLayer
Returns:
The hash code.

isClippedToWindow

public boolean isClippedToWindow()
Returns true to indicate that this layer should be clipped within the dial window.
Specified by:
isClippedToWindow in interface DialLayer
Returns:
true.

setGradientPaintTransformer

public void setGradientPaintTransformer(GradientPaintTransformer t)
Sets the transformer used to adjust the coordinates of any GradientPaint instance used for the background paint, and sends a DialLayerChangeEvent to all registered listeners.
Parameters:
t - the transformer (null not permitted).
See Also:
getGradientPaintTransformer()

setPaint

public void setPaint(Paint paint)
Sets the paint for the dial background and sends a DialLayerChangeEvent to all registered listeners.
Parameters:
paint - the paint (null not permitted).
See Also:
getPaint()

Overview Package Class Use Source Tree Index Deprecated About