Overview Package Class Use Source Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.jfree.chart.annotations

Class XYImageAnnotation

Implemented Interfaces:
Cloneable, PublicCloneable, Serializable, XYAnnotation
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

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.
Image
getImage()
Returns the image for the annotation.
RectangleAnchor
getImageAnchor()
Returns the image anchor for the annotation.
double
getX()
Returns the x-coordinate (in data space) for the annotation.
double
getY()
Returns the y-coordinate (in data space) for the annotation.
int
hashCode()
Returns a hash code for this object.

Methods inherited from class org.jfree.chart.annotations.AbstractXYAnnotation

addEntity, draw, equals, getToolTipText, getURL, hashCode, setToolTipText, setURL

Constructor Details

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 Details

clone

public Object clone()
            throws CloneNotSupportedException
Returns a clone of the annotation.
Returns:
A clone.

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.
Specified by:
draw in interface XYAnnotation
Overrides:
draw in interface AbstractXYAnnotation
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.
Overrides:
equals in interface AbstractXYAnnotation
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.
Overrides:
hashCode in interface AbstractXYAnnotation
Returns:
A hash code.

Overview Package Class Use Source Tree Index Deprecated About