Class AbstractXYAnnotation

java.lang.Object
org.jfree.chart.annotations.AbstractAnnotation
org.jfree.chart.annotations.AbstractXYAnnotation
All Implemented Interfaces:
Serializable, Cloneable, Annotation, XYAnnotation
Direct Known Subclasses:
XYBoxAnnotation, XYDataImageAnnotation, XYDataRangeAnnotation, XYDrawableAnnotation, XYImageAnnotation, XYLineAnnotation, XYPolygonAnnotation, XYShapeAnnotation, XYTextAnnotation, XYTitleAnnotation

public abstract class AbstractXYAnnotation extends AbstractAnnotation implements XYAnnotation
The interface that must be supported by annotations that are to be added to an XYPlot.
See Also:
  • Constructor Details

    • AbstractXYAnnotation

      Creates a new instance that has no tool tip or URL specified.
  • Method Details

    • getToolTipText

      Returns the tool tip text for the annotation. This will be displayed in a ChartPanel when the mouse pointer hovers over the annotation.
      Returns:
      The tool tip text (possibly null).
      See Also:
    • setToolTipText

      public void setToolTipText(String text)
      Sets the tool tip text for the annotation.
      Parameters:
      text - the tool tip text (null permitted).
      See Also:
    • getURL

      public String getURL()
      Returns the URL for the annotation. This URL will be used to provide hyperlinks when an HTML image map is created for the chart.
      Returns:
      The URL (possibly null).
      See Also:
    • setURL

      public void setURL(String url)
      Sets the URL for the annotation.
      Parameters:
      url - the URL (null permitted).
      See Also:
    • draw

      public abstract 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
      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.
    • addEntity

      protected void addEntity(PlotRenderingInfo info, Shape hotspot, int rendererIndex, String toolTipText, String urlText)
      A utility method for adding an XYAnnotationEntity to a PlotRenderingInfo instance.
      Parameters:
      info - the plot rendering info (null permitted).
      hotspot - the hotspot area.
      rendererIndex - the renderer index.
      toolTipText - the tool tip text.
      urlText - the URL text.
    • equals

      public boolean equals(Object obj)
      Tests this annotation for equality with an arbitrary object.
      Overrides:
      equals in class AbstractAnnotation
      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 AbstractAnnotation
      Parameters:
      other - Object
      Returns:
      true ONLY if the parameter is THIS class type
    • hashCode

      public int hashCode()
      Returns a hash code for this instance.
      Overrides:
      hashCode in class AbstractAnnotation
      Returns:
      A hash code.