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

All Implemented Interfaces:
IActionActor<SETTINGS>
Direct Known Subclasses:
HistoryBackward, HistoryForward, SetFocus, SetSourceFieldValue, SetTargetFieldValue, TransportField, TransportGroup, TransportSelectedTableRows, TransportSingleSelectedTableRow, TransportSingleSelectedTableRowAndColumnToField, TransportSingleSelectedTableRowToFields, TransportTableColumn, TransportTableRows
```
public abstract class AbstractVSActionActor<SETTINGS extends AbstractSettings>
extends java.lang.Object
implements IActionActor<SETTINGS>
```
The VS Action Actor abstract implementation.
Author:
Christopher Mindus

Field Summary
Fields
Modifier and Type Field Description
protected VSAction action
The action initiator.
protected SETTINGS settings
The settings container.

Constructor Summary
Constructors
Modifier Constructor Description
protected AbstractVSActionActor(VSAction action, SETTINGS settings)
Creates a new instance.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract SETTINGS`	`createSettings()`	Create the container with `Atom.SETTINGS` name.
`boolean`	`doesModifyVirtualSpace()`	Checks if the VirtualSpace is modified by the Action Actor.
`abstract java.lang.String`	`getDefaultDescription()`	Gets the default description of the Action Actor to be used for the Designer or logging.
`java.lang.String`	`getDescription()`	Gets a description of the Action Actor to be used for the Designer or logging.
`AbstractActionActorTXPNode<SETTINGS>`	`newTXPNode(VSActionTXProcess actionProcess, VSAction action, SETTINGS settings)`	Creates a new TXP Node instance to be used for a TXP process.

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, getEnabledState

- Field Detail
  - action
```
protected final VSAction action
```
    The action initiator.
  - settings
```
protected final SETTINGS extends AbstractSettings settings
```
    The settings container.
- Constructor Detail
  - AbstractVSActionActor
```
protected AbstractVSActionActor(VSAction action,
                                SETTINGS settings)
```
    Creates a new instance.
    Parameters:
    action - The action initiator.
- Method Detail
  - newTXPNode
```
public AbstractActionActorTXPNode<SETTINGS> newTXPNode(VSActionTXProcess actionProcess,
                                                       VSAction action,
                                                       SETTINGS settings)
                                                throws java.lang.ClassNotFoundException,
                                                       ActionActorException
```
    Creates a new TXP Node instance to be used for a TXP process.
    Specified by:
    newTXPNode in interface IActionActor<SETTINGS extends AbstractSettings>
    Parameters:
    actionProcess - The action process.
    action - The VirtualSpace Action instance that initiates the actor.
    settings - The settings for the action actor implementation.
    Returns:
    A new TXP node implementation ready to be added to a TXP process.
    Throws:
    java.lang.ClassNotFoundException - If the Action Actor class is not found.
    ActionActorException - If a new node could not be created.
  - getDescription
```
public java.lang.String getDescription()
```
    Gets a description of the Action Actor to be used for the Designer or logging.
    Specified by:
    getDescription in interface IActionActor<SETTINGS extends AbstractSettings>
    Returns:
    A short description.
  - doesModifyVirtualSpace
```
public boolean doesModifyVirtualSpace()
```
    Checks if the VirtualSpace is modified by the Action Actor.
    Specified by:
    doesModifyVirtualSpace in interface IActionActor<SETTINGS extends AbstractSettings>
    Returns:
    true if any field in the VS is modified (excludes focus).
  - getDefaultDescription
```
public abstract 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<SETTINGS extends AbstractSettings>
    Returns:
    A short description.
  - createSettings
```
public abstract SETTINGS createSettings()
```
    Create the container with Atom.SETTINGS name.

Modifier and Type	Field	Description
`protected VSAction`	`action`	The action initiator.
`protected SETTINGS`	`settings`	The settings container.

Class AbstractVSActionActor<SETTINGS extends AbstractSettings>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.iizix.actionactor.IActionActor

Field Detail

action

settings

Constructor Detail

AbstractVSActionActor

Method Detail

newTXPNode

getDescription

doesModifyVirtualSpace

getDefaultDescription

createSettings