Module platform
Package org.jfree.chart.annotations

Class XYPointerAnnotation

java.lang.Object
org.jfree.chart.annotations.AbstractAnnotation
org.jfree.chart.annotations.AbstractXYAnnotation
org.jfree.chart.annotations.XYTextAnnotation
org.jfree.chart.annotations.XYPointerAnnotation
All Implemented Interfaces:
Serializable, Cloneable, Annotation, XYAnnotation, PublicCloneable
public class XYPointerAnnotation extends XYTextAnnotation implements Cloneable, PublicCloneable, Serializable
An arrow and label that can be placed on an XYPlot. The arrow is drawn at a user-definable angle so that it points towards the (x, y) location for the annotation.

The arrow length (and its offset from the (x, y) location) is controlled by the tip radius and the base radius attributes. Imagine two circles around the (x, y) coordinate: the inner circle defined by the tip radius, and the outer circle defined by the base radius. Now, draw the arrow starting at some point on the outer circle (the point is determined by the angle), with the arrow tip being drawn at a corresponding point on the inner circle.

See Also:

  • Field Details

    • DEFAULT_TIP_RADIUS

      public static final double DEFAULT_TIP_RADIUS
      The default tip radius (in Java2D units).
      See Also:

    • DEFAULT_BASE_RADIUS

      public static final double DEFAULT_BASE_RADIUS
      The default base radius (in Java2D units).
      See Also:

    • DEFAULT_LABEL_OFFSET

      public static final double DEFAULT_LABEL_OFFSET
      The default label offset (in Java2D units).
      See Also:

    • DEFAULT_ARROW_LENGTH

      public static final double DEFAULT_ARROW_LENGTH
      The default arrow length (in Java2D units).
      See Also:

    • DEFAULT_ARROW_WIDTH

      public static final double DEFAULT_ARROW_WIDTH
      The default arrow width (in Java2D units).
      See Also:

  • Constructor Details

    • XYPointerAnnotation

      public XYPointerAnnotation(String label, double x, double y, double angle)
      Creates a new label and arrow annotation.
      Parameters:
      label - the label (null permitted).
      x - the x-coordinate (measured against the chart's domain axis).
      y - the y-coordinate (measured against the chart's range axis).
      angle - the angle of the arrow's line (in radians).

  • Method Details

    • getAngle

      public double getAngle()
      Returns the angle of the arrow.
      Returns:
      The angle (in radians).
      See Also:

    • setAngle

      public void setAngle(double angle)
      Sets the angle of the arrow and sends an AnnotationChangeEvent to all registered listeners.
      Parameters:
      angle - the angle (in radians).
      See Also:

    • getTipRadius

      public double getTipRadius()
      Returns the tip radius.
      Returns:
      The tip radius (in Java2D units).
      See Also:

    • setTipRadius

      public void setTipRadius(double radius)
      Sets the tip radius and sends an AnnotationChangeEvent to all registered listeners.
      Parameters:
      radius - the radius (in Java2D units).
      See Also:

    • getBaseRadius

      public double getBaseRadius()
      Returns the base radius.
      Returns:
      The base radius (in Java2D units).
      See Also:

    • setBaseRadius

      public void setBaseRadius(double radius)
      Sets the base radius and sends an AnnotationChangeEvent to all registered listeners.
      Parameters:
      radius - the radius (in Java2D units).
      See Also:

    • getLabelOffset

      public double getLabelOffset()
      Returns the label offset.
      Returns:
      The label offset (in Java2D units).
      See Also:

    • setLabelOffset

      public void setLabelOffset(double offset)
      Sets the label offset (from the arrow base, continuing in a straight line, in Java2D units) and sends an AnnotationChangeEvent to all registered listeners.
      Parameters:
      offset - the offset (in Java2D units).
      See Also:

    • getArrowLength

      public double getArrowLength()
      Returns the arrow length.
      Returns:
      The arrow length.
      See Also:

    • setArrowLength

      public void setArrowLength(double length)
      Sets the arrow length and sends an AnnotationChangeEvent to all registered listeners.
      Parameters:
      length - the length.
      See Also:

    • getArrowWidth

      public double getArrowWidth()
      Returns the arrow width.
      Returns:
      The arrow width (in Java2D units).
      See Also:

    • setArrowWidth

      public void setArrowWidth(double width)
      Sets the arrow width and sends an AnnotationChangeEvent to all registered listeners.
      Parameters:
      width - the width (in Java2D units).
      See Also:

    • getArrowStroke

      public Stroke getArrowStroke()
      Returns the stroke used to draw the arrow line.
      Returns:
      The arrow stroke (never null).
      See Also:

    • setArrowStroke

      public void setArrowStroke(Stroke stroke)
      Sets the stroke used to draw the arrow line and sends an AnnotationChangeEvent to all registered listeners.
      Parameters:
      stroke - the stroke (null not permitted).
      See Also:

    • getArrowPaint

      public Paint getArrowPaint()
      Returns the paint used for the arrow.
      Returns:
      The arrow paint (never null).
      See Also:

    • setArrowPaint

      public void setArrowPaint(Paint paint)
      Sets the paint used for the arrow and sends an AnnotationChangeEvent to all registered listeners.
      Parameters:
      paint - the arrow paint (null not permitted).
      See Also:

    • 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
      Overrides:
      draw in class XYTextAnnotation
      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 - the plot rendering info.

    • equals

      public boolean equals(Object obj)
      Tests this annotation for equality with an arbitrary object.
      Overrides:
      equals in class XYTextAnnotation
      Parameters:
      obj - the object (null permitted).
      Returns:
      true or false.

    • hashCode

      public int hashCode()
      Returns a hash code for this instance.
      Overrides:
      hashCode in class XYTextAnnotation
      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 XYTextAnnotation
      Returns:
      A clone.
      Throws:
      CloneNotSupportedException - if the annotation can't be cloned.