org.jfree.chart.annotations

Class XYLineAnnotation

public class XYLineAnnotation extends AbstractXYAnnotation implements Cloneable, PublicCloneable, Serializable

A simple line annotation that can be placed on an XYPlot.
Constructor Summary
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
Objectclone()
Returns a clone of the annotation.
voiddraw(Graphics2D g2, XYPlot plot, Rectangle2D dataArea, ValueAxis domainAxis, ValueAxis rangeAxis, int rendererIndex, PlotRenderingInfo info)
Draws the annotation.
booleanequals(Object obj)
Tests this object for equality with an arbitrary object.
inthashCode()
Returns a hash code.

Constructor Detail

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 Detail

clone

public Object clone()
Returns a clone of the annotation.

Returns: A clone.

Throws: CloneNotSupportedException if the annotation can't be cloned.

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.

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.

Parameters: obj the object to test against (null permitted).

Returns: true or false.

hashCode

public int hashCode()
Returns a hash code.

Returns: A hash code.