Package uk.ac.starlink.ttools.plot2
Class LegendEntry
- java.lang.Object
-
- uk.ac.starlink.ttools.plot2.LegendEntry
-
@Equality public class LegendEntry extends java.lang.Object
Aggregates a plot style or group of styles and a label to be paired together as one entry in a plot legend.- Since:
- 13 Feb 2013
- Author:
- Mark Taylor
-
-
Constructor Summary
Constructors Constructor Description LegendEntry(java.lang.String label, Style style)
Constructs a legend entry for a single style.LegendEntry(java.lang.String label, Style[] styles)
Constructs a legend entry for a group of styles.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(java.lang.Object o)
javax.swing.Icon
getIcon()
Returns the icon associated with this entry.java.lang.String
getLabel()
Returns the text label associated with this entry.int
hashCode()
-
-
-
Constructor Detail
-
LegendEntry
public LegendEntry(java.lang.String label, Style[] styles)
Constructs a legend entry for a group of styles. This would typically be used where the same data set is represented by several different layers in a plot.- Parameters:
label
- dataset labelstyles
- dataset styles
-
LegendEntry
public LegendEntry(java.lang.String label, Style style)
Constructs a legend entry for a single style.- Parameters:
style
- dataset stylelabel
- dataset label
-
-
Method Detail
-
getIcon
public javax.swing.Icon getIcon()
Returns the icon associated with this entry.- Returns:
- icon
-
getLabel
public java.lang.String getLabel()
Returns the text label associated with this entry.- Returns:
- label
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
-