org.jfree.chart.annotations

Class XYShapeAnnotation

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

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

clone

public Object clone()
Returns a clone.

Returns: A clone.

Throws: CloneNotSupportedException ???.

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.

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.

Parameters: obj the object (null permitted).

Returns: A boolean.

hashCode

public int hashCode()
Returns a hash code for this instance.

Returns: A hash code.