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
,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
-
-
Field Summary
Fields Modifier and Type Field Description private Dataset
dataset
The dataset.private static long
serialVersionUID
For serialization.private java.lang.Comparable
seriesKey
The series key.
-
Constructor Summary
Constructors Constructor Description LegendItemEntity(java.awt.Shape area)
Creates a legend item entity.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
canEqual(java.lang.Object other)
Ensures symmetry between super/subclass implementations of equals.java.lang.Object
clone()
Returns a clone of the entity.boolean
equals(java.lang.Object obj)
Tests this object for equality with an arbitrary object.Dataset
getDataset()
Returns a reference to the dataset that this legend item is derived from.java.lang.Comparable
getSeriesKey()
Returns the series key that identifies the legend item.int
hashCode()
Returns a hash code for this instance.void
setDataset(Dataset dataset)
Sets a reference to the dataset that this legend item is derived from.void
setSeriesKey(java.lang.Comparable key)
Sets the key for the series.java.lang.String
toString()
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, setArea, setToolTipText, setURLText
-
-
-
-
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.
-
-
Method Detail
-
getDataset
public Dataset getDataset()
Returns a reference to the dataset that this legend item is derived from.- Returns:
- The dataset.
- 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.
-
getSeriesKey
public java.lang.Comparable getSeriesKey()
Returns the series key that identifies the legend item.- Returns:
- The series key.
- See Also:
setSeriesKey(Comparable)
-
setSeriesKey
public void setSeriesKey(java.lang.Comparable key)
Sets the key for the series.- Parameters:
key
- the key.- See Also:
getSeriesKey()
-
equals
public boolean equals(java.lang.Object obj)
Tests this object for equality with an arbitrary object.- Overrides:
equals
in classChartEntity
- 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 classChartEntity
- Parameters:
other
- Object- Returns:
- true ONLY if the parameter is THIS class type
-
hashCode
public int hashCode()
Description copied from class:ChartEntity
Returns a hash code for this instance.- Overrides:
hashCode
in classChartEntity
- Returns:
- A hash code.
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
Returns a clone of the entity.- Specified by:
clone
in interfacePublicCloneable
- Overrides:
clone
in 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:
toString
in classChartEntity
- Returns:
- A string (never
null
).
-
-