Class CategoryLineAnnotation

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.lang.Comparable category1
      The category for the start of the line.
      private java.lang.Comparable category2
      The category for the end of the line.
      private java.awt.Paint paint
      The line color.
      (package private) static long serialVersionUID
      For serialization.
      private java.awt.Stroke stroke
      The line stroke.
      private double value1
      The value for the start of the line.
      private double value2
      The value for the end of the line.
    • Constructor Summary

      Constructors 
      Constructor Description
      CategoryLineAnnotation​(java.lang.Comparable category1, double value1, java.lang.Comparable category2, double value2, java.awt.Paint paint, java.awt.Stroke stroke)
      Creates a new annotation that draws a line between (category1, value1) and (category2, value2).
    • Field Detail

      • serialVersionUID

        static final long serialVersionUID
        For serialization.
        See Also:
        Constant Field Values
      • category1

        private java.lang.Comparable category1
        The category for the start of the line.
      • value1

        private double value1
        The value for the start of the line.
      • category2

        private java.lang.Comparable category2
        The category for the end of the line.
      • value2

        private double value2
        The value for the end of the line.
      • paint

        private transient java.awt.Paint paint
        The line color.
      • stroke

        private transient java.awt.Stroke stroke
        The line stroke.
    • Constructor Detail

      • CategoryLineAnnotation

        public CategoryLineAnnotation​(java.lang.Comparable category1,
                                      double value1,
                                      java.lang.Comparable category2,
                                      double value2,
                                      java.awt.Paint paint,
                                      java.awt.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 (must be finite).
        category2 - the category (null not permitted).
        value2 - the value (must be finite).
        paint - the line color (null not permitted).
        stroke - the line stroke (null not permitted).
    • Method Detail

      • getCategory1

        public java.lang.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(Comparable)
      • setCategory1

        public void setCategory1​(java.lang.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:
        getCategory1()
      • 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(double)
      • 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 (must be finite).
        See Also:
        getValue1()
      • getCategory2

        public java.lang.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(Comparable)
      • setCategory2

        public void setCategory2​(java.lang.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:
        getCategory2()
      • 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(double)
      • 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 (must be finite).
        See Also:
        getValue2()
      • getPaint

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

        public void setPaint​(java.awt.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:
        getPaint()
      • getStroke

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

        public void setStroke​(java.awt.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:
        getStroke()
      • draw

        public void draw​(java.awt.Graphics2D g2,
                         CategoryPlot plot,
                         java.awt.geom.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​(java.lang.Object obj)
        Tests this object for equality with another.
        Overrides:
        equals in class AbstractAnnotation
        Parameters:
        obj - the object (null permitted).
        Returns:
        true or false.
      • canEqual

        public boolean canEqual​(java.lang.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.
      • clone

        public java.lang.Object clone()
                               throws java.lang.CloneNotSupportedException
        Returns a clone of the annotation.
        Specified by:
        clone in interface PublicCloneable
        Overrides:
        clone in class AbstractAnnotation
        Returns:
        A clone.
        Throws:
        java.lang.CloneNotSupportedException - this class will not throw this exception, but subclasses (if any) might.
      • writeObject

        private void writeObject​(java.io.ObjectOutputStream stream)
                          throws java.io.IOException
        Provides serialization support.
        Parameters:
        stream - the output stream.
        Throws:
        java.io.IOException - if there is an I/O error.
      • readObject

        private void readObject​(java.io.ObjectInputStream stream)
                         throws java.io.IOException,
                                java.lang.ClassNotFoundException
        Provides serialization support.
        Parameters:
        stream - the input stream.
        Throws:
        java.io.IOException - if there is an I/O error.
        java.lang.ClassNotFoundException - if there is a classpath problem.