Class CategoryMarker

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable

    public class CategoryMarker
    extends Marker
    implements java.lang.Cloneable, java.io.Serializable
    A marker for a category.

    Note that for serialization to work correctly, the category key must be an instance of a serializable class.
    See Also:
    CategoryPlot.addDomainMarker(CategoryMarker), Serialized Form
    • Field Detail

      • key

        private java.lang.Comparable key
        The category key.
      • drawAsLine

        private boolean drawAsLine
        A hint that the marker should be drawn as a line rather than a region.
    • Constructor Detail

      • CategoryMarker

        public CategoryMarker​(java.lang.Comparable key)
        Creates a new category marker for the specified category.
        Parameters:
        key - the category key.
      • CategoryMarker

        public CategoryMarker​(java.lang.Comparable key,
                              java.awt.Paint paint,
                              java.awt.Stroke stroke)
        Creates a new category marker.
        Parameters:
        key - the key.
        paint - the paint (null not permitted).
        stroke - the stroke (null not permitted).
      • CategoryMarker

        public CategoryMarker​(java.lang.Comparable key,
                              java.awt.Paint paint,
                              java.awt.Stroke stroke,
                              java.awt.Paint outlinePaint,
                              java.awt.Stroke outlineStroke,
                              float alpha)
        Creates a new category marker.
        Parameters:
        key - the key.
        paint - the paint (null not permitted).
        stroke - the stroke (null not permitted).
        outlinePaint - the outline paint (null permitted).
        outlineStroke - the outline stroke (null permitted).
        alpha - the alpha transparency.
    • Method Detail

      • getKey

        public java.lang.Comparable getKey()
        Returns the key.
        Returns:
        The key.
      • setKey

        public void setKey​(java.lang.Comparable key)
        Sets the key and sends a MarkerChangeEvent to all registered listeners.
        Parameters:
        key - the key (null not permitted).
      • getDrawAsLine

        public boolean getDrawAsLine()
        Returns the flag that controls whether the marker is drawn as a region or a line.
        Returns:
        A line.
      • setDrawAsLine

        public void setDrawAsLine​(boolean drawAsLine)
        Sets the flag that controls whether the marker is drawn as a region or as a line, and sends a MarkerChangeEvent to all registered listeners.
        Parameters:
        drawAsLine - the flag.
      • equals

        public boolean equals​(java.lang.Object obj)
        Tests the marker for equality with an arbitrary object.
        Overrides:
        equals in class Marker
        Parameters:
        obj - the object (null permitted).
        Returns:
        A boolean.
      • 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 Marker
        Parameters:
        other - Object
        Returns:
        true ONLY if the parameter is THIS class type
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Marker