org.jfree.chart.annotations

Class XYTitleAnnotation

public class XYTitleAnnotation extends AbstractXYAnnotation implements Cloneable, PublicCloneable, Serializable

An annotation that allows any Title to be placed at a location on an XYPlot.

Since: 1.0.11

Constructor Summary
XYTitleAnnotation(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
Objectclone()
Returns a clone of the annotation.
voiddraw(Graphics2D g2, XYPlot plot, Rectangle2D dataArea, ValueAxis domainAxis, ValueAxis rangeAxis, int rendererIndex, PlotRenderingInfo info)
Draws the annotation.
booleanequals(Object obj)
Tests this object for equality with an arbitrary object.
XYCoordinateTypegetCoordinateType()
Returns the coordinate type (set in the constructor).
doublegetMaxHeight()
Returns the maximum height.
doublegetMaxWidth()
Returns the maximum width.
TitlegetTitle()
Returns the title for the annotation.
RectangleAnchorgetTitleAnchor()
Returns the title anchor for the annotation.
doublegetX()
Returns the x-coordinate for the annotation.
doublegetY()
Returns the y-coordinate for the annotation.
inthashCode()
Returns a hash code for this object.
voidsetMaxHeight(double max)
Sets the maximum height.
voidsetMaxWidth(double max)
Sets the maximum width.

Constructor Detail

XYTitleAnnotation

public XYTitleAnnotation(double x, double y, Title title)
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

public XYTitleAnnotation(double x, double y, Title title, RectangleAnchor anchor)
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 Detail

clone

public Object clone()
Returns a clone of the annotation.

Returns: A clone.

Throws: CloneNotSupportedException if the annotation can't be cloned.

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 the XYPlot class, you don't normally need to call this method directly.

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(Object obj)
Tests this object for equality with an arbitrary object.

Parameters: obj the object (null permitted).

Returns: A boolean.

getCoordinateType

public XYCoordinateType getCoordinateType()
Returns the coordinate type (set in the constructor).

Returns: The coordinate type (never null).

getMaxHeight

public double getMaxHeight()
Returns the maximum height.

Returns: The maximum height.

getMaxWidth

public double getMaxWidth()
Returns the maximum width.

Returns: The maximum width.

getTitle

public Title getTitle()
Returns the title for the annotation.

Returns: The title.

getTitleAnchor

public RectangleAnchor getTitleAnchor()
Returns the title anchor for the annotation.

Returns: The title anchor.

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.

hashCode

public int hashCode()
Returns a hash code for this object.

Returns: A hash code.

setMaxHeight

public void setMaxHeight(double max)
Sets the maximum height.

Parameters: max the maximum height.

setMaxWidth

public void setMaxWidth(double max)
Sets the maximum width.

Parameters: max the maximum width (0.0 or less means no maximum).

Copyright © 2000-2009 by Object Refinery Limited. All Rights Reserved.