org.jfree.chart.annotations
Class XYImageAnnotation

java.lang.Object
  extended byorg.jfree.chart.annotations.XYImageAnnotation
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable, XYAnnotation

public class XYImageAnnotation
extends java.lang.Object
implements XYAnnotation, java.lang.Cloneable, java.io.Serializable

An annotation that allows an image to be placed at some location on an XYPlot. TODO: implement serialization properly (image is not serializable).

See Also:
Serialized Form

Constructor Summary
XYImageAnnotation(double x, double y, java.awt.Image image)
          Creates a new annotation to be displayed at the specified (x, y) location.
 
Method Summary
 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)
          Draws the annotation.
 boolean equals(java.lang.Object object)
          Tests this object for equality with an arbitrary object.
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XYImageAnnotation

public XYImageAnnotation(double x,
                         double y,
                         java.awt.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).
Method Detail

draw

public void draw(java.awt.Graphics2D g2,
                 XYPlot plot,
                 java.awt.geom.Rectangle2D dataArea,
                 ValueAxis domainAxis,
                 ValueAxis rangeAxis)
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.

Specified by:
draw in interface XYAnnotation
Parameters:
g2 - the graphics device.
plot - the plot.
dataArea - the data area.
domainAxis - the domain axis.
rangeAxis - the range axis.

equals

public boolean equals(java.lang.Object object)
Tests this object for equality with an arbitrary object.

Parameters:
object - the object (null permitted).
Returns:
A boolean.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Returns a clone of the annotation.

Returns:
A clone.
Throws:
java.lang.CloneNotSupportedException - if the annotation can't be cloned.