Package org.jfree.chart.annotations

Class XYNoteAnnotation

java.lang.Object

org.jfree.chart.annotations.AbstractAnnotation

org.jfree.chart.annotations.AbstractXYAnnotation

org.jfree.chart.annotations.XYTextAnnotation

org.jfree.chart.annotations.XYNoteAnnotation

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Annotation, XYAnnotation, PublicCloneable

public class XYNoteAnnotation
extends XYTextAnnotation
implements java.lang.Cloneable, PublicCloneable, java.io.Serializable

An line and label that can be placed on an XYPlot. The line is drawn at a user-definable angle so that it points towards the (x, y) location for the annotation.

The line length (and its offset from the (x, y) location) is controlled by the tip radius and the base radius attributes. Imagine two circles around the (x, y) coordinate: the inner circle defined by the tip radius, and the outer circle defined by the base radius. Now, draw the line starting at some point on the outer circle (the point is determined by the angle), with the line tip being drawn at a corresponding point on the inner circle.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private double	angle	The angle of the line's line (in radians).
private double	baseRadius	The radius from the (x, y) point to the start of the line line (in Java2D units).
static java.awt.Paint	DEFAULT_BACKGROUND_PAINT	The default line stroke.
static double	DEFAULT_BASE_RADIUS	The default base radius (in Java2D units).
static double	DEFAULT_LABEL_OFFSET	The default label offset (in Java2D units).
static java.awt.Stroke	DEFAULT_LINE_STROKE	The default line stroke.
static java.awt.Paint	DEFAULT_OUTLINE_PAINT	The default line stroke.
static double	DEFAULT_TIP_RADIUS	The default tip radius (in Java2D units).
private double	labelOffset	The radius from the base point to the anchor point for the label.
private java.awt.Paint	linePaint	The line paint.
private java.awt.Stroke	lineStroke	The line stroke.
private static long	serialVersionUID	For serialization.
private double	tipRadius	The radius from the (x, y) point to the tip of the line (in Java2D units).

Fields inherited from class org.jfree.chart.annotations.XYTextAnnotation

DEFAULT_FONT, DEFAULT_PAINT, DEFAULT_ROTATION_ANCHOR, DEFAULT_ROTATION_ANGLE, DEFAULT_TEXT_ANCHOR

Constructor Summary

Constructors

Constructor	Description
XYNoteAnnotation(java.lang.String label, double x, double y, double angle)	Creates a new label and line annotation.

Method Summary

Modifier and Type	Method	Description
java.lang.Object	clone()	Returns a clone of the annotation.
void	draw(java.awt.Graphics2D g2, XYPlot plot, java.awt.geom.Rectangle2D dataArea, ValueAxis domainAxis, ValueAxis rangeAxis, int rendererIndex, PlotRenderingInfo info)	Draws the annotation.
boolean	equals(java.lang.Object obj)	Tests this annotation for equality with an arbitrary object.
double	getAngle()	Returns the angle of the line.
double	getBaseRadius()	Returns the base radius.
double	getLabelOffset()	Returns the label offset.
java.awt.Paint	getLinePaint()	Returns the paint used for the line.
java.awt.Stroke	getLineStroke()	Returns the stroke used to draw the line line.
double	getTipRadius()	Returns the tip radius.
int	hashCode()	Returns a hash code for this instance.
private void	readObject(java.io.ObjectInputStream stream)	Provides serialization support.
void	setAngle(double angle)	Sets the angle of the line and sends an AnnotationChangeEvent to all registered listeners.
void	setBaseRadius(double radius)	Sets the base radius and sends an AnnotationChangeEvent to all registered listeners.
void	setLabelOffset(double offset)	Sets the label offset (from the line base, continuing in a straight line, in Java2D units) and sends an AnnotationChangeEvent to all registered listeners.
void	setLinePaint(java.awt.Paint paint)	Sets the paint used for the line and sends an AnnotationChangeEvent to all registered listeners.
void	setLineStroke(java.awt.Stroke stroke)	Sets the stroke used to draw the line line and sends an AnnotationChangeEvent to all registered listeners.
void	setTipRadius(double radius)	Sets the tip radius and sends an AnnotationChangeEvent to all registered listeners.
private void	writeObject(java.io.ObjectOutputStream stream)	Provides serialization support.

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

canEqual, getBackgroundPaint, getFont, getOutlinePaint, getOutlineStroke, getPaint, getRotationAnchor, getRotationAngle, getText, getTextAnchor, getX, getY, isOutlineVisible, setBackgroundPaint, setFont, setOutlinePaint, setOutlineStroke, setOutlineVisible, setPaint, setRotationAnchor, setRotationAngle, setText, setTextAnchor, setX, setY

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

addEntity, getToolTipText, getURL, setToolTipText, setURL

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jfree.chart.annotations.Annotation

addChangeListener, removeChangeListener

Field Detail

serialVersionUID

private static final long serialVersionUID

For serialization.

See Also:

Constant Field Values

DEFAULT_TIP_RADIUS

public static final double DEFAULT_TIP_RADIUS

The default tip radius (in Java2D units).

See Also:

Constant Field Values

DEFAULT_BASE_RADIUS

public static final double DEFAULT_BASE_RADIUS

The default base radius (in Java2D units).

See Also:

Constant Field Values

DEFAULT_LABEL_OFFSET

public static final double DEFAULT_LABEL_OFFSET

The default label offset (in Java2D units).

See Also:

Constant Field Values

DEFAULT_LINE_STROKE

public static final java.awt.Stroke DEFAULT_LINE_STROKE

The default line stroke.

DEFAULT_BACKGROUND_PAINT

public static final java.awt.Paint DEFAULT_BACKGROUND_PAINT

The default line stroke.

DEFAULT_OUTLINE_PAINT

public static final java.awt.Paint DEFAULT_OUTLINE_PAINT

The default line stroke.

angle

private double angle

The angle of the line's line (in radians).

tipRadius

private double tipRadius

The radius from the (x, y) point to the tip of the line (in Java2D units).

baseRadius

private double baseRadius

The radius from the (x, y) point to the start of the line line (in Java2D units).

lineStroke

private transient java.awt.Stroke lineStroke

The line stroke.

linePaint

private transient java.awt.Paint linePaint

The line paint.

labelOffset

private double labelOffset

The radius from the base point to the anchor point for the label.

Constructor Detail

XYNoteAnnotation

public XYNoteAnnotation(java.lang.String label,
                        double x,
                        double y,
                        double angle)

Creates a new label and line annotation.

Parameters:

label - the label (null permitted).

x - the x-coordinate (measured against the chart's domain axis).

y - the y-coordinate (measured against the chart's range axis).

angle - the angle of the line's line (in radians).

Method Detail

getAngle

public double getAngle()

Returns the angle of the line.

Returns:

The angle (in radians).

See Also:

setAngle(double)

setAngle

public void setAngle(double angle)

Sets the angle of the line and sends an AnnotationChangeEvent to all registered listeners.

Parameters:

angle - the angle (in radians).

See Also:

getAngle()

getTipRadius

public double getTipRadius()

Returns the tip radius.

Returns:

The tip radius (in Java2D units).

See Also:

setTipRadius(double)

setTipRadius

public void setTipRadius(double radius)

Sets the tip radius and sends an AnnotationChangeEvent to all registered listeners.

Parameters:

radius - the radius (in Java2D units).

See Also:

getTipRadius()

getBaseRadius

public double getBaseRadius()

Returns the base radius.

Returns:

The base radius (in Java2D units).

See Also:

setBaseRadius(double)

setBaseRadius

public void setBaseRadius(double radius)

Sets the base radius and sends an AnnotationChangeEvent to all registered listeners.

Parameters:

radius - the radius (in Java2D units).

See Also:

getBaseRadius()

getLabelOffset

public double getLabelOffset()

Returns the label offset.

Returns:

The label offset (in Java2D units).

See Also:

setLabelOffset(double)

setLabelOffset

public void setLabelOffset(double offset)

Sets the label offset (from the line base, continuing in a straight line, in Java2D units) and sends an AnnotationChangeEvent to all registered listeners.

Parameters:

offset - the offset (in Java2D units).

See Also:

getLabelOffset()

getLineStroke

public java.awt.Stroke getLineStroke()

Returns the stroke used to draw the line line.

Returns:

The line stroke (never null).

See Also:

setLineStroke(Stroke)

setLineStroke

public void setLineStroke(java.awt.Stroke stroke)

Sets the stroke used to draw the line line and sends an AnnotationChangeEvent to all registered listeners.

Parameters:

stroke - the stroke (null not permitted).

See Also:

getLineStroke()

getLinePaint

public java.awt.Paint getLinePaint()

Returns the paint used for the line.

Returns:

The line paint (never null).

See Also:

setLinePaint(Paint)

setLinePaint

public void setLinePaint(java.awt.Paint paint)

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

Parameters:

paint - the line paint (null not permitted).

See Also:

getLinePaint()

draw

public void draw(java.awt.Graphics2D g2,
                 XYPlot plot,
                 java.awt.geom.Rectangle2D dataArea,
                 ValueAxis domainAxis,
                 ValueAxis rangeAxis,
                 int rendererIndex,
                 PlotRenderingInfo info)

Draws the annotation.

Specified by:

draw in interface XYAnnotation

Overrides:

draw in class XYTextAnnotation

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 - the plot rendering info.

equals

public boolean equals(java.lang.Object obj)

Tests this annotation for equality with an arbitrary object.

Overrides:

equals in class XYTextAnnotation

Parameters:

obj - the object (null permitted).

Returns:

true or false.

hashCode

public int hashCode()

Returns a hash code for this instance.

Overrides:

hashCode in class XYTextAnnotation

Returns:

A hash code.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Returns a clone of the annotation.

Specified by:

clone in interface PublicCloneable

Overrides:

clone in class XYTextAnnotation

Returns:

A clone.

Throws:

java.lang.CloneNotSupportedException - if the annotation can't be cloned.

writeObject

private void writeObject(java.io.ObjectOutputStream stream)
                  throws java.io.IOException

Provides serialization support.

Parameters:

stream - the output stream.

Throws:

java.io.IOException - if there is an I/O error.

readObject

private void readObject(java.io.ObjectInputStream stream)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException

Provides serialization support.

Parameters:

stream - the input stream.

Throws:

java.io.IOException - if there is an I/O error.

java.lang.ClassNotFoundException - if there is a classpath problem.