| Property | Defined by | ||
|---|---|---|---|
| activeaction : Action
[read-only]
The active action that is currently handeled by the ActionsManager.
| ActionsManager | ||
| activetool : String
ID of the Active tool that is currently used by the ActionsManager.
| ActionsManager | ||
| keyboardenabled : Boolean
Indicates whether key board actions are enabled and considered by the ActionsManager.
| ActionsManager | ||
| selectionenabled : Boolean
Indicates whether selection is enabled by the ActionsManager.
| ActionsManager | ||
| Property | Defined by | ||
|---|---|---|---|
| _actions : Object = null
Array of supported Action class instances (like abort action, delete action...).
| ActionsManager | ||
| _activeaction : ComplexAction = null
The active action that is currently handeled by the ActionsManager.
| ActionsManager | ||
| _activetool : IDiagramTool = null
Active IDIagramTool used in the current Diagram View
| ActionsManager | ||
| _defaulttool : IDiagramTool = null
IDiagramTool used by default used in the current Diagram View.
| ActionsManager | ||
| _keyboardenabled : Boolean = false
True if keyborad events must be considered by this ActionManager.
| ActionsManager | ||
| _tools : Object = null
Array of supported IDiagramTool class instances (supported Diagram Tools like select tool, fill tool...).
| ActionsManager | ||
| _view : DiagramView
DiagramView in which actions are controlled and managed by the ActionsManager.
| ActionsManager | ||
| Method | Defined by | ||
|---|---|---|---|
|
ActionsManager(view:DiagramView)
Creates a new ActionsManager instance which will manage the actions
triggered in the DiagramView object
view. | ActionsManager | ||
|
abort():void
Aborts the execution of any active action and activates the
activetool. | ActionsManager | ||
|
Adds a new Action instance supported by the ActionsManager.
| ActionsManager | ||
|
addTool(tool:IDiagramTool):void
Adds a new IDiagramTool object to the list of supported IDiagramTool array.
| ActionsManager | ||
|
execute(triggerid:String):Boolean
Executes the tasks of an action identified by its ID.
| ActionsManager | ||
|
Retruns a supported Action instance and returns
null if the action is not supported. | ActionsManager | ||
|
Returns the supported IDiagramElement given its ID (null if not supported).
| ActionsManager | ||
|
reActivateDefaultTool():void
| ActionsManager | ||
|
removeAction(id:String):void
Removes an Action instance supported by the ActionManager given its ID.
| ActionsManager | ||
|
removeTool(id:String):void
Removes an IDiagramTool from the list of supported IDiagramTool array.
| ActionsManager | ||
|
rollOut(triggerid:String, dob:IDiagramElement, event:MouseEvent):void
Sets the roll out reaction given a Diagram Element, a mouse event and a triggered action.
| ActionsManager | ||
|
rollOver(triggerid:String, dob:IDiagramElement, event:MouseEvent):void
Sets the roll over reaction given a Diagram Element, a mouse event and a triggered action (given its id).
| ActionsManager | ||
|
Terminates the active action execution and activates the current view.
| ActionsManager | ||
|
triggerAction(triggerid:String, dob:IDiagramElement, event:MouseEvent, args:Array = null):void
Defines an new active action and executes it.
| ActionsManager | ||
|
updateCursor():void
| ActionsManager | ||
| Method | Defined by | ||
|---|---|---|---|
|
keyUpHandler(event:KeyboardEvent):void
Handles any keyboard event and executes it according to the supported keyboard actions (contained in the actions array).
| ActionsManager | ||
| _actions | property |
protected var _actions:Object = nullArray of supported Action class instances (like abort action, delete action...).
| _activeaction | property |
protected var _activeaction:ComplexAction = nullThe active action that is currently handeled by the ActionsManager.
| activeaction | property |
activeaction:Action [read-only]The active action that is currently handeled by the ActionsManager.
Implementation public function get activeaction():Action
| _activetool | property |
protected var _activetool:IDiagramTool = nullActive IDIagramTool used in the current Diagram View
| activetool | property |
activetool:String [read-write]ID of the Active tool that is currently used by the ActionsManager.
Implementation public function get activetool():String
public function set activetool(value:String):void
| _defaulttool | property |
protected var _defaulttool:IDiagramTool = nullIDiagramTool used by default used in the current Diagram View.
| _keyboardenabled | property |
protected var _keyboardenabled:Boolean = falseTrue if keyborad events must be considered by this ActionManager.
| keyboardenabled | property |
keyboardenabled:Boolean [read-write]Indicates whether key board actions are enabled and considered by the ActionsManager.
Implementation public function get keyboardenabled():Boolean
public function set keyboardenabled(value:Boolean):void
| selectionenabled | property |
selectionenabled:Boolean [read-write]Indicates whether selection is enabled by the ActionsManager.
Implementation public function get selectionenabled():Boolean
public function set selectionenabled(value:Boolean):void
| _tools | property |
protected var _tools:Object = nullArray of supported IDiagramTool class instances (supported Diagram Tools like select tool, fill tool...).
| _view | property |
protected var _view:DiagramViewDiagramView in which actions are controlled and managed by the ActionsManager.
| ActionsManager | () | constructor |
public function ActionsManager(view:DiagramView)
Creates a new ActionsManager instance which will manage the actions
triggered in the DiagramView object view.
view:DiagramView — A DiagramView object.
|
| abort | () | method |
public function abort():void
Aborts the execution of any active action and activates the activetool.
| addAction | () | method |
public function addAction(action:Action):voidAdds a new Action instance supported by the ActionsManager.
Parametersaction:Action — New Action to be added.
|
| addTool | () | method |
public function addTool(tool:IDiagramTool):voidAdds a new IDiagramTool object to the list of supported IDiagramTool array.
Parameterstool:IDiagramTool — New IDiagram Tool.
|
| execute | () | method |
public function execute(triggerid:String):BooleanExecutes the tasks of an action identified by its ID. This method does not support the execution of ComplexActions.
Parameterstriggerid:String — ID of the action to be executed.
|
Boolean — The Action success status.
|
| getAction | () | method |
public function getAction(id:String):Action
Retruns a supported Action instance and returns null if the action is not supported.
id:String — Action ID.
|
Action —
Requested Action instance.
|
| getTool | () | method |
public function getTool(id:String):ActionReturns the supported IDiagramElement given its ID (null if not supported).
Parametersid:String — IDiagramElement ID
|
Action —
IDiagramTool class
|
| keyUpHandler | () | method |
protected function keyUpHandler(event:KeyboardEvent):voidHandles any keyboard event and executes it according to the supported keyboard actions (contained in the actions array).
Parametersevent:KeyboardEvent — Detected KeyboardAction.
|
| reActivateDefaultTool | () | method |
public function reActivateDefaultTool():void
| removeAction | () | method |
public function removeAction(id:String):voidRemoves an Action instance supported by the ActionManager given its ID.
Parametersid:String — ID of the Action instance to be removed.
|
| removeTool | () | method |
public function removeTool(id:String):voidRemoves an IDiagramTool from the list of supported IDiagramTool array.
Parametersid:String — IDiagram Tool ID of the IDiagramTool to be removed.
|
| rollOut | () | method |
public function rollOut(triggerid:String, dob:IDiagramElement, event:MouseEvent):voidSets the roll out reaction given a Diagram Element, a mouse event and a triggered action. By default, the ActiveAction (if not null) will be considered.
Parameterstriggerid:String — ID of the triggered action (action supported by this ActionsManager).
|
|
dob:IDiagramElement — Diagram Element calling this action event.
|
|
event:MouseEvent — Detected Mouse Event
|
| rollOver | () | method |
public function rollOver(triggerid:String, dob:IDiagramElement, event:MouseEvent):voidSets the roll over reaction given a Diagram Element, a mouse event and a triggered action (given its id). By default, the ActiveAction (if not null) will be considered.
Parameterstriggerid:String — ID of the triggered action (action supported by this ActionsManager).
|
|
dob:IDiagramElement — Diagram Element calling this action event.
|
|
event:MouseEvent — Detected Mouse Event
|
| terminate | () | method |
public function terminate(action:Action):voidTerminates the active action execution and activates the current view.
Parametersaction:Action — Active Action
|
| triggerAction | () | method |
public function triggerAction(triggerid:String, dob:IDiagramElement, event:MouseEvent, args:Array = null):voidDefines an new active action and executes it.
Parameterstriggerid:String — ID of the action to trigger (action supported by this ActionsManager).
|
|
dob:IDiagramElement — Diagram Element calling this action event.
|
|
event:MouseEvent — Detected Mouse Event.
|
|
args:Array (default = null) |
| updateCursor | () | method |
public function updateCursor():void