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 PaintThe paint used to fill the box.private PaintThe paint used to draw the box outline.private static final longFor serialization.private StrokeThe stroke used to draw the box outline.private doubleThe lower x-coordinate.private doubleThe upper x-coordinate.private doubleThe lower y-coordinate.private doubleThe 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 specifiedstrokeandoutlinePaint.XYBoxAnnotation(double x0, double y0, double x1, double y1, Stroke stroke, Paint outlinePaint, Paint fillPaint) Creates a new annotation. -
Method Summary
Modifier and TypeMethodDescriptionbooleanEnsures symmetry between super/subclass implementations of equals.clone()Returns a clone.voiddraw(Graphics2D g2, XYPlot plot, Rectangle2D dataArea, ValueAxis domainAxis, ValueAxis rangeAxis, int rendererIndex, PlotRenderingInfo info) Draws the annotation.booleanTests 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.doublegetX0()Returns the x-coordinate for the bottom left corner of the box (set in the constructor).doublegetX1()Returns the x-coordinate for the top right corner of the box (set in the constructor).doublegetY0()Returns the y-coordinate for the bottom left corner of the box (set in the constructor).doublegetY1()Returns the y-coordinate for the top right corner of the box (set in the constructor).inthashCode()Returns a hash code.private voidreadObject(ObjectInputStream stream) Provides serialization support.private voidwriteObject(ObjectOutputStream stream) Provides serialization support.Methods inherited from class org.jfree.chart.annotations.AbstractXYAnnotation
addEntity, getToolTipText, getURL, setToolTipText, setURLMethods inherited from class org.jfree.chart.annotations.AbstractAnnotation
addChangeListener, fireAnnotationChanged, getNotify, hasListener, notifyListeners, removeChangeListener, setNotifyMethods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, toString, wait, wait, waitMethods 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 specifiedstrokeandoutlinePaint.- 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 (nullpermitted).outlinePaint- the shape color (nullpermitted).
-
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 (nullpermitted).outlinePaint- the shape color (nullpermitted).fillPaint- the paint used to fill the shape (nullpermitted).
-
-
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 theXYPlotclass, you shouldn't need to call it directly.- Specified by:
drawin interfaceXYAnnotation- Specified by:
drawin 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:
equalsin classAbstractXYAnnotation- Parameters:
obj- the object (nullpermitted).- Returns:
- A boolean.
-
canEqual
Ensures symmetry between super/subclass implementations of equals. For more detail, see http://jqno.nl/equalsverifier/manual/inheritance.- Overrides:
canEqualin classAbstractXYAnnotation- Parameters:
other- Object- Returns:
- true ONLY if the parameter is THIS class type
-
hashCode
public int hashCode()Returns a hash code.- Overrides:
hashCodein classAbstractXYAnnotation- Returns:
- A hash code.
-
clone
Returns a clone.- Specified by:
clonein interfacePublicCloneable- Overrides:
clonein 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 (nullnot permitted).- Throws:
IOException- if there is an I/O error.
-
readObject
Provides serialization support.- Parameters:
stream- the input stream (nullnot permitted).- Throws:
IOException- if there is an I/O error.ClassNotFoundException- if there is a classpath problem.
-