GTUColorer.LegendEntry (OTS generic animation classes 1.05.00 API)

java.lang.Object
- org.opentrafficsim.core.animation.gtu.colorer.GTUColorer.LegendEntry

All Implemented Interfaces:

Serializable

Enclosing interface:

GTUColorer
```
public static class GTUColorer.LegendEntry
extends Object
implements Serializable
```
Packs a Color, a short description and a long description in one object.
Copyright (c) 2013-2022 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved. BSD-style license. See OpenTrafficSim License.

Version:

$Revision: 4763 $, $LastChangedDate: 2018-11-19 11:04:56 +0100 (Mon, 19 Nov 2018) $, by $Author: averbraeck $, initial version 27 mei 2015

Author:

Alexander Verbraeck, Peter Knoppers

See Also:

Serialized Form

- Constructor Summary
  
  Constructors
  Constructor Description
  
  LegendEntry(Color color, String name, String description)
  Construct a new LegendEntry.
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  Color getColor()
  
  String getDescription()
  
  String getName()
  
  String toString()
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - LegendEntry
```
public LegendEntry(Color color,
                   String name,
                   String description)
```
    Construct a new LegendEntry.
    
    Parameters:
    
    color - Color; the color of the new LegendEntry
    
    name - String; the name of the new LegendEntry (should be terse)
    
    description - String; description of the new LegendEntry (may use HTML)
- Method Detail
  - getColor
```
public final Color getColor()
```
    Returns:
    
    Color; the color of this LegendEntry
  - getName
```
public final String getName()
```
    Returns:
    
    name.
  - getDescription
```
public final String getDescription()
```
    Returns:
    
    description.
  - toString
```
public final String toString()
```
    Overrides:
    
    toString in class Object