Module org.jfree.chart

Package org.jfree.chart.annotations

Class XYShapeAnnotation

java.lang.Object

org.jfree.chart.annotations.AbstractAnnotation

org.jfree.chart.annotations.AbstractXYAnnotation

org.jfree.chart.annotations.XYShapeAnnotation

All Implemented Interfaces:

Serializable, Cloneable, Annotation, XYAnnotation, PublicCloneable

public class XYShapeAnnotation
extends AbstractXYAnnotation
implements Cloneable, PublicCloneable, Serializable

A simple Shape annotation that can be placed on an XYPlot. The shape coordinates are specified in data space.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
XYShapeAnnotation(Shape shape)	Creates a new annotation (where, by default, the shape is drawn with a black outline).
XYShapeAnnotation(Shape shape, Stroke stroke, Paint outlinePaint)	Creates a new annotation where the shape is drawn as an outline using the specified stroke and outlinePaint.
XYShapeAnnotation(Shape shape, Stroke stroke, Paint outlinePaint, Paint fillPaint)	Creates a new annotation.

Method Summary

Modifier and Type	Method	Description
Object	clone()	Returns a clone.
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 annotation for equality with an arbitrary object.
int	hashCode()	Returns a hash code for this instance.

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

Constructor Detail

XYShapeAnnotation

public XYShapeAnnotation(Shape shape)

Creates a new annotation (where, by default, the shape is drawn with a black outline).

Parameters:

shape - the shape (coordinates in data space, null not permitted).

XYShapeAnnotation

public XYShapeAnnotation(Shape shape,
                         Stroke stroke,
                         Paint outlinePaint)

Creates a new annotation where the shape is drawn as an outline using the specified stroke and outlinePaint.

Parameters:

shape - the shape (null not permitted).

stroke - the shape stroke (null permitted).

outlinePaint - the shape color (null permitted).

XYShapeAnnotation

public XYShapeAnnotation(Shape shape,
                         Stroke stroke,
                         Paint outlinePaint,
                         Paint fillPaint)

Creates a new annotation.

Parameters:

shape - the shape (null not permitted).

stroke - the shape stroke (null permitted).

outlinePaint - the shape color (null permitted).

fillPaint - the paint used to fill the shape (null permitted.

Method Detail

draw

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

Draws the annotation. This method is usually called by the XYPlot class, you shouldn't need to call it directly.

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

equals

public boolean equals(Object obj)

Tests this annotation for equality with an arbitrary object.

Overrides:

equals in class AbstractXYAnnotation

Parameters:

obj - the object (null permitted).

Returns:

A boolean.

hashCode

public int hashCode()

Returns a hash code for this instance.

Overrides:

hashCode in class AbstractXYAnnotation

Returns:

A hash code.

clone

public Object clone()
             throws CloneNotSupportedException

Returns a clone.

Specified by:

clone in interface PublicCloneable

Overrides:

clone in class AbstractAnnotation

Returns:

A clone.

Throws:

CloneNotSupportedException - ???.