org.opentrafficsim.simulationengine

Class SelectionProperty

java.lang.Object

org.opentrafficsim.simulationengine.AbstractProperty<String>

org.opentrafficsim.simulationengine.SelectionProperty

All Implemented Interfaces:

Iterable<AbstractProperty<String>>

public class SelectionProperty
extends AbstractProperty<String>

Property that is described by a set of Strings where exactly one can (and must) be true.

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

Version:

19 dec. 2014

Author:

Peter Knoppers

Constructor Summary

Constructors

Constructor and Description
SelectionProperty(String shortName, String description, String[] options, int initialDefaultOption, boolean readOnly, int displayPriority) Construct a new SelectionProperty.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Return a description of the property (may use HTML markup).
String	getOptionName(int index) Retrieve the name of one of the options of this SelectionProperty.
String[]	getOptionNames() Return the names of the options of this SelectionProperty.
String	getShortName() Return a short description of the property.
String	getValue() Retrieve the current value of the property.
boolean	isReadOnly() Return true if the property can not be altered.
void	setValue(String newValue) Change the value of the property.

Methods inherited from class org.opentrafficsim.simulationengine.AbstractProperty

getDisplayPriority, iterator, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SelectionProperty

public SelectionProperty(String shortName,
                 String description,
                 String[] options,
                 int initialDefaultOption,
                 boolean readOnly,
                 int displayPriority)

Construct a new SelectionProperty.

Parameters:

shortName - String; name of the new SelectionProperty

description - String; description of the new SelectionProperty (may use HTML mark up)

options - String[]; the possible values of the SelectionProperty

initialDefaultOption - int; the index of the initially selected option

readOnly - boolean; if true the selection cannot be altered.

displayPriority - int; the display priority of the new SelectionProperty

Method Detail

getValue

public final String getValue()

Retrieve the current value of the property.

Specified by:

getValue in class AbstractProperty<String>

Returns:

T; the current value of the property

getOptionName

public final String getOptionName(int index)

Retrieve the name of one of the options of this SelectionProperty.

Parameters:

index - int; the index of the value

Returns:

String; the name of the value at the requested index

getShortName

public final String getShortName()

Return a short description of the property.

Specified by:

getShortName in class AbstractProperty<String>

Returns:

String; a short description of the property

getDescription

public final String getDescription()

Return a description of the property (may use HTML markup).

Specified by:

getDescription in class AbstractProperty<String>

Returns:

String; the description of the property

setValue

public final void setValue(String newValue)
                    throws PropertyException

Change the value of the property.

Specified by:

setValue in class AbstractProperty<String>

Parameters:

newValue - T; the new value for the property

Throws:

PropertyException - when this Property is read-only, or newValue is not valid

getOptionNames

public final String[] getOptionNames()

Return the names of the options of this SelectionProperty.

Returns:

String[]; the names of the options of this SelectionProperty

isReadOnly

public final boolean isReadOnly()

Return true if the property can not be altered.

Specified by:

isReadOnly in class AbstractProperty<String>

Returns:

boolean; true if this property can not be altered, false if this property can be altered