Package org.jfree.chart.annotations

Class XYDrawableAnnotation

java.lang.Object
org.jfree.chart.annotations.AbstractAnnotation
org.jfree.chart.annotations.AbstractXYAnnotation
org.jfree.chart.annotations.XYDrawableAnnotation
All Implemented Interfaces:
Serializable, Cloneable, Annotation, XYAnnotation, PublicCloneable
public class XYDrawableAnnotation extends AbstractXYAnnotation implements Cloneable, PublicCloneable, Serializable
A general annotation that can be placed on an XYPlot.
See Also:

  • Constructor Details

    • XYDrawableAnnotation

      public XYDrawableAnnotation(double x, double y, double width, double height, Drawable drawable)
      Creates a new annotation to be displayed within the given area.
      Parameters:
      x - the x-coordinate for the area (must be finite).
      y - the y-coordinate for the area (must be finite).
      width - the width of the area (must be finite).
      height - the height of the area (must be finite).
      drawable - the drawable object (null not permitted).

    • XYDrawableAnnotation

      public XYDrawableAnnotation(double x, double y, double displayWidth, double displayHeight, double drawScaleFactor, Drawable drawable)
      Creates a new annotation to be displayed within the given area. If you specify a drawScaleFactor of 2.0, the drawable will be drawn at twice the requested display size then scaled down to fit the space.
      Parameters:
      x - the x-coordinate for the area (must be finite).
      y - the y-coordinate for the area (must be finite).
      displayWidth - the width of the area (must be finite).
      displayHeight - the height of the area (must be finite).
      drawScaleFactor - the scaling factor for drawing (must be finite).
      drawable - the drawable object (null not permitted).

  • Method Details

    • getX

      public double getX()
      Returns the x-coordinate (set in the constructor).
      Returns:
      The x-coordinate.

    • getY

      public double getY()
      Returns the y-coordinate (set in the constructor).
      Returns:
      The y-coordinate.

    • getDisplayWidth

      public double getDisplayWidth()
      Returns the display width (set in the constructor).
      Returns:
      The display width.

    • getDisplayHeight

      public double getDisplayHeight()
      Returns the display height (set in the constructor).
      Returns:
      The display height.

    • getDrawScaleFactor

      public double getDrawScaleFactor()
      Returns the scale factor (set in the constructor).
      Returns:
      The scale factor.

    • draw

      public void draw(Graphics2D g2, XYPlot plot, Rectangle2D dataArea, ValueAxis domainAxis, ValueAxis rangeAxis, int rendererIndex, PlotRenderingInfo info)
      Draws the annotation.
      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 annotation for equality with an arbitrary object.
      Overrides:
      equals in class AbstractXYAnnotation
      Parameters:
      obj - the object to test against.
      Returns:
      true or false.

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