Package com.iizix.actionactor
Class JavaActionActorBase
java.lang.Object
com.iizix.actionactor.JavaActionActorBase
- All Implemented Interfaces:
IActionActor<JavaActionActorBase.Settings>
- Direct Known Subclasses:
EditorJavaActionActor
public class JavaActionActorBase extends Object implements IActionActor<JavaActionActorBase.Settings>
Custom Java-based Action Actor as provided by a user class.
- Author:
- Christopher Mindus
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classSettings property container.Field Summary
FieldsConstructor Summary
ConstructorsConstructorDescriptionJavaActionActorBase(VSAction action, JavaActionActorBase.Settings settings) Creates a new instance.Method Summary
Modifier and TypeMethodDescriptionbooleanChecks if the VirtualSpace is modified by the Action Actor.Gets a 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.getEnabledState(IAppSessionGyro appGyro, VSAction action) Checks if the runnable is enabled for the current VirtualSpace.newTXPNode(VSActionTXProcess actionProcess, VSAction action, JavaActionActorBase.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
Field Details
ACTOR_CLASS
Property for the actor class name.- See Also:
Constructor Details
JavaActionActorBase
Creates a new instance.- Parameters:
action- The action initiator.settings- The settings to use, null in the Designer instance.
Method Details
newTXPNode
public AbstractJavaActionActor newTXPNode(VSActionTXProcess actionProcess, VSAction action, JavaActionActorBase.Settings settings) throws ClassNotFoundException, ActionActorException Creates a new TXP Node instance to be used for a TXP process.- Specified by:
newTXPNodein interfaceIActionActor<JavaActionActorBase.Settings>- 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.
getDefaultDescription
Gets a description of the Action Actor to be used for the Designer or logging.- Specified by:
getDefaultDescriptionin interfaceIActionActor<JavaActionActorBase.Settings>- Returns:
- A short description.
getDescription
Gets a description of the Action Actor to be used for the Designer or logging.- Specified by:
getDescriptionin interfaceIActionActor<JavaActionActorBase.Settings>- Returns:
- A short description.
getEnabledState
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.- Specified by:
getEnabledStatein interfaceIActionActor<JavaActionActorBase.Settings>- 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.
doesModifyVirtualSpace
public boolean doesModifyVirtualSpace()Checks if the VirtualSpace is modified by the Action Actor.- Specified by:
doesModifyVirtualSpacein interfaceIActionActor<JavaActionActorBase.Settings>- Returns:
- true if any field in the VS is modified (excludes focus).