Package org.jfree.chart.annotations

Class XYLineAnnotation

java.lang.Object

org.jfree.chart.annotations.AbstractAnnotation

org.jfree.chart.annotations.AbstractXYAnnotation

org.jfree.chart.annotations.XYLineAnnotation

All Implemented Interfaces:

Serializable, Cloneable, Annotation, XYAnnotation, PublicCloneable

public class XYLineAnnotation
extends AbstractXYAnnotation
implements Cloneable, PublicCloneable, Serializable

A simple line annotation that can be placed on an XYPlot.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private Paint	paint	The line color.
private static final long	serialVersionUID	For serialization.
private Stroke	stroke	The line stroke.
private double	x1	The x-coordinate.
private double	x2	The x-coordinate.
private double	y1	The y-coordinate.
private double	y2	The y-coordinate.

Constructor Summary

Constructors

Constructor	Description
XYLineAnnotation(double x1, double y1, double x2, double y2)	Creates a new annotation that draws a line from (x1, y1) to (x2, y2) where the coordinates are measured in data space (that is, against the plot's axes).
XYLineAnnotation(double x1, double y1, double x2, double y2, Stroke stroke, Paint paint)	Creates a new annotation that draws a line from (x1, y1) to (x2, y2) where the coordinates are measured in data space (that is, against the plot's axes).

Method Summary

Modifier and Type	Method	Description
Object	clone()	Returns a clone of the annotation.
void	draw(Graphics2D g2, XYPlot plot, Rectangle2D dataArea, ValueAxis domainAxis, ValueAxis rangeAxis, int rendererIndex, PlotRenderingInfo info)	Draws the annotation.
boolean	equals(Object obj)	Tests this object for equality with an arbitrary object.
int	hashCode()	Returns a hash code.
private void	readObject(ObjectInputStream stream)	Provides serialization support.
private void	writeObject(ObjectOutputStream stream)	Provides serialization support.

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 Details

serialVersionUID

private static final long serialVersionUID

For serialization.

See Also:

• Constant Field Values

x1

private double x1

The x-coordinate.

y1

private double y1

The y-coordinate.

x2

private double x2

The x-coordinate.

y2

private double y2

The y-coordinate.

stroke

private transient Stroke stroke

The line stroke.

paint

private transient Paint paint

The line color.

Constructor Details

XYLineAnnotation

public XYLineAnnotation(double x1,
 double y1,
 double x2,
 double y2)

Creates a new annotation that draws a line from (x1, y1) to (x2, y2) where the coordinates are measured in data space (that is, against the plot's axes).

Parameters:

x1 - the x-coordinate for the start of the line.

y1 - the y-coordinate for the start of the line.

x2 - the x-coordinate for the end of the line.

y2 - the y-coordinate for the end of the line.

XYLineAnnotation

public XYLineAnnotation(double x1,
 double y1,
 double x2,
 double y2,
 Stroke stroke,
 Paint paint)

Creates a new annotation that draws a line from (x1, y1) to (x2, y2) where the coordinates are measured in data space (that is, against the plot's axes).

Parameters:

x1 - the x-coordinate for the start of the line.

y1 - the y-coordinate for the start of the line.

x2 - the x-coordinate for the end of the line.

y2 - the y-coordinate for the end of the line.

stroke - the line stroke (null not permitted).

paint - the line color (null not permitted).

Method Details

draw

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

Draws the annotation. This method is called by the XYPlot class, you won't normally need to call it yourself.

Specified by:

draw in interface XYAnnotation

Specified by:

draw in class AbstractXYAnnotation

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 - if supplied, this info object will be populated with entity information.

equals

public boolean equals(Object obj)

Tests this object for equality with an arbitrary object.

Overrides:

equals in class AbstractXYAnnotation

Parameters:

obj - the object to test against (null permitted).

Returns:

true or false.

hashCode

public int hashCode()

Returns a hash code.

Overrides:

hashCode in class AbstractXYAnnotation

Returns:

A hash code.

clone

public Object clone()
             throws CloneNotSupportedException

Returns a clone of the annotation.

Specified by:

clone in interface PublicCloneable

Overrides:

clone in class AbstractAnnotation

Returns:

A clone.

Throws:

CloneNotSupportedException - if the annotation can't be cloned.

writeObject

private void writeObject(ObjectOutputStream stream)
                  throws IOException

Provides serialization support.

Parameters:

stream - the output stream.

Throws:

IOException - if there is an I/O error.

readObject

private void readObject(ObjectInputStream stream)
                 throws IOException,
ClassNotFoundException

Provides serialization support.

Parameters:

stream - the input stream.

Throws:

IOException - if there is an I/O error.

ClassNotFoundException - if there is a classpath problem.