org.jfree.chart.annotations
Class XYLineAnnotation

java.lang.Object
  org.jfree.chart.annotations.XYLineAnnotation

All Implemented Interfaces:

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

public class XYLineAnnotation

extends java.lang.Object

implements XYAnnotation, java.lang.Cloneable, java.io.Serializable

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

Author:

David Gilbert

See Also:

Serialized Form

Constructor Summary

XYLineAnnotation(double x1, double y1, double x2, double y2, java.awt.Stroke stroke, java.awt.Paint paint)
Creates a new annotation to be displayed at the given coordinates.

Method Summary

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) Draws the annotation.
boolean	equals(java.lang.Object object) Tests this annotation for equality with an object.

Methods inherited from class java.lang.Object

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

Constructor Detail

XYLineAnnotation

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

Creates a new annotation to be displayed at the given coordinates.

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.

paint - the line color.

Method Detail

draw

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

Draws the annotation.

Specified by:

draw in interface XYAnnotation

Parameters:

g2 - the graphics device.

plot - the plot.

dataArea - the data area.

domainAxis - the domain axis.

rangeAxis - the range axis.

equals

public boolean equals(java.lang.Object object)

Tests this annotation for equality with an object.

Parameters:

object - the object to test against.

Returns:

true or false.

clone

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

Returns a clone of the annotation.

Returns:

A clone.

Throws:

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