Package org.opentrafficsim.core.animation.gtu.colorer

Class GTUColorer.LegendEntry

  • All Implemented Interfaces:
    java.io.Serializable
    Enclosing interface:
    GTUColorer
    public static class GTUColorer.LegendEntry
extends java.lang.Object
implements java.io.Serializable
    Packs a Color, a short description and a long description in one object.

    Copyright (c) 2013-2020 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​(java.awt.Color color, java.lang.String name, java.lang.String description)
      Construct a new LegendEntry.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.awt.Color getColor()  
      java.lang.String getDescription()  
      java.lang.String getName()  
      java.lang.String toString()

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • LegendEntry

        public LegendEntry​(java.awt.Color color,
                   java.lang.String name,
                   java.lang.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 java.awt.Color getColor()
        Returns:
        Color; the color of this LegendEntry

      • getName

        public final java.lang.String getName()
        Returns:
        name.

      • getDescription

        public final java.lang.String getDescription()
        Returns:
        description.

      • toString

        public final java.lang.String toString()
        Overrides:
        toString in class java.lang.Object