Package org.jfree.chart.annotations
Class XYShapeAnnotation
- java.lang.Object
-
- org.jfree.chart.annotations.AbstractAnnotation
-
- org.jfree.chart.annotations.AbstractXYAnnotation
-
- org.jfree.chart.annotations.XYShapeAnnotation
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,Annotation
,XYAnnotation
,PublicCloneable
public class XYShapeAnnotation extends AbstractXYAnnotation implements java.lang.Cloneable, PublicCloneable, java.io.Serializable
A simpleShape
annotation that can be placed on anXYPlot
. The shape coordinates are specified in data space.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private java.awt.Paint
fillPaint
The paint used to fill the shape.private java.awt.Paint
outlinePaint
The paint used to draw the shape's outline.private static long
serialVersionUID
For serialization.private java.awt.Shape
shape
The shape.private java.awt.Stroke
stroke
The stroke used to draw the shape's outline.
-
Constructor Summary
Constructors Constructor Description XYShapeAnnotation(java.awt.Shape shape)
Creates a new annotation (where, by default, the shape is drawn with a black outline).XYShapeAnnotation(java.awt.Shape shape, java.awt.Stroke stroke, java.awt.Paint outlinePaint)
Creates a new annotation where the shape is drawn as an outline using the specifiedstroke
andoutlinePaint
.XYShapeAnnotation(java.awt.Shape shape, java.awt.Stroke stroke, java.awt.Paint outlinePaint, java.awt.Paint fillPaint)
Creates a new annotation.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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.int
hashCode()
Returns a hash code for this instance.private void
readObject(java.io.ObjectInputStream stream)
Provides serialization support.private void
writeObject(java.io.ObjectOutputStream stream)
Provides serialization support.-
Methods inherited from class org.jfree.chart.annotations.AbstractXYAnnotation
addEntity, canEqual, 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
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
For serialization.- See Also:
- Constant Field Values
-
shape
private transient java.awt.Shape shape
The shape.
-
stroke
private transient java.awt.Stroke stroke
The stroke used to draw the shape's outline.
-
outlinePaint
private transient java.awt.Paint outlinePaint
The paint used to draw the shape's outline.
-
fillPaint
private transient java.awt.Paint fillPaint
The paint used to fill the shape.
-
-
Constructor Detail
-
XYShapeAnnotation
public XYShapeAnnotation(java.awt.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(java.awt.Shape shape, java.awt.Stroke stroke, java.awt.Paint outlinePaint)
Creates a new annotation where the shape is drawn as an outline using the specifiedstroke
andoutlinePaint
.- Parameters:
shape
- the shape (null
not permitted).stroke
- the shape stroke (null
permitted).outlinePaint
- the shape color (null
permitted).
-
XYShapeAnnotation
public XYShapeAnnotation(java.awt.Shape shape, java.awt.Stroke stroke, java.awt.Paint outlinePaint, java.awt.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
-
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 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(java.lang.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 java.lang.Object clone() throws java.lang.CloneNotSupportedException
Returns a clone.- Specified by:
clone
in interfacePublicCloneable
- Overrides:
clone
in classAbstractAnnotation
- Returns:
- A clone.
- Throws:
java.lang.CloneNotSupportedException
- ???.
-
writeObject
private void writeObject(java.io.ObjectOutputStream stream) throws java.io.IOException
Provides serialization support.- Parameters:
stream
- the output stream.- Throws:
java.io.IOException
- if there is an I/O error.
-
readObject
private void readObject(java.io.ObjectInputStream stream) throws java.io.IOException, java.lang.ClassNotFoundException
Provides serialization support.- Parameters:
stream
- the input stream.- Throws:
java.io.IOException
- if there is an I/O error.java.lang.ClassNotFoundException
- if there is a classpath problem.
-
-