Class CategoryTextAnnotation

java.lang.Object
org.jfree.chart.annotations.TextAnnotation
org.jfree.chart.annotations.CategoryTextAnnotation
All Implemented Interfaces:
Serializable, Cloneable, CategoryAnnotation

public class CategoryTextAnnotation
extends TextAnnotation
implements CategoryAnnotation, Cloneable, Serializable
A text annotation that can be placed on a CategoryPlot.
See Also:
Serialized Form
  • Constructor Details

    • CategoryTextAnnotation

      public CategoryTextAnnotation​(String text, Comparable category, double value)
      Creates a new annotation to be displayed at the given location.
      Parameters:
      text - the text.
      category - the category.
      value - the value.
  • Method Details

    • getCategory

      public Comparable getCategory()
      Returns the category.
      Returns:
      The category.
    • setCategory

      public void setCategory​(Comparable category)
      Sets the category that the annotation attaches to.
      Parameters:
      category - the category.
    • getCategoryAnchor

      public CategoryAnchor getCategoryAnchor()
      Returns the category anchor point.
      Returns:
      The category anchor point.
    • setCategoryAnchor

      public void setCategoryAnchor​(CategoryAnchor anchor)
      Sets the category anchor point.
      Parameters:
      anchor - the anchor point.
    • getValue

      public double getValue()
      Returns the value that the annotation attaches to.
      Returns:
      The value.
    • setValue

      public void setValue​(double value)
      Sets the value.
      Parameters:
      value - the value.
    • 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 object)
      Tests this object for equality with another.
      Overrides:
      equals in class TextAnnotation
      Parameters:
      object - the object to test against.
      Returns:
      true or false.
    • clone

      public Object clone() throws CloneNotSupportedException
      Returns a clone of the annotation.
      Returns:
      A clone.
      Throws:
      CloneNotSupportedException - this class will not throw this exception, but subclasses (if any) might.