org.jfree.chart.annotations
Class XYPolygonAnnotation

java.lang.Object
  extended byorg.jfree.chart.annotations.AbstractXYAnnotation
      extended byorg.jfree.chart.annotations.XYPolygonAnnotation
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable, XYAnnotation

public class XYPolygonAnnotation
extends AbstractXYAnnotation
implements java.lang.Cloneable, java.io.Serializable

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

See Also:
Serialized Form

Constructor Summary
XYPolygonAnnotation(double[] polygon)
          Creates a new annotation (where, by default, the polygon is drawn with a black outline).
XYPolygonAnnotation(double[] polygon, java.awt.Stroke stroke, java.awt.Paint outlinePaint)
          Creates a new annotation where the box is drawn as an outline using the specified stroke and outlinePaint.
XYPolygonAnnotation(double[] polygon, java.awt.Stroke stroke, java.awt.Paint outlinePaint, java.awt.Paint fillPaint)
          Creates a new annotation.
 
Method Summary
 java.lang.Object clone()
          Returns a clone.
 void draw(java.awt.Graphics2D g2, XYPlot plot, java.awt.geom.Rectangle2D dataArea, ValueAxis domainAxis, ValueAxis rangeAxis, int rendererIndex, PlotRenderingInfo info)
          Draws the annotation.
 boolean equals(java.lang.Object obj)
          Tests this annotation for equality with an arbitrary object.
 
Methods inherited from class org.jfree.chart.annotations.AbstractXYAnnotation
addEntity, getToolTipText, getURL, setToolTipText, setURL
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XYPolygonAnnotation

public XYPolygonAnnotation(double[] polygon)
Creates a new annotation (where, by default, the polygon is drawn with a black outline).

Parameters:
polygon - the polygon coordinates.

XYPolygonAnnotation

public XYPolygonAnnotation(double[] polygon,
                           java.awt.Stroke stroke,
                           java.awt.Paint outlinePaint)
Creates a new annotation where the box is drawn as an outline using the specified stroke and outlinePaint.

Parameters:
polygon - the polygon.
stroke - the shape stroke (null not permitted).
outlinePaint - the shape color (null not permitted).

XYPolygonAnnotation

public XYPolygonAnnotation(double[] polygon,
                           java.awt.Stroke stroke,
                           java.awt.Paint outlinePaint,
                           java.awt.Paint fillPaint)
Creates a new annotation.

Parameters:
polygon - the polygon.
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(java.awt.Graphics2D g2,
                 XYPlot plot,
                 java.awt.geom.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(java.lang.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.

clone

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

Returns:
A clone.
Throws:
java.lang.CloneNotSupportedException - not thrown by this class, but may be by subclasses.