public class IltSymbolicState extends IltSimpleState implements Cloneable
When creating a subclass of IltSymbolicState
, you have to
statically allocate a new IltStateInfo
instance for it;
by convention this is assigned to a variable called metainfo
.
IltStateInfo
Modifier and Type | Field and Description |
---|---|
static IltStateInfo |
metainfo
Contains metainformation about this
IltState class. |
Modifier | Constructor and Description |
---|---|
protected |
IltSymbolicState() |
|
IltSymbolicState(String name,
String description,
String message,
IltSymbolicStateValue defaultValue)
Creates an
IltSymbolicState with a description and a default value. |
Modifier and Type | Method and Description |
---|---|
void |
add(IltSymbolicStateValue newValue)
Add a new value to this symbolic state.
|
Object |
clone()
Returns this object.
|
String |
getName()
Returns the name of this symbolic value.
|
String |
getToolTipText(IlpContext context,
IltObject obj)
Returns a description of the state.
|
String |
getToolTipText(IltObject obj)
Deprecated.
|
IltSymbolicStateValue |
getValue(String name)
Returns a possible value from a name
|
IltSymbolicStateValue[] |
getValues()
Return the possible values for this symbolic state.
|
boolean |
has(IltSymbolicStateValue value)
Returns
true if the value is present in the list of possible values. |
boolean |
isValid(Object value)
Returns if the given value is valid for this state.
|
void |
list(IlpContext context,
IltStateListing listing,
Object value)
Generates a plain text listing of a state.
|
void |
remove(IltSymbolicStateValue value)
Remove a value from this symbolic state.
|
void |
setName(String name)
Sets the name of this symbolic value.
|
void |
setValues(IltSymbolicStateValue[] newValues)
Set the possible values for this symbolic state.
|
Enumeration |
values()
Return the possible values for this state.
|
createValue, getDefault, hasDefault, setDefault
copy, CreateNameFilter, CreateStateFilter, equals, getAliases, getAllPaths, getAltName, getDescription, getProperty, getStateInfo, hasDescription, hashCode, intern, isInside, IsPropertyTransient, removeProperty, setAltName, setDescription, setMessage, setProperty, SetPropertyTransient, toString
public static IltStateInfo metainfo
IltState
class.protected IltSymbolicState()
public IltSymbolicState(String name, String description, String message, IltSymbolicStateValue defaultValue)
IltSymbolicState
with a description and a default value.name
- identifier of the state, used for serializationdescription
- textual description of this state.message
- catalog message representing this state.defaultValue
- optional attribute which defines a default value for this state.public String getName()
public void setName(String name)
public void add(IltSymbolicStateValue newValue)
public void remove(IltSymbolicStateValue value)
public boolean has(IltSymbolicStateValue value)
true
if the value is present in the list of possible values.public IltSymbolicStateValue getValue(String name)
public Enumeration values()
public IltSymbolicStateValue[] getValues()
null
if there are no values for this
state.public void setValues(IltSymbolicStateValue[] newValues)
public boolean isValid(Object value)
public void list(IlpContext context, IltStateListing listing, Object value)
@Deprecated public String getToolTipText(IltObject obj)
getToolTipText
in interface IltDecorationSource
getToolTipText
in class IltState
public String getToolTipText(IlpContext context, IltObject obj)
getToolTipText
in interface IltDecorationSource
getToolTipText
in class IltState
© Copyright Rogue Wave Software, Inc. 1997, 2018. All Rights Reserved.