Package org.jfree.chart.annotations
Class XYTextAnnotation
java.lang.Object
org.jfree.chart.annotations.AbstractAnnotation
org.jfree.chart.annotations.AbstractXYAnnotation
org.jfree.chart.annotations.XYTextAnnotation
- All Implemented Interfaces:
Serializable,Cloneable,Annotation,XYAnnotation,PublicCloneable
- Direct Known Subclasses:
XYNoteAnnotation,XYPointerAnnotation
public class XYTextAnnotation
extends AbstractXYAnnotation
implements Cloneable, PublicCloneable, Serializable
A text annotation that can be placed at a particular (x, y) location on an
XYPlot.- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate PaintThe background paint (possibly null).static final FontThe default font.static final PaintThe default paint.static final TextAnchorThe default rotation anchor.static final doubleThe default rotation angle.static final TextAnchorThe default text anchor.private FontThe font.private PaintThe outline paint (never null).private StrokeThe outline stroke (never null).private booleanThe flag that controls the visibility of the outline.private PaintThe paint.private TextAnchorThe rotation anchor.private doubleThe rotation angle.private static final longFor serialization.private StringThe text.private TextAnchorThe text anchor (to be aligned with (x, y)).private doubleThe x-coordinate.private doubleThe y-coordinate. -
Constructor Summary
ConstructorsConstructorDescriptionXYTextAnnotation(String text, double x, double y) Creates a new annotation to be displayed at the given coordinates. -
Method Summary
Modifier and TypeMethodDescriptionbooleanEnsures symmetry between super/subclass implementations of equals.clone()Returns a clone of the annotation.voiddraw(Graphics2D g2, XYPlot plot, Rectangle2D dataArea, ValueAxis domainAxis, ValueAxis rangeAxis, int rendererIndex, PlotRenderingInfo info) Draws the annotation.booleanTests this annotation for equality with an arbitrary object.Returns the background paint for the annotation.getFont()Returns the font for the annotation.Returns the outline paint for the annotation.Returns the outline stroke for the annotation.getPaint()Returns the paint for the annotation.Returns the rotation anchor.doubleReturns the rotation angle.getText()Returns the text for the annotation.Returns the text anchor.doublegetX()Returns the x coordinate for the text anchor point (measured against the domain axis).doublegetY()Returns the y coordinate for the text anchor point (measured against the range axis).inthashCode()Returns a hash code for the object.booleanReturns the flag that controls whether or not the outline is drawn.private voidreadObject(ObjectInputStream stream) Provides serialization support.voidsetBackgroundPaint(Paint paint) Sets the background paint for the annotation and sends anAnnotationChangeEventto all registered listeners.voidSets the font for the annotation and sends anAnnotationChangeEventto all registered listeners.voidsetOutlinePaint(Paint paint) Sets the outline paint for the annotation and sends anAnnotationChangeEventto all registered listeners.voidsetOutlineStroke(Stroke stroke) Sets the outline stroke for the annotation and sends anAnnotationChangeEventto all registered listeners.voidsetOutlineVisible(boolean visible) Sets the flag that controls whether or not the outline is drawn and sends anAnnotationChangeEventto all registered listeners.voidSets the paint for the annotation and sends anAnnotationChangeEventto all registered listeners.voidsetRotationAnchor(TextAnchor anchor) Sets the rotation anchor point and sends anAnnotationChangeEventto all registered listeners.voidsetRotationAngle(double angle) Sets the rotation angle and sends anAnnotationChangeEventto all registered listeners.voidSets the text for the annotation.voidsetTextAnchor(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 anAnnotationChangeEventto all registered listeners.voidsetX(double x) Sets the x coordinate for the text anchor point (measured against the domain axis) and sends anAnnotationChangeEventto all registered listeners.voidsetY(double y) Sets the y coordinate for the text anchor point (measured against the range axis) and sends anAnnotationChangeEventto all registered listeners.private voidwriteObject(ObjectOutputStream stream) Provides serialization support.Methods inherited from class org.jfree.chart.annotations.AbstractXYAnnotation
addEntity, getToolTipText, getURL, setToolTipText, setURLMethods inherited from class org.jfree.chart.annotations.AbstractAnnotation
addChangeListener, fireAnnotationChanged, getNotify, hasListener, notifyListeners, removeChangeListener, setNotifyMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface org.jfree.chart.annotations.Annotation
addChangeListener, removeChangeListener
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDFor serialization.- See Also:
-
DEFAULT_FONT
The default font. -
DEFAULT_PAINT
The default paint. -
DEFAULT_TEXT_ANCHOR
The default text anchor. -
DEFAULT_ROTATION_ANCHOR
The default rotation anchor. -
DEFAULT_ROTATION_ANGLE
public static final double DEFAULT_ROTATION_ANGLEThe default rotation angle.- See Also:
-
text
The text. -
font
The font. -
paint
The paint. -
x
private double xThe x-coordinate. -
y
private double yThe y-coordinate. -
textAnchor
The text anchor (to be aligned with (x, y)). -
rotationAnchor
The rotation anchor. -
rotationAngle
private double rotationAngleThe rotation angle. -
backgroundPaint
The background paint (possibly null). -
outlineVisible
private boolean outlineVisibleThe flag that controls the visibility of the outline. -
outlinePaint
The outline paint (never null). -
outlineStroke
The outline stroke (never null).
-
-
Constructor Details
-
XYTextAnnotation
Creates a new annotation to be displayed at the given coordinates. The coordinates are specified in data space (they will be converted to Java2D space for display).- Parameters:
text- the text (nullnot permitted).x- the x-coordinate (in data space, must be finite).y- the y-coordinate (in data space, must be finite).
-
-
Method Details
-
getText
Returns the text for the annotation.- Returns:
- The text (never
null). - See Also:
-
setText
Sets the text for the annotation.- Parameters:
text- the text (nullnot permitted).- See Also:
-
getFont
Returns the font for the annotation.- Returns:
- The font (never
null). - See Also:
-
setFont
Sets the font for the annotation and sends anAnnotationChangeEventto all registered listeners.- Parameters:
font- the font (nullnot permitted).- See Also:
-
getPaint
Returns the paint for the annotation.- Returns:
- The paint (never
null). - See Also:
-
setPaint
Sets the paint for the annotation and sends anAnnotationChangeEventto all registered listeners.- Parameters:
paint- the paint (nullnot permitted).- See Also:
-
getTextAnchor
Returns the text anchor.- Returns:
- The text anchor (never
null). - See Also:
-
setTextAnchor
Sets the text anchor (the point on the text bounding rectangle that is aligned to the (x, y) coordinate of the annotation) and sends anAnnotationChangeEventto all registered listeners.- Parameters:
anchor- the anchor point (nullnot permitted).- See Also:
-
getRotationAnchor
Returns the rotation anchor.- Returns:
- The rotation anchor point (never
null). - See Also:
-
setRotationAnchor
Sets the rotation anchor point and sends anAnnotationChangeEventto all registered listeners.- Parameters:
anchor- the anchor (nullnot permitted).- See Also:
-
getRotationAngle
public double getRotationAngle()Returns the rotation angle.- Returns:
- The rotation angle.
- See Also:
-
setRotationAngle
public void setRotationAngle(double angle) Sets the rotation angle and sends anAnnotationChangeEventto all registered listeners. The angle is measured clockwise in radians.- Parameters:
angle- the angle (in radians).- See Also:
-
getX
public double getX()Returns the x coordinate for the text anchor point (measured against the domain axis).- Returns:
- The x coordinate (in data space).
- See Also:
-
setX
public void setX(double x) Sets the x coordinate for the text anchor point (measured against the domain axis) and sends anAnnotationChangeEventto all registered listeners.- Parameters:
x- the x coordinate (in data space).- See Also:
-
getY
public double getY()Returns the y coordinate for the text anchor point (measured against the range axis).- Returns:
- The y coordinate (in data space).
- See Also:
-
setY
public void setY(double y) Sets the y coordinate for the text anchor point (measured against the range axis) and sends anAnnotationChangeEventto all registered listeners.- Parameters:
y- the y coordinate.- See Also:
-
getBackgroundPaint
Returns the background paint for the annotation.- Returns:
- The background paint (possibly
null). - See Also:
-
setBackgroundPaint
Sets the background paint for the annotation and sends anAnnotationChangeEventto all registered listeners.- Parameters:
paint- the paint (nullpermitted).- See Also:
-
getOutlinePaint
Returns the outline paint for the annotation.- Returns:
- The outline paint (never
null). - See Also:
-
setOutlinePaint
Sets the outline paint for the annotation and sends anAnnotationChangeEventto all registered listeners.- Parameters:
paint- the paint (nullnot permitted).- See Also:
-
getOutlineStroke
Returns the outline stroke for the annotation.- Returns:
- The outline stroke (never
null). - See Also:
-
setOutlineStroke
Sets the outline stroke for the annotation and sends anAnnotationChangeEventto all registered listeners.- Parameters:
stroke- the stroke (nullnot permitted).- See Also:
-
isOutlineVisible
public boolean isOutlineVisible()Returns the flag that controls whether or not the outline is drawn.- Returns:
- A boolean.
-
setOutlineVisible
public void setOutlineVisible(boolean visible) Sets the flag that controls whether or not the outline is drawn and sends anAnnotationChangeEventto all registered listeners.- Parameters:
visible- the new flag value.
-
draw
public void draw(Graphics2D g2, XYPlot plot, Rectangle2D dataArea, ValueAxis domainAxis, ValueAxis rangeAxis, int rendererIndex, PlotRenderingInfo info) Draws the annotation.- Specified by:
drawin interfaceXYAnnotation- Specified by:
drawin classAbstractXYAnnotation- Parameters:
g2- the graphics device.plot- the plot.dataArea- the data area.domainAxis- the domain axis.rangeAxis- the range axis.rendererIndex- the renderer index.info- an optional info object that will be populated with entity information.
-
equals
Tests this annotation for equality with an arbitrary object.- Overrides:
equalsin classAbstractXYAnnotation- Parameters:
obj- the object (nullpermitted).- Returns:
- A boolean.
-
canEqual
Ensures symmetry between super/subclass implementations of equals. For more detail, see http://jqno.nl/equalsverifier/manual/inheritance.- Overrides:
canEqualin classAbstractXYAnnotation- Parameters:
other- Object- Returns:
- true ONLY if the parameter is THIS class type
-
hashCode
public int hashCode()Returns a hash code for the object.- Overrides:
hashCodein classAbstractXYAnnotation- Returns:
- A hash code.
-
clone
Returns a clone of the annotation.- Specified by:
clonein interfacePublicCloneable- Overrides:
clonein classAbstractAnnotation- Returns:
- A clone.
- Throws:
CloneNotSupportedException- if the annotation can't be cloned.
-
writeObject
Provides serialization support.- Parameters:
stream- the output stream.- Throws:
IOException- if there is an I/O error.
-
readObject
Provides serialization support.- Parameters:
stream- the input stream.- Throws:
IOException- if there is an I/O error.ClassNotFoundException- if there is a classpath problem.
-