IltState (Rogue Wave JViews 9.2 API)

java.lang.Object
- ilog.tgo.model.IltState

All Implemented Interfaces:

IltDecorationSource, IlWithProperties

Direct Known Subclasses:

IltAlarmSystem.State, IltOSI.State, IltSimpleState
```
public abstract class IltState
extends Object
implements IltDecorationSource, IlWithProperties
```
This class is the base class for all classes defining the vocabulary of an object's state.
When creating a subclass of IltState, you have to statically allocate a new IltStateInfo instance for it; by convention this is assigned to a variable called metainfo.

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`_message` Catalog message used to retrieve the state description for a specific locale
`static IltStateInfo`	`metainfo` Contains metainformation about this `IltState` class.

Constructor Summary

Constructors
Modifier Constructor and Description

protected IltState(String name, String description, String message)
Creates an IltState.

Constructors
Modifier	Constructor and Description
`protected`	`IltState(String name, String description, String message)` Creates an `IltState`.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`copy(IltState from)` Copy the values from the source state
`static IlpFilter`	`CreateNameFilter(String name)` Filter which accepts state path that match a given string representation.
`static IlpFilter`	`CreateStateFilter(IltState state)` Filter which accepts state path whose last component matches a given state.
`Object`	`createValue()` The following methods are implemented in those states that can contain other states, such as an aggregate state.
`boolean`	`equals(Object obj)` Support for hash tables
`String[]`	`getAliases()` Returns all names for the state.
`void`	`getAllPaths(Vector result, ilog.tgo.model.internal.IltStatePath parentPath, IlpFilter filter, boolean all)` This method verifies if the state being searched is this one, and if so it adds this state to the path list.
`protected String`	`getAltName()` Returns the alternate name of this symbolic value.
`Object`	`getDefault()`
`String`	`getDescription(IlpContext context)` Returns a description of the state for the application context.
`String`	`getName()` Returns the name of this symbolic value.
`Object`	`getProperty(Object name)` Returns the named property.
`IltStateInfo`	`getStateInfo()` Returns the `IltStateInfo` describing the class of this state.
`String`	`getToolTipText(IlpContext context, IltObject obj)` Returns a description of the state for the given application context.
`String`	`getToolTipText(IltObject obj)` Deprecated.
`boolean`	`hasDefault()`
`protected boolean`	`hasDescription(IlpContext context)` Returns `true` if the state contains a non-empty description.
`int`	`hashCode()` Support for hash tables
`IltState`	`intern()` Returns a canonical representation for this object.
`boolean`	`isInside(IltStateInfo superclass)` Tests whether this state belongs to a given state class.
`static boolean`	`IsPropertyTransient(Object name)` Returns whether a given named property is omitted by serialization.
`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`	`removeProperty(Object name)` Removes the named property.
`protected void`	`setAltName(String name)` Sets the alternate name of this symbolic value.
`void`	`setDescription(String d)` Sets a new description to the state.
`void`	`setMessage(String message)` Sets the localized message that describes this state.
`protected void`	`setName(String name)` Sets the name of this symbolic value.
`void`	`setProperty(Object name, Object value)` Sets the named property.
`static void`	`SetPropertyTransient(Object name, boolean isTransient)` Changes whether a given named property shall be omitted by serialization.
`String`	`toString()` Returns the String representation of this IltState's values.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - metainfo
```
public static IltStateInfo metainfo
```
    Contains metainformation about this IltState class.
    
    Internal: do not use!
  - _message
```
protected String _message
```
    Catalog message used to retrieve the state description for a specific locale
    
    Internal: do not use!
- Constructor Detail
  - IltState
```
protected IltState(String name,
                   String description,
                   String message)
```
    Creates an IltState.
    
    Parameters:
    
    name - Name of the state.
    
    description - Default description of the state, used to represent the state as a text. It is used when message is not null.
    
    message - Catalog message entry, used to retrieve the localized description of the state.
    
    Internal: do not use!
- Method Detail
  - getStateInfo
```
public IltStateInfo getStateInfo()
```
    Returns the IltStateInfo describing the class of this state.
    
    Internal: do not use!
  - isInside
```
public boolean isInside(IltStateInfo superclass)
```
    Tests whether this state belongs to a given state class.
    
    Internal: do not use!
  - intern
```
public IltState intern()
```
    Returns a canonical representation for this object.
    This function is typically used after deserialization of a state. Its use is necessary with JDK 1.1.x, and not needed any more with JDK 1.2.
  - toString
```
public String toString()
```
    Returns the String representation of this IltState's values.
    
    Overrides:
    
    toString in class Object
    
    Internal: do not use!
  - setMessage
```
public void setMessage(String message)
```
    Sets the localized message that describes this state.
    
    Internal: do not use!
  - setDescription
```
public void setDescription(String d)
```
    Sets a new description to the state.
    The description is displayed as tooltip when the state is graphically represented in the object as a secondary state.
    
    Since:
    
    JTGO 4.5
  - getDescription
```
public String getDescription(IlpContext context)
```
    Returns a description of the state for the application context.
    
    Internal: do not use!
  - hasDescription
```
protected boolean hasDescription(IlpContext context)
```
    Returns true if the state contains a non-empty description. When a description exists, the state can be represented as a text inside a information window for instance.
    
    Internal: do not use!
  - getName
```
public String getName()
```
    Returns the name of this symbolic value.
    
    Internal: do not use!
  - setName
```
protected void setName(String name)
```
    Sets the name of this symbolic value. This is meant to be called by constructors of subclasses only.
    
    Internal: do not use!
  - getAltName
```
protected String getAltName()
```
    Returns the alternate name of this symbolic value.
    
    Internal: do not use!
  - setAltName
```
protected void setAltName(String name)
```
    Sets the alternate name of this symbolic value. This is meant to be called by constructors of subclasses only.
    
    Internal: do not use!
  - getAliases
```
public String[] getAliases()
```
    Returns all names for the state.
    
    Internal: do not use!
  - copy
```
public void copy(IltState from)
```
    Copy the values from the source state
  - list
```
public void list(IlpContext context,
                 IltStateListing listing,
                 Object value)
```
    Generates a plain text listing of a state. The text is generated when the value of the state is true.
    
    Internal: do not use!
  - createValue
```
public Object createValue()
```
    The following methods are implemented in those states that can contain other states, such as an aggregate state.
    
    Internal: do not use!
  - hasDefault
```
public boolean hasDefault()
```
    Internal: do not use!
  - getDefault
```
public Object getDefault()
```
    Internal: do not use!
  - isValid
```
public boolean isValid(Object value)
```
    Returns if the given value is valid for this state.
    
    Internal: do not use!
  - equals
```
public boolean equals(Object obj)
```
    Support for hash tables
    
    Overrides:
    
    equals in class Object
    
    Internal: do not use!
  - hashCode
```
public int hashCode()
```
    Support for hash tables
    
    Overrides:
    
    hashCode in class Object
    
    Internal: do not use!
  - CreateNameFilter
```
public static IlpFilter CreateNameFilter(String name)
```
    Filter which accepts state path that match a given string representation. e.g: state path is "State.Administrative"
    
    Internal: do not use!
  - CreateStateFilter
```
public static IlpFilter CreateStateFilter(IltState state)
```
    Filter which accepts state path whose last component matches a given state. e.g: state is [State][Administrative]
    
    Internal: do not use!
  - getAllPaths
```
public void getAllPaths(Vector result,
                        ilog.tgo.model.internal.IltStatePath parentPath,
                        IlpFilter filter,
                        boolean all)
```
    This method verifies if the state being searched is this one, and if so it adds this state to the path list.
    
    Parameters:
    
    result - vector with the IltStatePath instances found
    
    parentPath - path to the parent state
    
    filter - criteria used to match the state
    
    all - flag which indicates whether the query is stopped when the first path is found or not.
    
    Internal: do not use!
  - getToolTipText
```
@Deprecated
public String getToolTipText(IltObject obj)
```
    Deprecated.
    
    Returns a description of the state for the default application context.
    
    Specified by:
    
    getToolTipText in interface IltDecorationSource
    
    Internal: do not use!
    
    Deprecated Since:
    
    JTGO 3.1
  - getToolTipText
```
public String getToolTipText(IlpContext context,
                             IltObject obj)
```
    Returns a description of the state for the given application context.
    
    Specified by:
    
    getToolTipText in interface IltDecorationSource
    
    Internal: do not use!
  - getProperty
```
public Object getProperty(Object name)
```
    Returns the named property.
    
    Specified by:
    
    getProperty in interface IlWithProperties
    
    Parameters:
    
    name - Property identifier
    
    Returns:
    
    Returns the client property value.
    
    Internal: do not use!
  - setProperty
```
public void setProperty(Object name,
                        Object value)
```
    Sets the named property.
    
    Specified by:
    
    setProperty in interface IlWithProperties
    
    Parameters:
    
    name - Property identifier
    
    value - Property value
    
    Internal: do not use!
  - removeProperty
```
public void removeProperty(Object name)
```
    Removes the named property.
    
    Specified by:
    
    removeProperty in interface IlWithProperties
    
    Internal: do not use!
  - IsPropertyTransient
```
public static boolean IsPropertyTransient(Object name)
```
    Returns whether a given named property is omitted by serialization.
    By default, all named properties are serialized.
    
    Internal: do not use!
  - SetPropertyTransient
```
public static void SetPropertyTransient(Object name,
                                        boolean isTransient)
```
    Changes whether a given named property shall be omitted by serialization.
    By default, all named properties are serialized.
    
    Internal: do not use!

Class IltState

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

metainfo

_message

Constructor Detail

IltState

Method Detail

getStateInfo

isInside

intern

toString

setMessage

setDescription

getDescription

hasDescription

getName

setName

getAltName

setAltName

getAliases

copy

list

createValue

hasDefault

getDefault

isValid

equals

hashCode

CreateNameFilter

CreateStateFilter

getAllPaths

getToolTipText

getToolTipText

getProperty

setProperty

removeProperty

IsPropertyTransient

SetPropertyTransient