public class StringProperty extends AbstractProperty<String>
Copyright (c) 2013-2015 Delft University of Technology, PO Box 5, 2600 AA, Delft, the Netherlands. All rights reserved.
BSD-style license. See OpenTrafficSim License.
$LastChangedDate: 2015-07-26 01:01:13 +0200 (Sun, 26 Jul 2015) $, @version $Revision: 1155 $, by $Author: averbraeck $,
initial version 29 dec. 2014
Constructor and Description |
---|
StringProperty(String shortName,
String description,
String initialValue,
boolean readOnly,
int displayPriority)
Construct an StringProperty.
|
Modifier and Type | Method and Description |
---|---|
AbstractProperty<String> |
deepCopy()
Construct a deep copy of this property (duplicates everything except immutable fields).
|
String |
getDescription()
Return a description of the property (may use HTML markup).
|
String |
getShortName()
Return a short description of the property.
|
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.
|
boolean |
isReadOnly()
Return true if the property can not be altered.
|
void |
setValue(String newValue)
Change the value of the property.
|
getDisplayPriority, iterator, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
forEach, spliterator
public StringProperty(String shortName, String description, String initialValue, boolean readOnly, int displayPriority)
shortName
- String; the short name of the new StringPropertydescription
- String; description of the new StringProperty (may use HTML mark up)initialValue
- Integer; the initial value of the new StringPropertyreadOnly
- boolean; if true this StringProperty can not be altereddisplayPriority
- int; the displayPriority of the new StringPropertypublic final String getValue()
getValue
in class AbstractProperty<String>
public final String getShortName()
getShortName
in class AbstractProperty<String>
public final String getDescription()
getDescription
in class AbstractProperty<String>
public final void setValue(String newValue) throws PropertyException
setValue
in class AbstractProperty<String>
newValue
- T; the new value for the propertyPropertyException
- when this Property is read-only, or newValue is not validpublic final boolean isReadOnly()
isReadOnly
in class AbstractProperty<String>
public final String htmlStateDescription()
htmlStateDescription
in class AbstractProperty<String>
public AbstractProperty<String> deepCopy()
deepCopy
in class AbstractProperty<String>
Copyright © 2014–2015 Delft University of Technology. All rights reserved.