Packagecom.kapit.diagram.actions
Classpublic class Action
SubclassesComplexAction, KeyboardAction


Public Properties
 PropertyDefined by
  id : String
[read-only] ID of this action.
Action
  manager : ActionsManager
The ActionsManager instance controlling this action (cursors, properties...).
Action
  source : IDiagramElement
[read-only] The DiagramElement instance that has triggered this action.
Action
  view : DiagramView
The DiagramView instance where this action has been triggered.
Action
Protected Properties
 PropertyDefined by
  _id : String
ID reference of the action.
Action
  _manager : ActionsManager = null
ActionsManager dealing with the control of this action.
Action
  _source : IDiagramElement = null
The DiagramElement that has triggered this action.
Action
  _view : DiagramView
The DiagramView where this action has been triggered.
Action
Public Methods
 MethodDefined by
  
Action(id:String)
Creates a new Action instance having id as ID.
Action
  
abort():void
Terminates the execution of this action with success equal to false.
Action
  
execute(dob:IDiagramElement = null, event:Event = null, args:Array = null):Boolean
Executes the tasks of this action.
Action
  
terminate(success:Boolean):void
Terminates the execution of this action with a termination status equal to success.
Action
Property detail
_idproperty
protected var _id:String

ID reference of the action.

idproperty 
id:String  [read-only]

ID of this action.

Implementation
    public function get id():String
_managerproperty 
protected var _manager:ActionsManager = null

ActionsManager dealing with the control of this action.

managerproperty 
manager:ActionsManager  [read-write]

The ActionsManager instance controlling this action (cursors, properties...).

Implementation
    public function get manager():ActionsManager
    public function set manager(value:ActionsManager):void
_sourceproperty 
protected var _source:IDiagramElement = null

The DiagramElement that has triggered this action.

sourceproperty 
source:IDiagramElement  [read-only]

The DiagramElement instance that has triggered this action.

Implementation
    public function get source():IDiagramElement
_viewproperty 
protected var _view:DiagramView

The DiagramView where this action has been triggered.

viewproperty 
view:DiagramView  [read-write]

The DiagramView instance where this action has been triggered.

Implementation
    public function get view():DiagramView
    public function set view(value:DiagramView):void
Constructor detail
Action()constructor
public function Action(id:String)

Creates a new Action instance having id as ID.

Parameters
id:String — Action ID.
Method detail
abort()method
public function abort():void

Terminates the execution of this action with success equal to false.

execute()method 
public function execute(dob:IDiagramElement = null, event:Event = null, args:Array = null):Boolean

Executes the tasks of this action.

Parameters
dob:IDiagramElement (default = null) — DiagramElement instance where this action has been triggered.
 
event:Event (default = null) — The triggered Event.
 
args:Array (default = null) — Parameters used in the execution of this action.

Returns
Boolean — Termination status of the execution of this action.
terminate()method 
public function terminate(success:Boolean):void

Terminates the execution of this action with a termination status equal to success. A true value of the success parameter indicates that the action has been successfuly finished, while a false value indicates that the action has been aborted.

Parameters
success:Boolean — Termination status of this action. A true value indicates that this action has been successfuly finished, while a false value indicates that the action has been aborted.