Package | org.robotlegs.utilities.undoablecommand |
Class | public class HistoryEvent |
Inheritance | HistoryEvent ![]() ![]() |
Method | Defined By | ||
---|---|---|---|
HistoryEvent(type:String, command:IUndoableCommand = null) | HistoryEvent |
Constant | Defined By | ||
---|---|---|---|
![]() | CANCELLED : String = executeCancelled [static]
CommandEvent of this type will be fired when execution of a command was cancelled. | CommandEvent | |
![]() | EXECUTE_COMPLETE : String = executeComplete [static]
CommandEvent of this type will be fired when a command has completed executing/redoing. | CommandEvent | |
FAST_FORWARD : String = fastForward [static]
You should map this event to a command to trigger a fast-forward action. | HistoryEvent | ||
FAST_FORWARD_COMPLETE : String = fastForwardComplete [static]
HistoryEvent with this type will be fired when a fast forward completes. | HistoryEvent | ||
REWIND : String = rewind [static]
You should map this event to a command to trigger a rewind action. | HistoryEvent | ||
REWIND_COMPLETE : String = rewindComplete [static]
HistoryEvent with this type will be fired when a rewind completes. | HistoryEvent | ||
STEP_BACKWARD : String = stepBackward [static]
You should Map this event to StepBackwardCommand to trigger an undo action. | HistoryEvent | ||
STEP_BACKWARD_COMPLETE : String = stepBackwardComplete [static]
HistoryEvent with this type will be fired each time a command is undone. | HistoryEvent | ||
STEP_FORWARD : String = stepForward [static]
You should map this event to a StepForwardCommand to trigger a redo action. | HistoryEvent | ||
STEP_FORWARD_COMPLETE : String = stepForwardComplete [static]
HistoryEvent with this type will be fired each time a command is executed/redone. | HistoryEvent | ||
![]() | UNDO_EXECUTE_COMPLETE : String = undoExecuteComplete [static]
CommandEvent of this type will be fired when a command has completed undoing. | CommandEvent |
HistoryEvent | () | Constructor |
public function HistoryEvent(type:String, command:IUndoableCommand = null)
type:String | |
command:IUndoableCommand (default = null )
|
FAST_FORWARD | Constant |
public static const FAST_FORWARD:String = fastForward
You should map this event to a command to trigger a fast-forward action. Provided for convenience. Is not fired internally. TODO: Create a default FastForwardCommand
FAST_FORWARD_COMPLETE | Constant |
public static const FAST_FORWARD_COMPLETE:String = fastForwardComplete
HistoryEvent with this type will be fired when a fast forward completes.
REWIND | Constant |
public static const REWIND:String = rewind
You should map this event to a command to trigger a rewind action. Provided for convenience. Is not fired internally. TODO: Create a default RewindCommand
REWIND_COMPLETE | Constant |
public static const REWIND_COMPLETE:String = rewindComplete
HistoryEvent with this type will be fired when a rewind completes.
STEP_BACKWARD | Constant |
public static const STEP_BACKWARD:String = stepBackward
You should Map this event to StepBackwardCommand to trigger an undo action.
Provided for convenience. Is not fired internally.
// In your Robotlegs context:
commandMap.mapEvent(HistoryEvent.STEP_BACKWARD, StepBackwardCommand, HistoryEvent);
STEP_BACKWARD_COMPLETE | Constant |
public static const STEP_BACKWARD_COMPLETE:String = stepBackwardComplete
HistoryEvent with this type will be fired each time a command is undone. HistoryEvent with this type will be fired multiple times if performing a multi-step rewind.
STEP_FORWARD | Constant |
public static const STEP_FORWARD:String = stepForward
You should map this event to a StepForwardCommand to trigger a redo action.
Provided for convenience. Is not fired internally.
// In your Robotlegs context:
commandMap.mapEvent(HistoryEvent.STEP_FORWARD, StepForwardCommand, HistoryEvent);
STEP_FORWARD_COMPLETE | Constant |
public static const STEP_FORWARD_COMPLETE:String = stepForwardComplete
HistoryEvent with this type will be fired each time a command is executed/redone. HistoryEvent with this type will be fired multiple times if performing a multi-step fast-forward.