LegendEntry (Starjava TTOOLS API)

Skip navigation links

All Classes

SEARCH:

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

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()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- 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 label
    
    styles - dataset styles
  - LegendEntry
```
public LegendEntry(java.lang.String label,
                   Style style)
```
    Constructs a legend entry for a single style.
    
    Parameters:
    
    style - dataset style
    
    label - 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 class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2018 Central Laboratory of the Research Councils. All Rights Reserved.