org.jfree.chart.annotations

Class XYDataImageAnnotation

public class XYDataImageAnnotation extends AbstractXYAnnotation implements Cloneable, PublicCloneable, XYAnnotationBoundsInfo

An annotation that allows an image to be placed within a rectangle specified in data coordinates on an XYPlot. Note that this annotation is not currently serializable, so don't use it if you plan on serializing your chart(s).

Since: 1.0.11

Constructor Summary
XYDataImageAnnotation(Image image, double x, double y, double w, double h)
Creates a new annotation to be displayed within the specified rectangle.
XYDataImageAnnotation(Image image, double x, double y, double w, double h, boolean includeInDataBounds)
Creates a new annotation to be displayed within the specified rectangle.
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.
doublegetHeight()
Returns the height (in data space) of the data rectangle into which the image will be drawn.
ImagegetImage()
Returns the image for the annotation.
booleangetIncludeInDataBounds()
Returns the flag that controls whether or not the annotation should contribute to the autoRange for the axis it is plotted against.
doublegetWidth()
Returns the width (in data space) of the data rectangle into which the image will be drawn.
doublegetX()
Returns the x-coordinate (in data space) for the annotation.
RangegetXRange()
Returns the x-range for the annotation.
doublegetY()
Returns the y-coordinate (in data space) for the annotation.
RangegetYRange()
Returns the y-range for the annotation.
inthashCode()
Returns a hash code for this object.

Constructor Detail

XYDataImageAnnotation

public XYDataImageAnnotation(Image image, double x, double y, double w, double h)
Creates a new annotation to be displayed within the specified rectangle.

Parameters: image the image (null not permitted). x the x-coordinate (in data space). y the y-coordinate (in data space). w the image display area width. h the image display area height.

XYDataImageAnnotation

public XYDataImageAnnotation(Image image, double x, double y, double w, double h, boolean includeInDataBounds)
Creates a new annotation to be displayed within the specified rectangle.

Parameters: image the image (null not permitted). x the x-coordinate (in data space). y the y-coordinate (in data space). w the image display area width. h the image display area height. includeInDataBounds a flag that controls whether or not the annotation is included in the data bounds for the axis autoRange.

Since: 1.0.13

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.

getHeight

public double getHeight()
Returns the height (in data space) of the data rectangle into which the image will be drawn.

Returns: The height.

getImage

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

Returns: The image.

getIncludeInDataBounds

public boolean getIncludeInDataBounds()
Returns the flag that controls whether or not the annotation should contribute to the autoRange for the axis it is plotted against.

Returns: A boolean.

Since: 1.0.13

getWidth

public double getWidth()
Returns the width (in data space) of the data rectangle into which the image will be drawn.

Returns: The width.

getX

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

Returns: The x-coordinate.

getXRange

public Range getXRange()
Returns the x-range for the annotation.

Returns: The range.

Since: 1.0.13

getY

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

Returns: The y-coordinate.

getYRange

public Range getYRange()
Returns the y-range for the annotation.

Returns: The range.

Since: 1.0.13

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.