public class

XYPolygonAnnotation

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

Class Overview

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

Summary

Public Constructors
XYPolygonAnnotation(double[] polygon)
Creates a new annotation (where, by default, the polygon is drawn with a black outline).
XYPolygonAnnotation(double[] polygon, Stroke stroke, Paint outlinePaint)
Creates a new annotation where the box is drawn as an outline using the specified stroke and outlinePaint.
XYPolygonAnnotation(double[] polygon, 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.
Paint getFillPaint()
Returns the fill paint.
Paint getOutlinePaint()
Returns the outline paint.
Stroke getOutlineStroke()
Returns the outline stroke.
double[] getPolygonCoordinates()
Returns the coordinates of the polygon's vertices.
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 XYPolygonAnnotation (double[] polygon)

Creates a new annotation (where, by default, the polygon is drawn with a black outline). The array of polygon coordinates must contain an even number of coordinates (each pair is an (x, y) location on the plot) and the last point is automatically joined back to the first point.

Parameters
polygon the coordinates of the polygon's vertices (null not permitted).

public XYPolygonAnnotation (double[] polygon, Stroke stroke, Paint outlinePaint)

Creates a new annotation where the box is drawn as an outline using the specified stroke and outlinePaint. The array of polygon coordinates must contain an even number of coordinates (each pair is an (x, y) location on the plot) and the last point is automatically joined back to the first point.

Parameters
polygon the coordinates of the polygon's vertices (null not permitted).
stroke the shape stroke (null permitted).
outlinePaint the shape color (null permitted).

public XYPolygonAnnotation (double[] polygon, Stroke stroke, Paint outlinePaint, Paint fillPaint)

Creates a new annotation. The array of polygon coordinates must contain an even number of coordinates (each pair is an (x, y) location on the plot) and the last point is automatically joined back to the first point.

Parameters
polygon the coordinates of the polygon's vertices (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 not thrown by this class, but may be by subclasses.

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 Paint getFillPaint ()

Returns the fill paint.

Returns
  • The fill paint (possibly null).

public Paint getOutlinePaint ()

Returns the outline paint.

Returns
  • The outline paint (possibly null).

public Stroke getOutlineStroke ()

Returns the outline stroke.

Returns
  • The outline stroke (possibly null).

public double[] getPolygonCoordinates ()

Returns the coordinates of the polygon's vertices. The returned array is a copy, so it is safe to modify without altering the annotation's state.

Returns
  • The coordinates of the polygon's vertices.

public int hashCode ()

Returns a hash code for this instance.

Returns
  • A hash code.