Class LegendItemEntity

java.lang.Object
org.jfree.chart.entity.ChartEntity
org.jfree.chart.entity.LegendItemEntity
All Implemented Interfaces:
Serializable, Cloneable, org.jfree.util.PublicCloneable

public class LegendItemEntity extends ChartEntity implements Cloneable, Serializable
An entity that represents an item within a legend.
See Also:
  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      For serialization.
      See Also:
    • dataset

      private Dataset dataset
      The dataset.
      Since:
      1.0.6
    • seriesKey

      private Comparable seriesKey
      The series key.
      Since:
      1.0.6
    • seriesIndex

      private int seriesIndex
      The series index.
  • Constructor Details

    • LegendItemEntity

      public LegendItemEntity(Shape area)
      Creates a legend item entity.
      Parameters:
      area - the area.
  • Method Details

    • getDataset

      public Dataset getDataset()
      Returns a reference to the dataset that this legend item is derived from.
      Returns:
      The dataset.
      Since:
      1.0.6
      See Also:
    • setDataset

      public void setDataset(Dataset dataset)
      Sets a reference to the dataset that this legend item is derived from.
      Parameters:
      dataset - the dataset.
      Since:
      1.0.6
    • getSeriesKey

      public Comparable getSeriesKey()
      Returns the series key that identifies the legend item.
      Returns:
      The series key.
      Since:
      1.0.6
      See Also:
    • setSeriesKey

      public void setSeriesKey(Comparable key)
      Sets the key for the series.
      Parameters:
      key - the key.
      Since:
      1.0.6
      See Also:
    • getSeriesIndex

      public int getSeriesIndex()
      Deprecated.
      As of 1.0.6, use the getSeriesKey() method.
      Returns the series index.
      Returns:
      The series index.
      See Also:
    • setSeriesIndex

      public void setSeriesIndex(int index)
      Deprecated.
      As of 1.0.6, use the setSeriesKey(Comparable) method.
      Sets the series index.
      Parameters:
      index - the series index.
      See Also:
    • equals

      public boolean equals(Object obj)
      Tests this object for equality with an arbitrary object.
      Overrides:
      equals in class ChartEntity
      Parameters:
      obj - the object (null permitted).
      Returns:
      A boolean.
    • clone

      public Object clone() throws CloneNotSupportedException
      Returns a clone of the entity.
      Specified by:
      clone in interface org.jfree.util.PublicCloneable
      Overrides:
      clone in class ChartEntity
      Returns:
      A clone.
      Throws:
      CloneNotSupportedException - if there is a problem cloning the object.
    • toString

      public String toString()
      Returns a string representing this object (useful for debugging purposes).
      Overrides:
      toString in class ChartEntity
      Returns:
      A string (never null).