Package org.jfree.chart.annotations

Class XYImageAnnotation

java.lang.Object

org.jfree.chart.annotations.AbstractAnnotation

org.jfree.chart.annotations.AbstractXYAnnotation

org.jfree.chart.annotations.XYImageAnnotation

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Annotation, XYAnnotation, PublicCloneable

public class XYImageAnnotation
extends AbstractXYAnnotation
implements java.lang.Cloneable, PublicCloneable, 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

Field Summary

Fields

Modifier and Type	Field	Description
private RectangleAnchor	anchor	The image anchor point.
private java.awt.Image	image	The image.
private static long	serialVersionUID	For serialization.
private double	x	The x-coordinate (in data space).
private double	y	The y-coordinate (in data space).

Constructor Summary

Constructors

Constructor	Description
XYImageAnnotation(double x, double y, java.awt.Image image)	Creates a new annotation to be displayed at the specified (x, y) location.
XYImageAnnotation(double x, double y, java.awt.Image image, RectangleAnchor anchor)	Creates a new annotation to be displayed at the specified (x, y) location.

Method Summary

Modifier and Type	Method	Description
boolean	canEqual(java.lang.Object other)	Ensures symmetry between super/subclass implementations of equals.
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, int rendererIndex, PlotRenderingInfo info)	Draws the annotation.
boolean	equals(java.lang.Object obj)	Tests this object for equality with an arbitrary object.
java.awt.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.
private void	readObject(java.io.ObjectInputStream stream)	Provides serialization support.
private void	writeObject(java.io.ObjectOutputStream stream)	Provides serialization support.

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

addEntity, getToolTipText, getURL, setToolTipText, setURL

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

addChangeListener, fireAnnotationChanged, getNotify, hasListener, notifyListeners, removeChangeListener, setNotify

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jfree.chart.annotations.Annotation

addChangeListener, removeChangeListener

Field Detail

serialVersionUID

private static final long serialVersionUID

For serialization.

See Also:

Constant Field Values

x

private double x

The x-coordinate (in data space).

y

private double y

The y-coordinate (in data space).

image

private transient java.awt.Image image

The image.

anchor

private RectangleAnchor anchor

The image anchor point.

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, must be finite).

y - the y-coordinate (in data space, must be finite).

image - the image (null not permitted).

XYImageAnnotation

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

Method Detail

getX

public double getX()

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

Returns:

The x-coordinate.

getY

public double getY()

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

Returns:

The y-coordinate.

getImage

public java.awt.Image getImage()

Returns the image for the annotation.

Returns:

The image.

getImageAnchor

public RectangleAnchor getImageAnchor()

Returns the image anchor for the annotation.

Returns:

The image anchor.

draw

public void draw(java.awt.Graphics2D g2,
                 XYPlot plot,
                 java.awt.geom.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

Specified by:

draw in class 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(java.lang.Object obj)

Tests this object for equality with an arbitrary object.

Overrides:

equals in class AbstractXYAnnotation

Parameters:

obj - the object (null permitted).

Returns:

A boolean.

canEqual

public boolean canEqual(java.lang.Object other)

Ensures symmetry between super/subclass implementations of equals. For more detail, see http://jqno.nl/equalsverifier/manual/inheritance.

Overrides:

canEqual in class AbstractXYAnnotation

Parameters:

other - Object

Returns:

true ONLY if the parameter is THIS class type

hashCode

public int hashCode()

Returns a hash code for this object.

Overrides:

hashCode in class AbstractXYAnnotation

Returns:

A hash code.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Returns a clone of the annotation.

Specified by:

clone in interface PublicCloneable

Overrides:

clone in class AbstractAnnotation

Returns:

A clone.

Throws:

java.lang.CloneNotSupportedException - if the annotation can't be cloned.

writeObject

private void writeObject(java.io.ObjectOutputStream stream)
                  throws java.io.IOException

Provides serialization support.

Parameters:

stream - the output stream.

Throws:

java.io.IOException - if there is an I/O error.

readObject

private void readObject(java.io.ObjectInputStream stream)
                 throws java.io.IOException,
                        java.lang.ClassNotFoundException

Provides serialization support.

Parameters:

stream - the input stream.

Throws:

java.io.IOException - if there is an I/O error.

java.lang.ClassNotFoundException - if there is a classpath problem.