public class

XYDataImageAnnotation

extends AbstractXYAnnotation
implements Cloneable XYAnnotationBoundsInfo
java.lang.Object
   ↳ org.jfree.chart.annotations.AbstractXYAnnotation
     ↳ org.jfree.chart.annotations.XYDataImageAnnotation

Class Overview

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).

Summary

Public Constructors
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.
Public Methods
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.
double getHeight()
Returns the height (in data space) of the data rectangle into which the image will be drawn.
Image getImage()
Returns the image for the annotation.
boolean getIncludeInDataBounds()
Returns the flag that controls whether or not the annotation should contribute to the autoRange for the axis it is plotted against.
double getWidth()
Returns the width (in data space) of the data rectangle into which the image will be drawn.
double getX()
Returns the x-coordinate (in data space) for the annotation.
Range getXRange()
Returns the x-range for the annotation.
double getY()
Returns the y-coordinate (in data space) for the annotation.
Range getYRange()
Returns the y-range for the annotation.
int hashCode()
Returns a hash code for this object.
[Expand]
Inherited Methods
From class org.jfree.chart.annotations.AbstractXYAnnotation
From class java.lang.Object
From interface org.jfree.chart.annotations.XYAnnotation
From interface org.jfree.chart.annotations.XYAnnotationBoundsInfo

Public Constructors

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.

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.

Public Methods

public Object clone ()

Returns a clone of the annotation.

Returns
  • A clone.
Throws
CloneNotSupportedException if the annotation can't be cloned.

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.

public boolean equals (Object obj)

Tests this object for equality with an arbitrary object.

Parameters
obj the object (null permitted).
Returns
  • A boolean.

public double getHeight ()

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

Returns
  • The height.

public Image getImage ()

Returns the image for the annotation.

Returns
  • The image.

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.

public double getWidth ()

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

Returns
  • The width.

public double getX ()

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

Returns
  • The x-coordinate.

public Range getXRange ()

Returns the x-range for the annotation.

Returns
  • The range.

public double getY ()

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

Returns
  • The y-coordinate.

public Range getYRange ()

Returns the y-range for the annotation.

Returns
  • The range.

public int hashCode ()

Returns a hash code for this object.

Returns
  • A hash code.