Package org.jfree.chart.annotations
Class XYBoxAnnotation
java.lang.Object
org.jfree.chart.annotations.AbstractAnnotation
org.jfree.chart.annotations.AbstractXYAnnotation
org.jfree.chart.annotations.XYBoxAnnotation
- All Implemented Interfaces:
Serializable
,Cloneable
,Annotation
,XYAnnotation
,PublicCloneable
public class XYBoxAnnotation
extends AbstractXYAnnotation
implements Cloneable, PublicCloneable, Serializable
A box annotation that can be placed on an
XYPlot
. The
box coordinates are specified in data space.- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Paint
The paint used to fill the box.private Paint
The paint used to draw the box outline.private static final long
For serialization.private Stroke
The stroke used to draw the box outline.private double
The lower x-coordinate.private double
The upper x-coordinate.private double
The lower y-coordinate.private double
The upper y-coordinate. -
Constructor Summary
ConstructorsConstructorDescriptionXYBoxAnnotation
(double x0, double y0, double x1, double y1) Creates a new annotation (where, by default, the box is drawn with a black outline).XYBoxAnnotation
(double x0, double y0, double x1, double y1, Stroke stroke, Paint outlinePaint) Creates a new annotation where the box is drawn as an outline using the specifiedstroke
andoutlinePaint
.XYBoxAnnotation
(double x0, double y0, double x1, double y1, Stroke stroke, Paint outlinePaint, Paint fillPaint) Creates a new annotation. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Ensures symmetry between super/subclass implementations of equals.clone()
Returns a clone.void
draw
(Graphics2D g2, XYPlot plot, Rectangle2D dataArea, ValueAxis domainAxis, ValueAxis rangeAxis, int rendererIndex, PlotRenderingInfo info) Draws the annotation.boolean
Tests this annotation for equality with an arbitrary object.Returns the paint used for the box fill.Returns the paint used for the box outline.Returns the stroke used for the box outline.double
getX0()
Returns the x-coordinate for the bottom left corner of the box (set in the constructor).double
getX1()
Returns the x-coordinate for the top right corner of the box (set in the constructor).double
getY0()
Returns the y-coordinate for the bottom left corner of the box (set in the constructor).double
getY1()
Returns the y-coordinate for the top right corner of the box (set in the constructor).int
hashCode()
Returns a hash code.private void
readObject
(ObjectInputStream stream) Provides serialization support.private void
writeObject
(ObjectOutputStream stream) Provides serialization support.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
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDFor serialization.- See Also:
-
x0
private double x0The lower x-coordinate. -
y0
private double y0The lower y-coordinate. -
x1
private double x1The upper x-coordinate. -
y1
private double y1The upper y-coordinate. -
stroke
The stroke used to draw the box outline. -
outlinePaint
The paint used to draw the box outline. -
fillPaint
The paint used to fill the box.
-
-
Constructor Details
-
XYBoxAnnotation
public XYBoxAnnotation(double x0, double y0, double x1, double y1) Creates a new annotation (where, by default, the box is drawn with a black outline).- Parameters:
x0
- the lower x-coordinate of the box (in data space).y0
- the lower y-coordinate of the box (in data space).x1
- the upper x-coordinate of the box (in data space).y1
- the upper y-coordinate of the box (in data space).
-
XYBoxAnnotation
public XYBoxAnnotation(double x0, double y0, double x1, double y1, Stroke stroke, Paint outlinePaint) Creates a new annotation where the box is drawn as an outline using the specifiedstroke
andoutlinePaint
.- Parameters:
x0
- the lower x-coordinate of the box (in data space).y0
- the lower y-coordinate of the box (in data space).x1
- the upper x-coordinate of the box (in data space).y1
- the upper y-coordinate of the box (in data space).stroke
- the shape stroke (null
permitted).outlinePaint
- the shape color (null
permitted).
-
XYBoxAnnotation
public XYBoxAnnotation(double x0, double y0, double x1, double y1, Stroke stroke, Paint outlinePaint, Paint fillPaint) Creates a new annotation.- Parameters:
x0
- the lower x-coordinate of the box (in data space, must be finite).y0
- the lower y-coordinate of the box (in data space, must be finite).x1
- the upper x-coordinate of the box (in data space, must be finite).y1
- the upper y-coordinate of the box (in data space, must be finite).stroke
- the shape stroke (null
permitted).outlinePaint
- the shape color (null
permitted).fillPaint
- the paint used to fill the shape (null
permitted).
-
-
Method Details
-
getX0
public double getX0()Returns the x-coordinate for the bottom left corner of the box (set in the constructor).- Returns:
- The x-coordinate for the bottom left corner of the box.
-
getY0
public double getY0()Returns the y-coordinate for the bottom left corner of the box (set in the constructor).- Returns:
- The y-coordinate for the bottom left corner of the box.
-
getX1
public double getX1()Returns the x-coordinate for the top right corner of the box (set in the constructor).- Returns:
- The x-coordinate for the top right corner of the box.
-
getY1
public double getY1()Returns the y-coordinate for the top right corner of the box (set in the constructor).- Returns:
- The y-coordinate for the top right corner of the box.
-
getStroke
Returns the stroke used for the box outline.- Returns:
- The stroke (possibly
null
).
-
getOutlinePaint
Returns the paint used for the box outline.- Returns:
- The paint (possibly
null
).
-
getFillPaint
Returns the paint used for the box fill.- Returns:
- The paint (possibly
null
).
-
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
Tests this annotation for equality with an arbitrary object.- Overrides:
equals
in classAbstractXYAnnotation
- Parameters:
obj
- the object (null
permitted).- Returns:
- A boolean.
-
canEqual
Ensures symmetry between super/subclass implementations of equals. For more detail, see http://jqno.nl/equalsverifier/manual/inheritance.- Overrides:
canEqual
in classAbstractXYAnnotation
- Parameters:
other
- Object- Returns:
- true ONLY if the parameter is THIS class type
-
hashCode
public int hashCode()Returns a hash code.- Overrides:
hashCode
in classAbstractXYAnnotation
- Returns:
- A hash code.
-
clone
Returns a clone.- Specified by:
clone
in interfacePublicCloneable
- Overrides:
clone
in classAbstractAnnotation
- Returns:
- A clone.
- Throws:
CloneNotSupportedException
- not thrown by this class, but may be by subclasses.
-
writeObject
Provides serialization support.- Parameters:
stream
- the output stream (null
not permitted).- Throws:
IOException
- if there is an I/O error.
-
readObject
Provides serialization support.- Parameters:
stream
- the input stream (null
not permitted).- Throws:
IOException
- if there is an I/O error.ClassNotFoundException
- if there is a classpath problem.
-