org.opentrafficsim.core.animation

Class TextProperties

java.lang.Object

org.opentrafficsim.core.animation.TextProperties

All Implemented Interfaces:

Serializable

public class TextProperties
extends Object
implements Serializable

Properties for text to identify animated objects in OTS.

Copyright (c) 2013-2017 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.

$LastChangedDate: 2015-07-24 02:58:59 +0200 (Fri, 24 Jul 2015) $, @version $Revision: 1147 $, by $Author: averbraeck $, initial version Jan 17, 2017

Author:

Alexander Verbraeck, Peter Knoppers, Wouter Schakel

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TextProperties() Construct a default set of text properties for animation.
TextProperties(TextAlignment textAlignment, Color color, float fontSize) Construct a set of text properties for animation with alignment, color and size.
TextProperties(TextAlignment textAlignment, Color color, float fontSize, String font, Map<TextAttribute,Object> textAttributes) Construct a set of text properties for animation with alignment, color and size.

Method Summary

Modifier and Type	Method and Description
Color	getColor()
String	getFont()
float	getFontSize()
TextAlignment	getTextAlignment()
Map<TextAttribute,Object>	getTextAttributes()
void	setBold(boolean bold) Set the weight to either WEIGHT_REGULAR or WEIGHT_BOLD.
void	setBold(TextWeight weight) Set the weight to one of multiple weight constants.
void	setItalic(boolean italic) Set the posture to either POSTURE_REGULAR or POSTURE_OBLIQUE (italic).
void	setStrikethrough(boolean strikethrough) Set the strikethrough on or off.
void	setUnderline(boolean underline) Set the underline on or off.
void	setWeightBold(TextWidth width) Set the width to WIDTH_CONDENSED, WIDTH_REGULAR, or WIDTH_EXTENDED.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TextProperties

public TextProperties()

Construct a default set of text properties for animation.

TextProperties

public TextProperties(TextAlignment textAlignment,
                      Color color,
                      float fontSize)

Construct a set of text properties for animation with alignment, color and size.

Parameters:

textAlignment - the text alignment (LEFT, CENTER or RIGHT)

color - the color of the text

fontSize - the size of the font (in units of the animation, e.g., meters)

TextProperties

public TextProperties(TextAlignment textAlignment,
                      Color color,
                      float fontSize,
                      String font,
                      Map<TextAttribute,Object> textAttributes)

Construct a set of text properties for animation with alignment, color and size.

Parameters:

textAlignment - the text alignment (LEFT, CENTER or RIGHT)

color - the color of the text, e.g., Color.RED

fontSize - the size of the font (in units of the animation, e.g., meters)

font - the name of the font, e.g., specified as Font.SERIF

textAttributes - a map of text attributes to set, e.g., UNDERLINE or WEIGHT

Method Detail

getTextAlignment

public final TextAlignment getTextAlignment()

Returns:

textAlignment

getColor

public final Color getColor()

Returns:

color

getFont

public final String getFont()

Returns:

font

getTextAttributes

public final Map<TextAttribute,Object> getTextAttributes()

Returns:

textAttributes

getFontSize

public final float getFontSize()

Returns:

fontSize

setBold

public final void setBold(boolean bold)

Set the weight to either WEIGHT_REGULAR or WEIGHT_BOLD.

Parameters:

bold - whether the font is bold or regular

setBold

public final void setBold(TextWeight weight)

Set the weight to one of multiple weight constants.

Parameters:

weight - the weight of the font to use

setItalic

public final void setItalic(boolean italic)

Set the posture to either POSTURE_REGULAR or POSTURE_OBLIQUE (italic).

Parameters:

italic - whether the font is italic or regular

setWeightBold

public final void setWeightBold(TextWidth width)

Set the width to WIDTH_CONDENSED, WIDTH_REGULAR, or WIDTH_EXTENDED.

Parameters:

width - the TextWidth to use

setUnderline

public final void setUnderline(boolean underline)

Set the underline on or off.

Parameters:

underline - whether the font is underlined or regular

setStrikethrough

public final void setStrikethrough(boolean strikethrough)

Set the strikethrough on or off.

Parameters:

strikethrough - whether the font is strikethrough or regular

toString

public final String toString()

Overrides:

toString in class Object