Package org.jfree.chart.entity
Class LegendItemEntity
- java.lang.Object
-
- org.jfree.chart.entity.ChartEntity
-
- org.jfree.chart.entity.LegendItemEntity
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Cloneable,org.jfree.util.PublicCloneable
public class LegendItemEntity extends ChartEntity implements java.lang.Cloneable, java.io.Serializable
An entity that represents an item within a legend.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description LegendItemEntity(java.awt.Shape area)Creates a legend item entity.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description java.lang.Objectclone()Returns a clone of the entity.booleanequals(java.lang.Object obj)Tests this object for equality with an arbitrary object.DatasetgetDataset()Returns a reference to the dataset that this legend item is derived from.intgetSeriesIndex()Deprecated.As of 1.0.6, use thegetSeriesKey()method.java.lang.ComparablegetSeriesKey()Returns the series key that identifies the legend item.voidsetDataset(Dataset dataset)Sets a reference to the dataset that this legend item is derived from.voidsetSeriesIndex(int index)Deprecated.As of 1.0.6, use thesetSeriesKey(Comparable)method.voidsetSeriesKey(java.lang.Comparable key)Sets the key for the series.java.lang.StringtoString()Returns a string representing this object (useful for debugging purposes).-
Methods inherited from class org.jfree.chart.entity.ChartEntity
getArea, getImageMapAreaTag, getShapeCoords, getShapeType, getToolTipText, getURLText, hashCode, setArea, setToolTipText, setURLText
-
-
-
-
Constructor Detail
-
LegendItemEntity
public LegendItemEntity(java.awt.Shape area)
Creates a legend item entity.- Parameters:
area- the area.
-
-
Method Detail
-
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(Dataset)
-
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 java.lang.Comparable getSeriesKey()
Returns the series key that identifies the legend item.- Returns:
- The series key.
- Since:
- 1.0.6
- See Also:
setSeriesKey(Comparable)
-
setSeriesKey
public void setSeriesKey(java.lang.Comparable key)
Sets the key for the series.- Parameters:
key- the key.- Since:
- 1.0.6
- See Also:
getSeriesKey()
-
getSeriesIndex
public int getSeriesIndex()
Deprecated.As of 1.0.6, use thegetSeriesKey()method.Returns the series index.- Returns:
- The series index.
- See Also:
setSeriesIndex(int)
-
setSeriesIndex
public void setSeriesIndex(int index)
Deprecated.As of 1.0.6, use thesetSeriesKey(Comparable)method.Sets the series index.- Parameters:
index- the series index.- See Also:
getSeriesIndex()
-
equals
public boolean equals(java.lang.Object obj)
Tests this object for equality with an arbitrary object.- Overrides:
equalsin classChartEntity- Parameters:
obj- the object (nullpermitted).- Returns:
- A boolean.
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
Returns a clone of the entity.- Specified by:
clonein interfaceorg.jfree.util.PublicCloneable- Overrides:
clonein classChartEntity- Returns:
- A clone.
- Throws:
java.lang.CloneNotSupportedException- if there is a problem cloning the object.
-
toString
public java.lang.String toString()
Returns a string representing this object (useful for debugging purposes).- Overrides:
toStringin classChartEntity- Returns:
- A string (never
null).
-
-