org.jfree.chart.plot.dial

Class DialTextAnnotation

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

A text annotation for a DialPlot.

Since: 1.0.7

Constructor Summary
DialTextAnnotation(String label)
Creates a new instance of DialTextAnnotation.
Method Summary
Objectclone()
Returns a clone of this instance.
voiddraw(Graphics2D g2, DialPlot plot, Rectangle2D frame, Rectangle2D view)
Draws the background to the specified graphics device.
booleanequals(Object obj)
Tests this instance for equality with an arbitrary object.
TextAnchorgetAnchor()
Returns the text anchor point that will be aligned to the position specified by getAngle and getRadius.
doublegetAngle()
Returns the angle used to calculate the anchor point.
FontgetFont()
Returns the font used to display the label.
StringgetLabel()
Returns the label text.
PaintgetPaint()
Returns the paint used to display the label.
doublegetRadius()
Returns the radius used to calculate the anchor point.
inthashCode()
Returns a hash code for this instance.
booleanisClippedToWindow()
Returns true to indicate that this layer should be clipped within the dial window.
voidsetAnchor(TextAnchor anchor)
Sets the text anchor point and sends a DialLayerChangeEvent to all registered listeners.
voidsetAngle(double angle)
Sets the angle used to calculate the anchor point and sends a DialLayerChangeEvent to all registered listeners.
voidsetFont(Font font)
Sets the font used to display the label and sends a DialLayerChangeEvent to all registered listeners.
voidsetLabel(String label)
Sets the label and sends a DialLayerChangeEvent to all registered listeners.
voidsetPaint(Paint paint)
Sets the paint used to display the label and sends a DialLayerChangeEvent to all registered listeners.
voidsetRadius(double radius)
Sets the radius used to calculate the anchor point and sends a DialLayerChangeEvent to all registered listeners.

Constructor Detail

DialTextAnnotation

public DialTextAnnotation(String label)
Creates a new instance of DialTextAnnotation.

Parameters: label the label (null not permitted).

Method Detail

clone

public Object clone()
Returns a clone of this instance.

Returns: The clone.

Throws: CloneNotSupportedException if some attribute of this instance cannot be cloned.

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.

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.

Parameters: obj the object (null permitted).

Returns: A boolean.

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

getAngle

public double getAngle()
Returns the angle used to calculate the anchor point.

Returns: The angle (in degrees).

See Also: DialTextAnnotation getRadius

getFont

public Font getFont()
Returns the font used to display the label.

Returns: The font (never null).

See Also: setFont

getLabel

public String getLabel()
Returns the label text.

Returns: The label text (never null

See Also: setLabel

getPaint

public Paint getPaint()
Returns the paint used to display the label.

Returns: The paint (never null).

See Also: setPaint

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: DialTextAnnotation getAngle

hashCode

public int hashCode()
Returns a hash code for this instance.

Returns: The hash code.

isClippedToWindow

public boolean isClippedToWindow()
Returns true to indicate that this layer should be clipped within the dial window.

Returns: true.

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

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 DialTextAnnotation

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

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

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

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 DialTextAnnotation

Copyright © 2000-2009 by Object Refinery Limited. All Rights Reserved.