public class

XYTitleAnnotation

extends AbstractXYAnnotation
implements Serializable Cloneable
java.lang.Object
   ↳ org.jfree.chart.annotations.AbstractXYAnnotation
     ↳ org.jfree.chart.annotations.XYTitleAnnotation

Class Overview

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

Summary

Public Constructors
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.
Public Methods
Object 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 equals(Object obj)
Tests this object for equality with an arbitrary object.
XYCoordinateType getCoordinateType()
Returns the coordinate type (set in the constructor).
double getMaxHeight()
Returns the maximum height.
double getMaxWidth()
Returns the maximum width.
Title getTitle()
Returns the title for the annotation.
RectangleAnchor getTitleAnchor()
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.
void setMaxWidth(double max)
Sets the maximum width.
[Expand]
Inherited Methods
From class org.jfree.chart.annotations.AbstractXYAnnotation
From class java.lang.Object
From interface org.jfree.chart.annotations.XYAnnotation

Public Constructors

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).

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).

Public Methods

public Object clone ()

Returns a clone of the annotation.

Returns
  • A clone.
Throws
CloneNotSupportedException if the annotation can't be cloned.

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.

public boolean equals (Object obj)

Tests this object for equality with an arbitrary object.

Parameters
obj the object (null permitted).
Returns
  • A boolean.

public XYCoordinateType getCoordinateType ()

Returns the coordinate type (set in the constructor).

Returns
  • The coordinate type (never null).

public double getMaxHeight ()

Returns the maximum height.

Returns
  • The maximum height.

public double getMaxWidth ()

Returns the maximum width.

Returns
  • The maximum width.

public Title getTitle ()

Returns the title for the annotation.

Returns
  • The title.

public RectangleAnchor getTitleAnchor ()

Returns the title anchor for the annotation.

Returns
  • The title anchor.

public double getX ()

Returns the x-coordinate for the annotation.

Returns
  • The x-coordinate.

public double getY ()

Returns the y-coordinate for the annotation.

Returns
  • The y-coordinate.

public int hashCode ()

Returns a hash code for this object.

Returns
  • A hash code.

public void setMaxHeight (double max)

Sets the maximum height.

Parameters
max the maximum height.

public void setMaxWidth (double max)

Sets the maximum width.

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