Package org.jfree.chart.annotations
Class XYPolygonAnnotation
- java.lang.Object
-
- org.jfree.chart.annotations.AbstractAnnotation
-
- org.jfree.chart.annotations.AbstractXYAnnotation
-
- org.jfree.chart.annotations.XYPolygonAnnotation
-
- All Implemented Interfaces:
Serializable
,Cloneable
,Annotation
,XYAnnotation
,org.jfree.util.PublicCloneable
public class XYPolygonAnnotation extends AbstractXYAnnotation implements Cloneable, org.jfree.util.PublicCloneable, Serializable
A polygon annotation that can be placed on anXYPlot
. The polygon coordinates are specified in data space.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description 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 specifiedstroke
andoutlinePaint
.XYPolygonAnnotation(double[] polygon, Stroke stroke, Paint outlinePaint, Paint fillPaint)
Creates a new annotation.
-
Method Summary
All Methods Instance Methods Concrete Methods 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.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.-
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
-
XYPolygonAnnotation
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).
-
XYPolygonAnnotation
public XYPolygonAnnotation(double[] polygon, Stroke stroke, Paint outlinePaint)
Creates a new annotation where the box is drawn as an outline using the specifiedstroke
andoutlinePaint
. 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).
-
XYPolygonAnnotation
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).
-
-
Method Detail
-
getPolygonCoordinates
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.
- Since:
- 1.0.2
-
getFillPaint
public Paint getFillPaint()
Returns the fill paint.- Returns:
- The fill paint (possibly
null
). - Since:
- 1.0.2
-
getOutlineStroke
public Stroke getOutlineStroke()
Returns the outline stroke.- Returns:
- The outline stroke (possibly
null
). - Since:
- 1.0.2
-
getOutlinePaint
public Paint getOutlinePaint()
Returns the outline paint.- Returns:
- The outline paint (possibly
null
). - Since:
- 1.0.2
-
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 theXYPlot
class, you shouldn't need to call it directly.- Specified by:
draw
in interfaceXYAnnotation
- Specified by:
draw
in classAbstractXYAnnotation
- 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 classAbstractXYAnnotation
- Parameters:
obj
- the object (null
permitted).- Returns:
- A boolean.
-
hashCode
public int hashCode()
Returns a hash code for this instance.- Overrides:
hashCode
in classAbstractXYAnnotation
- Returns:
- A hash code.
-
clone
public Object clone() throws CloneNotSupportedException
Returns a clone.- Specified by:
clone
in interfaceorg.jfree.util.PublicCloneable
- Overrides:
clone
in classAbstractAnnotation
- Returns:
- A clone.
- Throws:
CloneNotSupportedException
- not thrown by this class, but may be by subclasses.
-
-