org.jfree.chart.annotations

Class XYImageAnnotation

public class XYImageAnnotation extends AbstractXYAnnotation implements Cloneable, PublicCloneable, Serializable

An annotation that allows an image to be placed at some location on an XYPlot. TODO: implement serialization properly (image is not serializable).
Constructor Summary
XYImageAnnotation(double x, double y, Image image)
Creates a new annotation to be displayed at the specified (x, y) location.
XYImageAnnotation(double x, double y, Image image, 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.
ImagegetImage()
Returns the image for the annotation.
RectangleAnchorgetImageAnchor()
Returns the image anchor for the annotation.
doublegetX()
Returns the x-coordinate (in data space) for the annotation.
doublegetY()
Returns the y-coordinate (in data space) for the annotation.
inthashCode()
Returns a hash code for this object.

Constructor Detail

XYImageAnnotation

public XYImageAnnotation(double x, double y, Image image)
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). image the image (null not permitted).

XYImageAnnotation

public XYImageAnnotation(double x, double y, Image image, 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). image the image (null not permitted). anchor the image anchor (null not permitted).

Since: 1.0.4

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.

getImage

public Image getImage()
Returns the image for the annotation.

Returns: The image.

Since: 1.0.4

getImageAnchor

public RectangleAnchor getImageAnchor()
Returns the image anchor for the annotation.

Returns: The image anchor.

Since: 1.0.4

getX

public double getX()
Returns the x-coordinate (in data space) for the annotation.

Returns: The x-coordinate.

Since: 1.0.4

getY

public double getY()
Returns the y-coordinate (in data space) for the annotation.

Returns: The y-coordinate.

Since: 1.0.4

hashCode

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

Returns: A hash code.

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