Package org.jfree.chart.annotations
Class XYTitleAnnotation
java.lang.Object
org.jfree.chart.annotations.AbstractAnnotation
org.jfree.chart.annotations.AbstractXYAnnotation
org.jfree.chart.annotations.XYTitleAnnotation
- All Implemented Interfaces:
Serializable
,Cloneable
,Annotation
,XYAnnotation
,PublicCloneable
public class XYTitleAnnotation
extends AbstractXYAnnotation
implements Cloneable, PublicCloneable, Serializable
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate RectangleAnchor
The title anchor point.private XYCoordinateType
The coordinate type.private double
The maximum height.private double
The maximum width.private static final long
For serialization.private Title
The title.private double
The x-coordinate (in data space).private double
The y-coordinate (in data space). -
Constructor Summary
ConstructorsConstructorDescriptionXYTitleAnnotation
(double x, double y, Title title) Creates a new annotation to be displayed at the specified (x, y) location.XYTitleAnnotation
(double x, double y, Title title, RectangleAnchor anchor) Creates a new annotation to be displayed at the specified (x, y) location. -
Method Summary
Modifier and TypeMethodDescriptionboolean
Ensures symmetry between super/subclass implementations of equals.clone()
Returns a clone of the annotation.void
draw
(Graphics2D g2, XYPlot plot, Rectangle2D dataArea, ValueAxis domainAxis, ValueAxis rangeAxis, int rendererIndex, PlotRenderingInfo info) Draws the annotation.boolean
Tests this object for equality with an arbitrary object.Returns the coordinate type (set in the constructor).double
Returns the maximum height.double
Returns the maximum width.getTitle()
Returns the title for the annotation.Returns the title anchor for the annotation.double
getX()
Returns the x-coordinate for the annotation.double
getY()
Returns the y-coordinate for the annotation.int
hashCode()
Returns a hash code for this object.void
setMaxHeight
(double max) Sets the maximum height and sends anAnnotationChangeEvent
to all registered listeners.void
setMaxWidth
(double max) Sets the maximum width and sends anAnnotationChangeEvent
to all registered listeners.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:
-
coordinateType
The coordinate type. -
x
private double xThe x-coordinate (in data space). -
y
private double yThe y-coordinate (in data space). -
maxWidth
private double maxWidthThe maximum width. -
maxHeight
private double maxHeightThe maximum height. -
title
The title. -
anchor
The title anchor point.
-
-
Constructor Details
-
XYTitleAnnotation
Creates a new annotation to be displayed at the specified (x, y) location.- Parameters:
x
- the x-coordinate (in data space).y
- the y-coordinate (in data space).title
- the title (null
not permitted).
-
XYTitleAnnotation
Creates a new annotation to be displayed at the specified (x, y) location.- Parameters:
x
- the x-coordinate (in data space).y
- the y-coordinate (in data space).title
- the title (null
not permitted).anchor
- the title anchor (null
not permitted).
-
-
Method Details
-
getCoordinateType
Returns the coordinate type (set in the constructor).- Returns:
- The coordinate type (never
null
).
-
getX
public double getX()Returns the x-coordinate for the annotation.- Returns:
- The x-coordinate.
-
getY
public double getY()Returns the y-coordinate for the annotation.- Returns:
- The y-coordinate.
-
getTitle
Returns the title for the annotation.- Returns:
- The title.
-
getTitleAnchor
Returns the title anchor for the annotation.- Returns:
- The title anchor.
-
getMaxWidth
public double getMaxWidth()Returns the maximum width.- Returns:
- The maximum width.
-
setMaxWidth
public void setMaxWidth(double max) Sets the maximum width and sends anAnnotationChangeEvent
to all registered listeners.- Parameters:
max
- the maximum width (0.0 or less means no maximum).
-
getMaxHeight
public double getMaxHeight()Returns the maximum height.- Returns:
- The maximum height.
-
setMaxHeight
public void setMaxHeight(double max) Sets the maximum height and sends anAnnotationChangeEvent
to all registered listeners.- Parameters:
max
- the maximum height.
-
draw
public void draw(Graphics2D g2, XYPlot plot, Rectangle2D dataArea, ValueAxis domainAxis, ValueAxis rangeAxis, int rendererIndex, PlotRenderingInfo info) Draws the annotation. This method is called by the drawing code in theXYPlot
class, you don't normally need to call this method 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
- if supplied, this info object will be populated with entity information.
-
equals
Tests this object 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 for this object.- Overrides:
hashCode
in classAbstractXYAnnotation
- Returns:
- A hash code.
-
clone
Returns a clone of the annotation.- Specified by:
clone
in interfacePublicCloneable
- Overrides:
clone
in classAbstractAnnotation
- Returns:
- A clone.
- Throws:
CloneNotSupportedException
- if the annotation can't be cloned.
-