public class

XYShapeAnnotation

extends AbstractXYAnnotation
implements Serializable Cloneable
java.lang.Object
   ↳ org.jfree.chart.annotations.AbstractXYAnnotation
     ↳ org.jfree.chart.annotations.XYShapeAnnotation

Class Overview

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

Summary

Public Constructors
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.
Public Methods
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.
[Expand]
Inherited Methods
From class org.jfree.chart.annotations.AbstractXYAnnotation
From class java.lang.Object
From interface org.jfree.chart.annotations.XYAnnotation

Public Constructors

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).

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).

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.

Public Methods

public Object clone ()

Returns a clone.

Returns
  • A clone.
Throws
CloneNotSupportedException ???.

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.

public boolean equals (Object obj)

Tests this annotation for equality with an arbitrary object.

Parameters
obj the object (null permitted).
Returns
  • A boolean.

public int hashCode ()

Returns a hash code for this instance.

Returns
  • A hash code.