Module org.jfree.chart

Package org.jfree.chart.plot.dial

Class DialTextAnnotation

java.lang.Object

org.jfree.chart.plot.dial.AbstractDialLayer

org.jfree.chart.plot.dial.DialTextAnnotation

All Implemented Interfaces:

Serializable, Cloneable, PublicCloneable, DialLayer

public class DialTextAnnotation
extends AbstractDialLayer
implements DialLayer, Cloneable, PublicCloneable, Serializable

A text annotation for a DialPlot.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DialTextAnnotation(String label)	Creates a new instance of DialTextAnnotation.

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.
TextAnchor	getAnchor()	Returns the text anchor point that will be aligned to the position specified by getAngle() and getRadius().
double	getAngle()	Returns the angle used to calculate the anchor point.
Font	getFont()	Returns the font used to display the label.
String	getLabel()	Returns the label text.
Paint	getPaint()	Returns the paint used to display the label.
double	getRadius()	Returns the radius used to calculate the anchor point.
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	setAnchor(TextAnchor anchor)	Sets the text anchor point and sends a DialLayerChangeEvent to all registered listeners.
void	setAngle(double angle)	Sets the angle used to calculate the anchor point and sends a DialLayerChangeEvent to all registered listeners.
void	setFont(Font font)	Sets the font used to display the label and sends a DialLayerChangeEvent to all registered listeners.
void	setLabel(String label)	Sets the label and sends a DialLayerChangeEvent to all registered listeners.
void	setPaint(Paint paint)	Sets the paint used to display the label and sends a DialLayerChangeEvent to all registered listeners.
void	setRadius(double radius)	Sets the radius used to calculate the anchor point 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

DialTextAnnotation

public DialTextAnnotation(String label)

Creates a new instance of DialTextAnnotation.

Parameters:

label - the label (null not permitted).

Method Detail

getLabel

public String getLabel()

Returns the label text.

Returns:

The label text (never null).

See Also:

setLabel(String)

setLabel

public void setLabel(String label)

Sets the label and sends a DialLayerChangeEvent to all registered listeners.

Parameters:

label - the label (null not permitted).

See Also:

getLabel()

getFont

public Font getFont()

Returns the font used to display the label.

Returns:

The font (never null).

See Also:

setFont(Font)

setFont

public void setFont(Font font)

Sets the font used to display the label and sends a DialLayerChangeEvent to all registered listeners.

Parameters:

font - the font (null not permitted).

See Also:

getFont()

getPaint

public Paint getPaint()

Returns the paint used to display the label.

Returns:

The paint (never null).

See Also:

setPaint(Paint)

setPaint

public void setPaint(Paint paint)

Sets the paint used to display the label and sends a DialLayerChangeEvent to all registered listeners.

Parameters:

paint - the paint (null not permitted).

See Also:

getPaint()

getAngle

public double getAngle()

Returns the angle used to calculate the anchor point.

Returns:

The angle (in degrees).

See Also:

setAngle(double), getRadius()

setAngle

public void setAngle(double angle)

Sets the angle used to calculate the anchor point and sends a DialLayerChangeEvent to all registered listeners.

Parameters:

angle - the angle (in degrees).

See Also:

getAngle(), setRadius(double)

getRadius

public double getRadius()

Returns the radius used to calculate the anchor point. This is specified as a percentage relative to the dial's framing rectangle.

Returns:

The radius.

See Also:

setRadius(double), getAngle()

setRadius

public void setRadius(double radius)

Sets the radius used to calculate the anchor point and sends a DialLayerChangeEvent to all registered listeners.

Parameters:

radius - the radius (as a percentage of the dial's framing rectangle).

See Also:

getRadius(), setAngle(double)

getAnchor

public TextAnchor getAnchor()

Returns the text anchor point that will be aligned to the position specified by getAngle() and getRadius().

Returns:

The anchor point.

See Also:

setAnchor(TextAnchor)

setAnchor

public void setAnchor(TextAnchor anchor)

Sets the text anchor point and sends a DialLayerChangeEvent to all registered listeners.

Parameters:

anchor - the anchor point (null not permitted).

See Also:

getAnchor()

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.