org.jfree.chart.plot.dial

Class DialTextAnnotation

Implemented Interfaces:
Cloneable, DialLayer, PublicCloneable, Serializable

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

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, clone, equals, hasListener, hashCode, isVisible, notifyListeners, removeChangeListener, setVisible

Constructor Details

DialTextAnnotation

public DialTextAnnotation(String label)
Creates a new instance of DialTextAnnotation.
Parameters:
label - the label (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.

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.

getAngle

public double getAngle()
Returns the angle used to calculate the anchor point.
Returns:
The angle (in degrees).

getFont

public Font getFont()
Returns the font used to display the label.
Returns:
The font (never null).
See Also:
setFont(Font)

getLabel

public String getLabel()
Returns the label text.
Returns:
The label text (never null

getPaint

public Paint getPaint()
Returns the paint used to display the label.
Returns:
The paint (never null).

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.

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.

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

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