TransportField (IIZI(R) 1.6.0.15561 Java API Specification)

java.lang.Object
- com.iizix.prop.vs.actor.AbstractVSActionActor<TransportField.Settings>
- - com.iizix.prop.vs.actor.TransportField

All Implemented Interfaces:
IActionActor<TransportField.Settings>
Direct Known Subclasses:
EditorTransportField
```
public class TransportField
extends AbstractVSActionActor<TransportField.Settings>
```
Action Actor for VirtualSpace performing the action as the class name says.
Author:
Christopher Mindus

Nested Class Summary
Nested Classes
Modifier and Type Class Description
static class TransportField.Settings
Settings property container.

Field Summary
- Fields inherited from class com.iizix.prop.vs.actor.AbstractVSActionActor
  action, settings

Constructor Summary
Constructors
Constructor Description
TransportField(VSAction action, TransportField.Settings settings)
Creates a new instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`TransportField.Settings`	`createSettings()`	Create the container with `Atom.SETTINGS` name.
`java.lang.String`	`getDefaultDescription()`	Gets the default description of the Action Actor to be used for the Designer or logging.
`java.lang.String`	`getEnabledState(IAppSessionGyro appGyro, VSAction action)`	Checks if the runnable is enabled for the current VirtualSpace.

Methods inherited from class com.iizix.prop.vs.actor.AbstractVSActionActor
doesModifyVirtualSpace, getDescription, newTXPNode

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

Methods inherited from interface com.iizix.actionactor.IActionActor
delegateNewTXPNode

- Constructor Detail
  - TransportField
```
public TransportField(VSAction action,
                      TransportField.Settings settings)
```
    Creates a new instance.
    Parameters:
    action - The action initiator.
    settings - The settings to use, null in the Designer instance.
- Method Detail
  - createSettings
```
public TransportField.Settings createSettings()
```
    Create the container with Atom.SETTINGS name.
    Specified by:
    createSettings in class AbstractVSActionActor<TransportField.Settings>
  - getDefaultDescription
```
public java.lang.String getDefaultDescription()
```
    Gets the default description of the Action Actor to be used for the Designer or logging.
    Specified by:
    getDefaultDescription in interface IActionActor<TransportField.Settings>
    Specified by:
    getDefaultDescription in class AbstractVSActionActor<TransportField.Settings>
    Returns:
    A short description.
  - getEnabledState
```
public java.lang.String getEnabledState(IAppSessionGyro appGyro,
                                        VSAction action)
```
    Checks if the runnable is enabled for the current VirtualSpace. This method is checked to see if the action is enabled and also in the Designer.
    Parameters:
    appGyro - The application session gyro instance.
    action - The action calling the action actor.
    Returns:
    null If enabled, otherwise an message why it's not enabled.