Package com.iizix.prop.vs.actor
Class HistoryForward
- java.lang.Object
- com.iizix.prop.vs.actor.AbstractVSActionActor<HistoryForward.Settings>
- com.iizix.prop.vs.actor.HistoryForward
- All Implemented Interfaces:
IActionActor<HistoryForward.Settings>
- Direct Known Subclasses:
EditorHistoryForward
public class HistoryForward extends AbstractVSActionActor<HistoryForward.Settings>
Action Actor to perform a History Forward action.- Author:
- Christopher Mindus
Nested Class Summary
Nested Classes Modifier and Type Class Description static classHistoryForward.SettingsSettings property container.
Field Summary
Fields inherited from class com.iizix.prop.vs.actor.AbstractVSActionActor
action, settings
Constructor Summary
Constructors Constructor Description HistoryForward(VSAction action, HistoryForward.Settings settings)Creates a new instance.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description HistoryForward.SettingscreateSettings()Create the container withAtom.SETTINGSname.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.StringgetEnabledState(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
HistoryForward
public HistoryForward(VSAction action, HistoryForward.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 HistoryForward.Settings createSettings()
Create the container withAtom.SETTINGSname.- Specified by:
createSettingsin classAbstractVSActionActor<HistoryForward.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:
getDefaultDescriptionin interfaceIActionActor<HistoryForward.Settings>- Specified by:
getDefaultDescriptionin classAbstractVSActionActor<HistoryForward.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:
doesModifyVirtualSpacein interfaceIActionActor<HistoryForward.Settings>- Overrides:
doesModifyVirtualSpacein classAbstractVSActionActor<HistoryForward.Settings>- Returns:
- true if any field in the VS is modified (excludes focus).