Package org.jfree.chart.annotations
Class XYDrawableAnnotation
- java.lang.Object
-
- org.jfree.chart.annotations.AbstractAnnotation
-
- org.jfree.chart.annotations.AbstractXYAnnotation
-
- org.jfree.chart.annotations.XYDrawableAnnotation
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,Annotation
,XYAnnotation
,PublicCloneable
public class XYDrawableAnnotation extends AbstractXYAnnotation implements java.lang.Cloneable, PublicCloneable, java.io.Serializable
A general annotation that can be placed on anXYPlot
.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private double
displayHeight
The height.private double
displayWidth
The width.private Drawable
drawable
The drawable object.private double
drawScaleFactor
The scaling factor.private static long
serialVersionUID
For serialization.private double
x
The x-coordinate.private double
y
The y-coordinate.
-
Constructor Summary
Constructors Constructor Description XYDrawableAnnotation(double x, double y, double displayWidth, double displayHeight, double drawScaleFactor, Drawable drawable)
Creates a new annotation to be displayed within the given area.XYDrawableAnnotation(double x, double y, double width, double height, Drawable drawable)
Creates a new annotation to be displayed within the given area.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
canEqual(java.lang.Object other)
Ensures symmetry between super/subclass implementations of equals.java.lang.Object
clone()
Returns a clone of the annotation.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.double
getDisplayHeight()
Returns the display height (set in the constructor).double
getDisplayWidth()
Returns the display width (set in the constructor).double
getDrawScaleFactor()
Returns the scale factor (set in the constructor).double
getX()
Returns the x-coordinate (set in the constructor).double
getY()
Returns the y-coordinate (set in the constructor).int
hashCode()
Returns a hash code.-
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 Detail
-
serialVersionUID
private static final long serialVersionUID
For serialization.- See Also:
- Constant Field Values
-
drawScaleFactor
private double drawScaleFactor
The scaling factor.
-
x
private double x
The x-coordinate.
-
y
private double y
The y-coordinate.
-
displayWidth
private double displayWidth
The width.
-
displayHeight
private double displayHeight
The height.
-
drawable
private Drawable drawable
The drawable object.
-
-
Constructor Detail
-
XYDrawableAnnotation
public XYDrawableAnnotation(double x, double y, double width, double height, Drawable drawable)
Creates a new annotation to be displayed within the given area.- Parameters:
x
- the x-coordinate for the area (must be finite).y
- the y-coordinate for the area (must be finite).width
- the width of the area (must be finite).height
- the height of the area (must be finite).drawable
- the drawable object (null
not permitted).
-
XYDrawableAnnotation
public XYDrawableAnnotation(double x, double y, double displayWidth, double displayHeight, double drawScaleFactor, Drawable drawable)
Creates a new annotation to be displayed within the given area. If you specify adrawScaleFactor
of 2.0, thedrawable
will be drawn at twice the requested display size then scaled down to fit the space.- Parameters:
x
- the x-coordinate for the area (must be finite).y
- the y-coordinate for the area (must be finite).displayWidth
- the width of the area (must be finite).displayHeight
- the height of the area (must be finite).drawScaleFactor
- the scaling factor for drawing (must be finite).drawable
- the drawable object (null
not permitted).
-
-
Method Detail
-
getX
public double getX()
Returns the x-coordinate (set in the constructor).- Returns:
- The x-coordinate.
-
getY
public double getY()
Returns the y-coordinate (set in the constructor).- Returns:
- The y-coordinate.
-
getDisplayWidth
public double getDisplayWidth()
Returns the display width (set in the constructor).- Returns:
- The display width.
-
getDisplayHeight
public double getDisplayHeight()
Returns the display height (set in the constructor).- Returns:
- The display height.
-
getDrawScaleFactor
public double getDrawScaleFactor()
Returns the scale factor (set in the constructor).- Returns:
- The scale factor.
-
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.- 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
- if supplied, this info object will be populated with entity information.
-
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 to test against.- Returns:
true
orfalse
.
-
canEqual
public boolean canEqual(java.lang.Object other)
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
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
Returns a clone of the annotation.- Specified by:
clone
in interfacePublicCloneable
- Overrides:
clone
in classAbstractAnnotation
- Returns:
- A clone.
- Throws:
java.lang.CloneNotSupportedException
- if the annotation can't be cloned.
-
-