Package com.iizix.term.prop
Class TerminalActionActor
- java.lang.Object
- com.iizix.term.prop.TerminalActionActor
- All Implemented Interfaces:
IActionActor<TerminalActionActor.Settings>
- Direct Known Subclasses:
EditorTerminalActionActor
public class TerminalActionActor extends java.lang.Object implements IActionActor<TerminalActionActor.Settings>
The Action Actor for the Terminal.- Author:
- Christopher Mindus
Nested Class Summary
Nested Classes Modifier and Type Class Description static classTerminalActionActor.SettingsThe terminal action actor settings.
Constructor Summary
Constructors Modifier Constructor Description protectedTerminalActionActor(VSAction action, TerminalActionActor.Settings settings)Creates the Terminal Action Actor.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleandoesModifyVirtualSpace()Checks if the VirtualSpace is modified by the Action Actor.java.lang.StringgetDefaultDescription()Gets the default description of the Action Actor to be used for the Designer or logging.java.lang.StringgetDescription()Gets a description of the Action Actor to be used for the Designer or logging.java.lang.StringgetEnabledState(IAppSessionGyro appGyro, VSAction action)Checks if the runnable is enabled for the current VirtualSpace.AbstractActionActorTXPNode<TerminalActionActor.Settings>newTXPNode(VSActionTXProcess actionProcess, VSAction action, TerminalActionActor.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
Constructor Detail
TerminalActionActor
protected TerminalActionActor(VSAction action, TerminalActionActor.Settings settings)
Creates the Terminal Action Actor.- Parameters:
settings- The settings.action- The action.
Method Detail
newTXPNode
public AbstractActionActorTXPNode<TerminalActionActor.Settings> newTXPNode(VSActionTXProcess actionProcess, VSAction action, TerminalActionActor.Settings settings) throws java.lang.ClassNotFoundException, ActionActorException
Creates a new TXP Node instance to be used for a TXP process.- Specified by:
newTXPNodein interfaceIActionActor<TerminalActionActor.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:
java.lang.ClassNotFoundException- If the Action Actor class is not found.ActionActorException- If a new node could not be created.
getDefaultDescription
public java.lang.String getDefaultDescription()
Gets the default description of the Action Actor to be used for the Designer or logging.- Specified by:
getDefaultDescriptionin interfaceIActionActor<TerminalActionActor.Settings>- Returns:
- A short description.
getDescription
public java.lang.String getDescription()
Gets a description of the Action Actor to be used for the Designer or logging.- Specified by:
getDescriptionin interfaceIActionActor<TerminalActionActor.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.- Specified by:
getEnabledStatein interfaceIActionActor<TerminalActionActor.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<TerminalActionActor.Settings>- Returns:
- true if any component in the VS is modified (excludes focus).