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:
Serializable, Cloneable, Annotation, XYAnnotation, PublicCloneable
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).
See Also:

  • 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, 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, 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 Details

    • 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 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(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
      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(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(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 Object clone() throws CloneNotSupportedException
      Returns a clone of the annotation.
      Specified by:
      clone in interface PublicCloneable
      Overrides:
      clone in class AbstractAnnotation
      Returns:
      A clone.
      Throws:
      CloneNotSupportedException - if the annotation can't be cloned.