Package org.jfree.chart.annotations

Class XYLineAnnotation

java.lang.Object
org.jfree.chart.annotations.AbstractAnnotation
org.jfree.chart.annotations.AbstractXYAnnotation
org.jfree.chart.annotations.XYLineAnnotation
All Implemented Interfaces:
Serializable, Cloneable, Annotation, XYAnnotation, PublicCloneable
public class XYLineAnnotation extends AbstractXYAnnotation implements Cloneable, PublicCloneable, Serializable
A simple line annotation that can be placed on an XYPlot. Instances of this class are immutable.
See Also:

  • Constructor Details

    • XYLineAnnotation

      public XYLineAnnotation(double x1, double y1, double x2, double y2)
      Creates a new annotation that draws a line from (x1, y1) to (x2, y2) where the coordinates are measured in data space (that is, against the plot's axes). All the line coordinates are required to be finite values.
      Parameters:
      x1 - the x-coordinate for the start of the line.
      y1 - the y-coordinate for the start of the line.
      x2 - the x-coordinate for the end of the line.
      y2 - the y-coordinate for the end of the line.

    • XYLineAnnotation

      public XYLineAnnotation(double x1, double y1, double x2, double y2, Stroke stroke, Paint paint)
      Creates a new annotation that draws a line from (x1, y1) to (x2, y2) where the coordinates are measured in data space (that is, against the plot's axes).
      Parameters:
      x1 - the x-coordinate for the start of the line (must be finite).
      y1 - the y-coordinate for the start of the line (must be finite).
      x2 - the x-coordinate for the end of the line (must be finite).
      y2 - the y-coordinate for the end of the line (must be finite).
      stroke - the line stroke (null not permitted).
      paint - the line color (null not permitted).

  • Method Details

    • getX1

      public double getX1()
      Returns the x-coordinate for the starting point of the line (set in the constructor).
      Returns:
      The x-coordinate for the starting point of the line.

    • getY1

      public double getY1()
      Returns the y-coordinate for the starting point of the line (set in the constructor).
      Returns:
      The y-coordinate for the starting point of the line.

    • getX2

      public double getX2()
      Returns the x-coordinate for the ending point of the line (set in the constructor).
      Returns:
      The x-coordinate for the ending point of the line.

    • getY2

      public double getY2()
      Returns the y-coordinate for the ending point of the line (set in the constructor).
      Returns:
      The y-coordinate for the ending point of the line.

    • getStroke

      public Stroke getStroke()
      Returns the stroke used for drawing the line (set in the constructor).
      Returns:
      The stroke (never null).

    • getPaint

      public Paint getPaint()
      Returns the paint used for drawing the line (set in the constructor).
      Returns:
      The paint (never null).

    • 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 XYPlot class, you won't normally need to call it yourself.
      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 to test against (null permitted).
      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.