Package org.jfree.chart

Class LegendItem

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable
    public class LegendItem
extends java.lang.Object
implements java.lang.Cloneable, java.io.Serializable
    A temporary storage object for recording the properties of a legend item, without any consideration for layout issues.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.text.AttributedString attributedLabel
      The attributed label (if null, fall back to the regular label).
      private Dataset dataset
      The dataset.
      private int datasetIndex
      The dataset index.
      private java.lang.String description
      The description (not currently used - could be displayed as a tool tip).
      private java.awt.Paint fillPaint
      The paint.
      private GradientPaintTransformer fillPaintTransformer
      A gradient paint transformer.
      private java.lang.String label
      The label.
      private java.awt.Font labelFont
      The label font (null is permitted).
      private java.awt.Paint labelPaint
      The label paint (null is permitted).
      private java.awt.Shape line
      The line.
      private java.awt.Paint linePaint
      The line paint.
      private java.awt.Stroke lineStroke
      The stroke.
      private boolean lineVisible
      A flag that controls whether or not the line is visible.
      private java.awt.Paint outlinePaint
      The outline paint.
      private java.awt.Stroke outlineStroke
      The outline stroke.
      private static long serialVersionUID
      For serialization.
      private int series
      The series index.
      private java.lang.Comparable seriesKey
      The series key.
      private java.awt.Shape shape
      The shape.
      private boolean shapeFilled
      A flag that controls whether or not the shape is filled.
      private boolean shapeOutlineVisible
      A flag that controls whether or not the shape outline is visible.
      private boolean shapeVisible
      A flag that controls whether or not the shape is visible.
      private java.lang.String toolTipText
      The tool tip text.
      private static java.awt.Shape UNUSED_SHAPE
      The shape must be non-null for a LegendItem - if no shape is required, use this.
      private static java.awt.Stroke UNUSED_STROKE
      The stroke must be non-null for a LegendItem - if no stroke is required, use this.
      private java.lang.String urlText
      The url text.

    • Constructor Summary

      Constructors 
      Constructor Description
      LegendItem​(java.lang.String label)
      Creates a legend item with the specified label.
      LegendItem​(java.lang.String label, java.awt.Paint paint)
      Creates a legend item with the specified label and fill paint.
      LegendItem​(java.lang.String label, java.lang.String description, java.lang.String toolTipText, java.lang.String urlText, boolean shapeVisible, java.awt.Shape shape, boolean shapeFilled, java.awt.Paint fillPaint, boolean shapeOutlineVisible, java.awt.Paint outlinePaint, java.awt.Stroke outlineStroke, boolean lineVisible, java.awt.Shape line, java.awt.Stroke lineStroke, java.awt.Paint linePaint)
      Creates a new legend item.
      LegendItem​(java.lang.String label, java.lang.String description, java.lang.String toolTipText, java.lang.String urlText, java.awt.Shape shape, java.awt.Paint fillPaint)
      Creates a legend item with a filled shape.
      LegendItem​(java.lang.String label, java.lang.String description, java.lang.String toolTipText, java.lang.String urlText, java.awt.Shape shape, java.awt.Paint fillPaint, java.awt.Stroke outlineStroke, java.awt.Paint outlinePaint)
      Creates a legend item with a filled and outlined shape.
      LegendItem​(java.lang.String label, java.lang.String description, java.lang.String toolTipText, java.lang.String urlText, java.awt.Shape line, java.awt.Stroke lineStroke, java.awt.Paint linePaint)
      Creates a legend item using a line.
      LegendItem​(java.text.AttributedString label, java.lang.String description, java.lang.String toolTipText, java.lang.String urlText, boolean shapeVisible, java.awt.Shape shape, boolean shapeFilled, java.awt.Paint fillPaint, boolean shapeOutlineVisible, java.awt.Paint outlinePaint, java.awt.Stroke outlineStroke, boolean lineVisible, java.awt.Shape line, java.awt.Stroke lineStroke, java.awt.Paint linePaint)
      Creates a new legend item.
      LegendItem​(java.text.AttributedString label, java.lang.String description, java.lang.String toolTipText, java.lang.String urlText, java.awt.Shape shape, java.awt.Paint fillPaint)
      Creates a legend item with a filled shape.
      LegendItem​(java.text.AttributedString label, java.lang.String description, java.lang.String toolTipText, java.lang.String urlText, java.awt.Shape shape, java.awt.Paint fillPaint, java.awt.Stroke outlineStroke, java.awt.Paint outlinePaint)
      Creates a legend item with a filled and outlined shape.
      LegendItem​(java.text.AttributedString label, java.lang.String description, java.lang.String toolTipText, java.lang.String urlText, java.awt.Shape line, java.awt.Stroke lineStroke, java.awt.Paint linePaint)
      Creates a legend item using a line.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      private java.lang.String characterIteratorToString​(java.text.CharacterIterator iterator)
      Returns a string containing the characters from the given iterator.
      java.lang.Object clone()
      Returns an independent copy of this object (except that the clone will still reference the same dataset as the original LegendItem).
      boolean equals​(java.lang.Object obj)
      Tests this item for equality with an arbitrary object.
      java.text.AttributedString getAttributedLabel()
      Returns the attributed label.
      Dataset getDataset()
      Returns the dataset.
      int getDatasetIndex()
      Returns the dataset index for this legend item.
      java.lang.String getDescription()
      Returns the description for the legend item.
      java.awt.Paint getFillPaint()
      Returns the fill paint.
      GradientPaintTransformer getFillPaintTransformer()
      Returns the transformer used when the fill paint is an instance of GradientPaint.
      java.lang.String getLabel()
      Returns the label.
      java.awt.Font getLabelFont()
      Returns the label font.
      java.awt.Paint getLabelPaint()
      Returns the paint used to draw the label.
      java.awt.Shape getLine()
      Returns the line.
      java.awt.Paint getLinePaint()
      Returns the paint used for lines.
      java.awt.Stroke getLineStroke()
      Returns the line stroke for the series.
      java.awt.Paint getOutlinePaint()
      Returns the outline paint.
      java.awt.Stroke getOutlineStroke()
      Returns the outline stroke.
      int getSeriesIndex()
      Returns the series index for this legend item.
      java.lang.Comparable getSeriesKey()
      Returns the series key.
      java.awt.Shape getShape()
      Returns the shape used to label the series represented by this legend item.
      java.lang.String getToolTipText()
      Returns the tool tip text.
      java.lang.String getURLText()
      Returns the URL text.
      int hashCode()  
      boolean isLineVisible()
      Returns a flag that indicates whether or not the line is visible.
      boolean isShapeFilled()
      Returns a flag that controls whether or not the shape is filled.
      boolean isShapeOutlineVisible()
      Returns the flag that controls whether or not the shape outline is visible.
      boolean isShapeVisible()
      Returns a flag that indicates whether or not the shape is visible.
      private void readObject​(java.io.ObjectInputStream stream)
      Provides serialization support.
      void setDataset​(Dataset dataset)
      Sets the dataset.
      void setDatasetIndex​(int index)
      Sets the dataset index for this legend item.
      void setDescription​(java.lang.String text)
      Sets the description for this legend item.
      void setFillPaint​(java.awt.Paint paint)
      Sets the fill paint.
      void setFillPaintTransformer​(GradientPaintTransformer transformer)
      Sets the transformer used when the fill paint is an instance of GradientPaint.
      void setLabelFont​(java.awt.Font font)
      Sets the label font.
      void setLabelPaint​(java.awt.Paint paint)
      Sets the paint used to draw the label.
      void setLine​(java.awt.Shape line)
      Sets the line.
      void setLinePaint​(java.awt.Paint paint)
      Sets the line paint.
      void setLineStroke​(java.awt.Stroke stroke)
      Sets the line stroke.
      void setLineVisible​(boolean visible)
      Sets the flag that controls whether or not the line shape is visible for this legend item.
      void setOutlinePaint​(java.awt.Paint paint)
      Sets the outline paint.
      void setOutlineStroke​(java.awt.Stroke stroke)
      Sets the outline stroke.
      void setSeriesIndex​(int index)
      Sets the series index for this legend item.
      void setSeriesKey​(java.lang.Comparable key)
      Sets the series key.
      void setShape​(java.awt.Shape shape)
      Sets the shape for the legend item.
      void setShapeVisible​(boolean visible)
      Sets the flag that controls whether or not the shape is visible.
      void setToolTipText​(java.lang.String text)
      Sets the tool tip text for this legend item.
      void setURLText​(java.lang.String text)
      Sets the URL text.
      private void writeObject​(java.io.ObjectOutputStream stream)
      Provides serialization support.

      • Methods inherited from class java.lang.Object

        finalize, getClass, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • serialVersionUID

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

      • dataset

        private Dataset dataset
        The dataset.

      • seriesKey

        private java.lang.Comparable seriesKey
        The series key.

      • datasetIndex

        private int datasetIndex
        The dataset index.

      • series

        private int series
        The series index.

      • label

        private java.lang.String label
        The label.

      • labelFont

        private java.awt.Font labelFont
        The label font (null is permitted).

      • labelPaint

        private transient java.awt.Paint labelPaint
        The label paint (null is permitted).

      • attributedLabel

        private transient java.text.AttributedString attributedLabel
        The attributed label (if null, fall back to the regular label).

      • description

        private java.lang.String description
        The description (not currently used - could be displayed as a tool tip).

      • toolTipText

        private java.lang.String toolTipText
        The tool tip text.

      • urlText

        private java.lang.String urlText
        The url text.

      • shapeVisible

        private boolean shapeVisible
        A flag that controls whether or not the shape is visible.

      • shape

        private transient java.awt.Shape shape
        The shape.

      • shapeFilled

        private boolean shapeFilled
        A flag that controls whether or not the shape is filled.

      • fillPaint

        private transient java.awt.Paint fillPaint
        The paint.

      • shapeOutlineVisible

        private boolean shapeOutlineVisible
        A flag that controls whether or not the shape outline is visible.

      • outlinePaint

        private transient java.awt.Paint outlinePaint
        The outline paint.

      • outlineStroke

        private transient java.awt.Stroke outlineStroke
        The outline stroke.

      • lineVisible

        private boolean lineVisible
        A flag that controls whether or not the line is visible.

      • line

        private transient java.awt.Shape line
        The line.

      • lineStroke

        private transient java.awt.Stroke lineStroke
        The stroke.

      • linePaint

        private transient java.awt.Paint linePaint
        The line paint.

      • UNUSED_SHAPE

        private static final java.awt.Shape UNUSED_SHAPE
        The shape must be non-null for a LegendItem - if no shape is required, use this.

      • UNUSED_STROKE

        private static final java.awt.Stroke UNUSED_STROKE
        The stroke must be non-null for a LegendItem - if no stroke is required, use this.

    • Constructor Detail

      • LegendItem

        public LegendItem​(java.lang.String label)
        Creates a legend item with the specified label. The remaining attributes take default values.
        Parameters:
        label - the label (null not permitted).

      • LegendItem

        public LegendItem​(java.lang.String label,
                  java.awt.Paint paint)
        Creates a legend item with the specified label and fill paint. The remaining attributes take default values.
        Parameters:
        label - the label (null not permitted).
        paint - the paint (null not permitted).

      • LegendItem

        public LegendItem​(java.lang.String label,
                  java.lang.String description,
                  java.lang.String toolTipText,
                  java.lang.String urlText,
                  java.awt.Shape shape,
                  java.awt.Paint fillPaint)
        Creates a legend item with a filled shape. The shape is not outlined, and no line is visible.
        Parameters:
        label - the label (null not permitted).
        description - the description (null permitted).
        toolTipText - the tool tip text (null permitted).
        urlText - the URL text (null permitted).
        shape - the shape (null not permitted).
        fillPaint - the paint used to fill the shape (null not permitted).

      • LegendItem

        public LegendItem​(java.lang.String label,
                  java.lang.String description,
                  java.lang.String toolTipText,
                  java.lang.String urlText,
                  java.awt.Shape shape,
                  java.awt.Paint fillPaint,
                  java.awt.Stroke outlineStroke,
                  java.awt.Paint outlinePaint)
        Creates a legend item with a filled and outlined shape.
        Parameters:
        label - the label (null not permitted).
        description - the description (null permitted).
        toolTipText - the tool tip text (null permitted).
        urlText - the URL text (null permitted).
        shape - the shape (null not permitted).
        fillPaint - the paint used to fill the shape (null not permitted).
        outlineStroke - the outline stroke (null not permitted).
        outlinePaint - the outline paint (null not permitted).

      • LegendItem

        public LegendItem​(java.lang.String label,
                  java.lang.String description,
                  java.lang.String toolTipText,
                  java.lang.String urlText,
                  java.awt.Shape line,
                  java.awt.Stroke lineStroke,
                  java.awt.Paint linePaint)
        Creates a legend item using a line.
        Parameters:
        label - the label (null not permitted).
        description - the description (null permitted).
        toolTipText - the tool tip text (null permitted).
        urlText - the URL text (null permitted).
        line - the line (null not permitted).
        lineStroke - the line stroke (null not permitted).
        linePaint - the line paint (null not permitted).

      • LegendItem

        public LegendItem​(java.lang.String label,
                  java.lang.String description,
                  java.lang.String toolTipText,
                  java.lang.String urlText,
                  boolean shapeVisible,
                  java.awt.Shape shape,
                  boolean shapeFilled,
                  java.awt.Paint fillPaint,
                  boolean shapeOutlineVisible,
                  java.awt.Paint outlinePaint,
                  java.awt.Stroke outlineStroke,
                  boolean lineVisible,
                  java.awt.Shape line,
                  java.awt.Stroke lineStroke,
                  java.awt.Paint linePaint)
        Creates a new legend item.
        Parameters:
        label - the label (null not permitted).
        description - the description (not currently used, null permitted).
        toolTipText - the tool tip text (null permitted).
        urlText - the URL text (null permitted).
        shapeVisible - a flag that controls whether or not the shape is displayed.
        shape - the shape (null permitted).
        shapeFilled - a flag that controls whether or not the shape is filled.
        fillPaint - the fill paint (null not permitted).
        shapeOutlineVisible - a flag that controls whether or not the shape is outlined.
        outlinePaint - the outline paint (null not permitted).
        outlineStroke - the outline stroke (null not permitted).
        lineVisible - a flag that controls whether or not the line is visible.
        line - the line.
        lineStroke - the stroke (null not permitted).
        linePaint - the line paint (null not permitted).

      • LegendItem

        public LegendItem​(java.text.AttributedString label,
                  java.lang.String description,
                  java.lang.String toolTipText,
                  java.lang.String urlText,
                  java.awt.Shape shape,
                  java.awt.Paint fillPaint)
        Creates a legend item with a filled shape. The shape is not outlined, and no line is visible.
        Parameters:
        label - the label (null not permitted).
        description - the description (null permitted).
        toolTipText - the tool tip text (null permitted).
        urlText - the URL text (null permitted).
        shape - the shape (null not permitted).
        fillPaint - the paint used to fill the shape (null not permitted).

      • LegendItem

        public LegendItem​(java.text.AttributedString label,
                  java.lang.String description,
                  java.lang.String toolTipText,
                  java.lang.String urlText,
                  java.awt.Shape shape,
                  java.awt.Paint fillPaint,
                  java.awt.Stroke outlineStroke,
                  java.awt.Paint outlinePaint)
        Creates a legend item with a filled and outlined shape.
        Parameters:
        label - the label (null not permitted).
        description - the description (null permitted).
        toolTipText - the tool tip text (null permitted).
        urlText - the URL text (null permitted).
        shape - the shape (null not permitted).
        fillPaint - the paint used to fill the shape (null not permitted).
        outlineStroke - the outline stroke (null not permitted).
        outlinePaint - the outline paint (null not permitted).

      • LegendItem

        public LegendItem​(java.text.AttributedString label,
                  java.lang.String description,
                  java.lang.String toolTipText,
                  java.lang.String urlText,
                  java.awt.Shape line,
                  java.awt.Stroke lineStroke,
                  java.awt.Paint linePaint)
        Creates a legend item using a line.
        Parameters:
        label - the label (null not permitted).
        description - the description (null permitted).
        toolTipText - the tool tip text (null permitted).
        urlText - the URL text (null permitted).
        line - the line (null not permitted).
        lineStroke - the line stroke (null not permitted).
        linePaint - the line paint (null not permitted).

      • LegendItem

        public LegendItem​(java.text.AttributedString label,
                  java.lang.String description,
                  java.lang.String toolTipText,
                  java.lang.String urlText,
                  boolean shapeVisible,
                  java.awt.Shape shape,
                  boolean shapeFilled,
                  java.awt.Paint fillPaint,
                  boolean shapeOutlineVisible,
                  java.awt.Paint outlinePaint,
                  java.awt.Stroke outlineStroke,
                  boolean lineVisible,
                  java.awt.Shape line,
                  java.awt.Stroke lineStroke,
                  java.awt.Paint linePaint)
        Creates a new legend item.
        Parameters:
        label - the label (null not permitted).
        description - the description (not currently used, null permitted).
        toolTipText - the tool tip text (null permitted).
        urlText - the URL text (null permitted).
        shapeVisible - a flag that controls whether or not the shape is displayed.
        shape - the shape (null permitted).
        shapeFilled - a flag that controls whether or not the shape is filled.
        fillPaint - the fill paint (null not permitted).
        shapeOutlineVisible - a flag that controls whether or not the shape is outlined.
        outlinePaint - the outline paint (null not permitted).
        outlineStroke - the outline stroke (null not permitted).
        lineVisible - a flag that controls whether or not the line is visible.
        line - the line (null not permitted).
        lineStroke - the stroke (null not permitted).
        linePaint - the line paint (null not permitted).

    • Method Detail

      • characterIteratorToString

        private java.lang.String characterIteratorToString​(java.text.CharacterIterator iterator)
        Returns a string containing the characters from the given iterator.
        Parameters:
        iterator - the iterator (null not permitted).
        Returns:
        A string.

      • setDataset

        public void setDataset​(Dataset dataset)
        Sets the dataset.
        Parameters:
        dataset - the dataset.

      • getDatasetIndex

        public int getDatasetIndex()
        Returns the dataset index for this legend item.
        Returns:
        The dataset index.
        See Also:
        setDatasetIndex(int), getDataset()

      • setDatasetIndex

        public void setDatasetIndex​(int index)
        Sets the dataset index for this legend item.
        Parameters:
        index - the index.
        See Also:
        getDatasetIndex()

      • getSeriesKey

        public java.lang.Comparable getSeriesKey()
        Returns the series key.
        Returns:
        The series key.
        See Also:
        setSeriesKey(Comparable)

      • setSeriesKey

        public void setSeriesKey​(java.lang.Comparable key)
        Sets the series key.
        Parameters:
        key - the series key.

      • getSeriesIndex

        public int getSeriesIndex()
        Returns the series index for this legend item.
        Returns:
        The series index.

      • setSeriesIndex

        public void setSeriesIndex​(int index)
        Sets the series index for this legend item.
        Parameters:
        index - the index.

      • getLabel

        public java.lang.String getLabel()
        Returns the label.
        Returns:
        The label (never null).

      • getLabelFont

        public java.awt.Font getLabelFont()
        Returns the label font.
        Returns:
        The label font (possibly null).

      • setLabelFont

        public void setLabelFont​(java.awt.Font font)
        Sets the label font.
        Parameters:
        font - the font (null permitted).

      • getLabelPaint

        public java.awt.Paint getLabelPaint()
        Returns the paint used to draw the label.
        Returns:
        The paint (possibly null).

      • setLabelPaint

        public void setLabelPaint​(java.awt.Paint paint)
        Sets the paint used to draw the label.
        Parameters:
        paint - the paint (null permitted).

      • getAttributedLabel

        public java.text.AttributedString getAttributedLabel()
        Returns the attributed label.
        Returns:
        The attributed label (possibly null).

      • getDescription

        public java.lang.String getDescription()
        Returns the description for the legend item.
        Returns:
        The description (possibly null).
        See Also:
        setDescription(java.lang.String)

      • setDescription

        public void setDescription​(java.lang.String text)
        Sets the description for this legend item.
        Parameters:
        text - the description (null permitted).
        See Also:
        getDescription()

      • getToolTipText

        public java.lang.String getToolTipText()
        Returns the tool tip text.
        Returns:
        The tool tip text (possibly null).
        See Also:
        setToolTipText(java.lang.String)

      • setToolTipText

        public void setToolTipText​(java.lang.String text)
        Sets the tool tip text for this legend item.
        Parameters:
        text - the text (null permitted).
        See Also:
        getToolTipText()

      • getURLText

        public java.lang.String getURLText()
        Returns the URL text.
        Returns:
        The URL text (possibly null).
        See Also:
        setURLText(java.lang.String)

      • setURLText

        public void setURLText​(java.lang.String text)
        Sets the URL text.
        Parameters:
        text - the text (null permitted).
        See Also:
        getURLText()

      • isShapeVisible

        public boolean isShapeVisible()
        Returns a flag that indicates whether or not the shape is visible.
        Returns:
        A boolean.
        See Also:
        setShapeVisible(boolean)

      • setShapeVisible

        public void setShapeVisible​(boolean visible)
        Sets the flag that controls whether or not the shape is visible.
        Parameters:
        visible - the new flag value.
        See Also:
        isShapeVisible(), isLineVisible()

      • getShape

        public java.awt.Shape getShape()
        Returns the shape used to label the series represented by this legend item.
        Returns:
        The shape (never null).
        See Also:
        setShape(java.awt.Shape)

      • setShape

        public void setShape​(java.awt.Shape shape)
        Sets the shape for the legend item.
        Parameters:
        shape - the shape (null not permitted).
        See Also:
        getShape()

      • isShapeFilled

        public boolean isShapeFilled()
        Returns a flag that controls whether or not the shape is filled.
        Returns:
        A boolean.

      • getFillPaint

        public java.awt.Paint getFillPaint()
        Returns the fill paint.
        Returns:
        The fill paint (never null).

      • setFillPaint

        public void setFillPaint​(java.awt.Paint paint)
        Sets the fill paint.
        Parameters:
        paint - the paint (null not permitted).

      • isShapeOutlineVisible

        public boolean isShapeOutlineVisible()
        Returns the flag that controls whether or not the shape outline is visible.
        Returns:
        A boolean.

      • getLineStroke

        public java.awt.Stroke getLineStroke()
        Returns the line stroke for the series.
        Returns:
        The stroke (never null).

      • setLineStroke

        public void setLineStroke​(java.awt.Stroke stroke)
        Sets the line stroke.
        Parameters:
        stroke - the stroke (null not permitted).

      • getLinePaint

        public java.awt.Paint getLinePaint()
        Returns the paint used for lines.
        Returns:
        The paint (never null).

      • setLinePaint

        public void setLinePaint​(java.awt.Paint paint)
        Sets the line paint.
        Parameters:
        paint - the paint (null not permitted).

      • getOutlinePaint

        public java.awt.Paint getOutlinePaint()
        Returns the outline paint.
        Returns:
        The outline paint (never null).

      • setOutlinePaint

        public void setOutlinePaint​(java.awt.Paint paint)
        Sets the outline paint.
        Parameters:
        paint - the paint (null not permitted).

      • getOutlineStroke

        public java.awt.Stroke getOutlineStroke()
        Returns the outline stroke.
        Returns:
        The outline stroke (never null).
        See Also:
        setOutlineStroke(java.awt.Stroke)

      • setOutlineStroke

        public void setOutlineStroke​(java.awt.Stroke stroke)
        Sets the outline stroke.
        Parameters:
        stroke - the stroke (null not permitted).
        See Also:
        getOutlineStroke()

      • isLineVisible

        public boolean isLineVisible()
        Returns a flag that indicates whether or not the line is visible.
        Returns:
        A boolean.
        See Also:
        setLineVisible(boolean)

      • setLineVisible

        public void setLineVisible​(boolean visible)
        Sets the flag that controls whether or not the line shape is visible for this legend item.
        Parameters:
        visible - the new flag value.
        See Also:
        isLineVisible()

      • setLine

        public void setLine​(java.awt.Shape line)
        Sets the line.
        Parameters:
        line - the line (null not permitted).
        See Also:
        getLine()

      • setFillPaintTransformer

        public void setFillPaintTransformer​(GradientPaintTransformer transformer)
        Sets the transformer used when the fill paint is an instance of GradientPaint.
        Parameters:
        transformer - the transformer (null not permitted).
        See Also:
        getFillPaintTransformer()

      • equals

        public boolean equals​(java.lang.Object obj)
        Tests this item for equality with an arbitrary object.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        obj - the object (null permitted).
        Returns:
        A boolean.

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • clone

        public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
        Returns an independent copy of this object (except that the clone will still reference the same dataset as the original LegendItem).
        Overrides:
        clone in class java.lang.Object
        Returns:
        A clone.
        Throws:
        java.lang.CloneNotSupportedException - if the legend item cannot be cloned.

      • writeObject

        private void writeObject​(java.io.ObjectOutputStream stream)
                  throws java.io.IOException
        Provides serialization support.
        Parameters:
        stream - the output stream (null not permitted).
        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 (null not permitted).
        Throws:
        java.io.IOException - if there is an I/O error.
        java.lang.ClassNotFoundException - if there is a classpath problem.