Module platform
Package org.jfree.chart.annotations

Class CategoryLineAnnotation

java.lang.Object
org.jfree.chart.annotations.AbstractAnnotation
org.jfree.chart.annotations.CategoryLineAnnotation
All Implemented Interfaces:
Serializable, Cloneable, Annotation, CategoryAnnotation, PublicCloneable
public class CategoryLineAnnotation extends AbstractAnnotation implements CategoryAnnotation, Cloneable, PublicCloneable, Serializable
A line annotation that can be placed on a CategoryPlot.
See Also:

  • Constructor Details

    • CategoryLineAnnotation

      public CategoryLineAnnotation(Comparable category1, double value1, Comparable category2, double value2, Paint paint, Stroke stroke)
      Creates a new annotation that draws a line between (category1, value1) and (category2, value2).
      Parameters:
      category1 - the category (null not permitted).
      value1 - the value.
      category2 - the category (null not permitted).
      value2 - the value.
      paint - the line color (null not permitted).
      stroke - the line stroke (null not permitted).

  • Method Details

    • getCategory1

      public Comparable getCategory1()
      Returns the category for the start of the line.
      Returns:
      The category for the start of the line (never null).
      See Also:

    • setCategory1

      public void setCategory1(Comparable category)
      Sets the category for the start of the line and sends an AnnotationChangeEvent to all registered listeners.
      Parameters:
      category - the category (null not permitted).
      See Also:

    • getValue1

      public double getValue1()
      Returns the y-value for the start of the line.
      Returns:
      The y-value for the start of the line.
      See Also:

    • setValue1

      public void setValue1(double value)
      Sets the y-value for the start of the line and sends an AnnotationChangeEvent to all registered listeners.
      Parameters:
      value - the value.
      See Also:

    • getCategory2

      public Comparable getCategory2()
      Returns the category for the end of the line.
      Returns:
      The category for the end of the line (never null).
      See Also:

    • setCategory2

      public void setCategory2(Comparable category)
      Sets the category for the end of the line and sends an AnnotationChangeEvent to all registered listeners.
      Parameters:
      category - the category (null not permitted).
      See Also:

    • getValue2

      public double getValue2()
      Returns the y-value for the end of the line.
      Returns:
      The y-value for the end of the line.
      See Also:

    • setValue2

      public void setValue2(double value)
      Sets the y-value for the end of the line and sends an AnnotationChangeEvent to all registered listeners.
      Parameters:
      value - the value.
      See Also:

    • getPaint

      public Paint getPaint()
      Returns the paint used to draw the connecting line.
      Returns:
      The paint (never null).
      See Also:

    • setPaint

      public void setPaint(Paint paint)
      Sets the paint used to draw the connecting line and sends an AnnotationChangeEvent to all registered listeners.
      Parameters:
      paint - the paint (null not permitted).
      See Also:

    • getStroke

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

    • setStroke

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

    • draw

      public void draw(Graphics2D g2, CategoryPlot plot, Rectangle2D dataArea, CategoryAxis domainAxis, ValueAxis rangeAxis)
      Draws the annotation.
      Specified by:
      draw in interface CategoryAnnotation
      Parameters:
      g2 - the graphics device.
      plot - the plot.
      dataArea - the data area.
      domainAxis - the domain axis.
      rangeAxis - the range axis.

    • equals

      public boolean equals(Object obj)
      Tests this object for equality with another.
      Overrides:
      equals in class Object
      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 Object
      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 - this class will not throw this exception, but subclasses (if any) might.