public class SelectionProperty extends AbstractProperty<String> implements Serializable
Copyright (c) 2013-2018 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.
$LastChangedDate: 2016-05-28 11:33:31 +0200 (Sat, 28 May 2016) $, @version $Revision: 2051 $, by $Author: averbraeck $,
initial version 19 dec. 2014
| Constructor and Description |
|---|
SelectionProperty(String key,
String shortName,
String description,
String[] options,
int initialDefaultOption,
boolean readOnly,
int displayPriority)
Construct a new SelectionProperty.
|
| Modifier and Type | Method and Description |
|---|---|
AbstractProperty<String> |
deepCopy()
Construct a deep copy of this property (duplicates everything except immutable fields).
|
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 |
getValue()
Retrieve the current value of the property.
|
String |
htmlStateDescription()
Generate a description of the state of this property in HTML (excluding the <html> at the start and the
</html> at the end.
|
void |
setValue(String newValue)
Change the value of the property.
|
findByKey, getDescription, getDisplayPriority, getKey, getParent, getShortName, isReadOnly, iterator, setParent, setReadOnly, toStringclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitforEach, spliteratorpublic SelectionProperty(String key, String shortName, String description, String[] options, int initialDefaultOption, boolean readOnly, int displayPriority)
key - String; the unique key of the new propertyshortName - String; name of the new SelectionPropertydescription - String; description of the new SelectionProperty (may use HTML mark up)options - String[]; the possible values of the SelectionPropertyinitialDefaultOption - int; the index of the initially selected optionreadOnly - boolean; if true the selection cannot be altered.displayPriority - int; the display priority of the new SelectionPropertypublic final String getValue()
public final String getOptionName(int index)
index - int; the index of the valuepublic final void setValue(String newValue) throws PropertyException
setValue in interface Property<String>newValue - T; the new value for the propertyPropertyException - when this Property is read-only, or newValue is not validpublic final String[] getOptionNames()
public final String htmlStateDescription()
htmlStateDescription in interface Property<String>htmlStateDescription in class AbstractProperty<String>public final AbstractProperty<String> deepCopy()
Copyright © 2014–2018 Delft University of Technology. All rights reserved.