Package com.iizix.prop.vs.actor
Class AbstractVSActionActor<SETTINGS extends AbstractSettings>
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 Object implements IActionActor<SETTINGS>
The VS Action Actor abstract implementation.
- Author:
- Christopher Mindus
Field Summary
FieldsConstructor Summary
ConstructorsModifierConstructorDescriptionprotectedAbstractVSActionActor(VSAction action, SETTINGS settings) Creates a new instance.Method Summary
Modifier and TypeMethodDescriptionabstract SETTINGSCreate the container withAtom.SETTINGSname.booleanChecks if the VirtualSpace is modified by the Action Actor.abstract StringGets the default description of the Action Actor to be used for the Designer or logging.Gets a description of the Action Actor to be used for the Designer or logging.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, waitMethods inherited from interface com.iizix.actionactor.IActionActor
delegateNewTXPNode, getEnabledState
Field Details
action
The action initiator.settings
The settings container.
Constructor Details
AbstractVSActionActor
Creates a new instance.- Parameters:
action- The action initiator.
Method Details
newTXPNode
public AbstractActionActorTXPNode<SETTINGS> newTXPNode(VSActionTXProcess actionProcess, VSAction action, SETTINGS settings) throws ClassNotFoundException, ActionActorException Creates a new TXP Node instance to be used for a TXP process.- Specified by:
newTXPNodein interfaceIActionActor<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:
ClassNotFoundException- If the Action Actor class is not found.ActionActorException- If a new node could not be created.
getDescription
Gets a description of the Action Actor to be used for the Designer or logging.- Specified by:
getDescriptionin interfaceIActionActor<SETTINGS extends AbstractSettings>- Returns:
- A short description.
doesModifyVirtualSpace
public boolean doesModifyVirtualSpace()Checks if the VirtualSpace is modified by the Action Actor.- Specified by:
doesModifyVirtualSpacein interfaceIActionActor<SETTINGS extends AbstractSettings>- Returns:
- true if any field in the VS is modified (excludes focus).
getDefaultDescription
Gets the default description of the Action Actor to be used for the Designer or logging.- Specified by:
getDefaultDescriptionin interfaceIActionActor<SETTINGS extends AbstractSettings>- Returns:
- A short description.
createSettings
Create the container withAtom.SETTINGSname.