Module org.jfree.chart

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:

Serializable, Cloneable, PublicCloneable, DialLayer

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.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
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, 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

Constructor Detail

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.

Parameters:

paint - the paint (null not permitted).

Throws:

IllegalArgumentException - if Paint is null.

Method Detail

getPaint

public Paint getPaint()

Returns the paint used to fill the background.

Returns:

The paint (never null).

See Also:

setPaint(Paint)

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

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)

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

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.

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 class AbstractDialLayer

Parameters:

obj - the object (null permitted).

Returns:

A boolean.

hashCode

public int hashCode()

Returns a hash code for this instance.

Overrides:

hashCode in class AbstractDialLayer

Returns:

The hash code.

clone

public Object clone()
             throws CloneNotSupportedException

Returns a clone of this instance.

Specified by:

clone in interface PublicCloneable

Overrides:

clone in class AbstractDialLayer

Returns:

The clone.

Throws:

CloneNotSupportedException - if some attribute of this instance cannot be cloned.