Package com.iizix.prop.vs.actor
Class SetFocus
- java.lang.Object
- com.iizix.prop.vs.actor.AbstractVSActionActor<SetFocus.Settings>
- com.iizix.prop.vs.actor.SetFocus
- All Implemented Interfaces:
IActionActor<SetFocus.Settings>
- Direct Known Subclasses:
EditorSetFocus
public class SetFocus extends AbstractVSActionActor<SetFocus.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
SetFocus.Settings
Settings property container.
Field Summary
Fields inherited from class com.iizix.prop.vs.actor.AbstractVSActionActor
action, settings
Constructor Summary
Constructors Constructor Description SetFocus(VSAction action, SetFocus.Settings settings)
Creates a new instance.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SetFocus.Settings
createSettings()
Create the container withAtom.SETTINGS
name.boolean
doesModifyVirtualSpace()
Checks if the VirtualSpace is modified by the Action Actor.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
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
SetFocus
public SetFocus(VSAction action, SetFocus.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 SetFocus.Settings createSettings()
Create the container withAtom.SETTINGS
name.- Specified by:
createSettings
in classAbstractVSActionActor<SetFocus.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 interfaceIActionActor<SetFocus.Settings>
- Specified by:
getDefaultDescription
in classAbstractVSActionActor<SetFocus.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.
doesModifyVirtualSpace
public boolean doesModifyVirtualSpace()
Checks if the VirtualSpace is modified by the Action Actor.- Specified by:
doesModifyVirtualSpace
in interfaceIActionActor<SetFocus.Settings>
- Overrides:
doesModifyVirtualSpace
in classAbstractVSActionActor<SetFocus.Settings>
- Returns:
- true if any field in the VS is modified (excludes focus).