Package org.jfree.chart.annotations

Class TextAnnotation

java.lang.Object

org.jfree.chart.annotations.AbstractAnnotation

org.jfree.chart.annotations.TextAnnotation

All Implemented Interfaces:

Serializable, Cloneable, Annotation

Direct Known Subclasses:

CategoryTextAnnotation

public class TextAnnotation
extends AbstractAnnotation
implements Serializable

A base class for text annotations. This class records the content but not the location of the annotation.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final Font	DEFAULT_FONT	The default font.
static final Paint	DEFAULT_PAINT	The default paint.
static final TextAnchor	DEFAULT_ROTATION_ANCHOR	The default rotation anchor.
static final double	DEFAULT_ROTATION_ANGLE	The default rotation angle.
static final TextAnchor	DEFAULT_TEXT_ANCHOR	The default text anchor.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	TextAnnotation(String text)	Creates a text annotation with default settings.

Method Summary

Modifier and Type	Method	Description
boolean	canEqual(Object other)	Ensures symmetry between super/subclass implementations of equals.
boolean	equals(Object obj)	Tests this object for equality with an arbitrary object.
Font	getFont()	Returns the font for the annotation.
Paint	getPaint()	Returns the paint for the annotation.
TextAnchor	getRotationAnchor()	Returns the rotation anchor.
double	getRotationAngle()	Returns the rotation angle in radians.
String	getText()	Returns the text for the annotation.
TextAnchor	getTextAnchor()	Returns the text anchor.
int	hashCode()	Returns a hash code for this instance.
void	setFont(Font font)	Sets the font for the annotation and sends an AnnotationChangeEvent to all registered listeners.
void	setPaint(Paint paint)	Sets the paint for the annotation and sends an AnnotationChangeEvent to all registered listeners.
void	setRotationAnchor(TextAnchor anchor)	Sets the rotation anchor point and sends an AnnotationChangeEvent to all registered listeners.
void	setRotationAngle(double angle)	Sets the rotation angle and sends an AnnotationChangeEvent to all registered listeners.
void	setText(String text)	Sets the text for the annotation and sends an AnnotationChangeEvent to all registered listeners.
void	setTextAnchor(TextAnchor anchor)	Sets the text anchor (the point on the text bounding rectangle that is aligned to the (x, y) coordinate of the annotation) and sends an AnnotationChangeEvent to all registered listeners.

Methods inherited from class org.jfree.chart.annotations.AbstractAnnotation

addChangeListener, clone, fireAnnotationChanged, getNotify, hasListener, notifyListeners, removeChangeListener, setNotify

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_FONT

public static final Font DEFAULT_FONT

The default font.

DEFAULT_PAINT

public static final Paint DEFAULT_PAINT

The default paint.

DEFAULT_TEXT_ANCHOR

public static final TextAnchor DEFAULT_TEXT_ANCHOR

The default text anchor.

DEFAULT_ROTATION_ANCHOR

public static final TextAnchor DEFAULT_ROTATION_ANCHOR

The default rotation anchor.

DEFAULT_ROTATION_ANGLE

public static final double DEFAULT_ROTATION_ANGLE

The default rotation angle.

See Also:

• Constant Field Values

Constructor Details

TextAnnotation

protected TextAnnotation(String text)

Creates a text annotation with default settings.

Parameters:

text - the text (null not permitted).

Method Details

getText

public String getText()

Returns the text for the annotation.

Returns:

The text (never null).

See Also:

• setText(String)

setText

public void setText(String text)

Sets the text for the annotation and sends an AnnotationChangeEvent to all registered listeners.

Parameters:

text - the text (null not permitted).

See Also:

• getText()

getFont

public Font getFont()

Returns the font for the annotation.

Returns:

The font (never null).

See Also:

• setFont(Font)

setFont

public void setFont(Font font)

Sets the font for the annotation and sends an AnnotationChangeEvent to all registered listeners.

Parameters:

font - the font (null not permitted).

See Also:

• getFont()

getPaint

public Paint getPaint()

Returns the paint for the annotation.

Returns:

The paint (never null).

See Also:

• setPaint(Paint)

setPaint

public void setPaint(Paint paint)

Sets the paint for the annotation and sends an AnnotationChangeEvent to all registered listeners.

Parameters:

paint - the paint (null not permitted).

See Also:

• getPaint()

getTextAnchor

public TextAnchor getTextAnchor()

Returns the text anchor.

Returns:

The text anchor.

See Also:

• setTextAnchor(TextAnchor)

setTextAnchor

public void setTextAnchor(TextAnchor anchor)

Sets the text anchor (the point on the text bounding rectangle that is aligned to the (x, y) coordinate of the annotation) and sends an AnnotationChangeEvent to all registered listeners.

Parameters:

anchor - the anchor point (null not permitted).

See Also:

• getTextAnchor()

getRotationAnchor

public TextAnchor getRotationAnchor()

Returns the rotation anchor.

Returns:

The rotation anchor point (never null).

See Also:

• setRotationAnchor(TextAnchor)

setRotationAnchor

public void setRotationAnchor(TextAnchor anchor)

Sets the rotation anchor point and sends an AnnotationChangeEvent to all registered listeners.

Parameters:

anchor - the anchor (null not permitted).

See Also:

• getRotationAnchor()

getRotationAngle

public double getRotationAngle()

Returns the rotation angle in radians.

Returns:

The rotation angle.

See Also:

• setRotationAngle(double)

setRotationAngle

public void setRotationAngle(double angle)

Sets the rotation angle and sends an AnnotationChangeEvent to all registered listeners. The angle is measured clockwise in radians.

Parameters:

angle - the angle (in radians).

See Also:

• getRotationAngle()

equals

public boolean equals(Object obj)

Tests this object for equality with an arbitrary object.

Overrides:

equals in class AbstractAnnotation

Parameters:

obj - the object (null permitted).

Returns:

true or false.

canEqual

public boolean canEqual(Object other)

Ensures symmetry between super/subclass implementations of equals. For more detail, see http://jqno.nl/equalsverifier/manual/inheritance.

Overrides:

canEqual in class AbstractAnnotation

Parameters:

other - Object

Returns:

true ONLY if the parameter is THIS class type

hashCode

public int hashCode()

Returns a hash code for this instance.

Overrides:

hashCode in class AbstractAnnotation

Returns:

A hash code.