| Package | com.kapit.diagram.actions |
| Class | public class ComplexAction |
| Inheritance | ComplexAction  Action |
| Implements | IUIController |
| Subclasses | DragLinkAction, LinkAction, TextEditAction, TransformAction |
| Property | Defined by | ||
|---|---|---|---|
| activated : Boolean [read-only]
Indicates whether this ComplexAction is activated or not.
| ComplexAction | ||
 | id : String
ID of this action.
| Action | |
| manager : ActionsManager
The ActionsManager instance controlling this action (cursors, properties...).
| Action | |
| source : IDiagramElement
The DiagramElement instance that has triggered this action.
| Action | |
| view : DiagramView
The DiagramView instance where this action has been triggered.
| Action | |
| Property | Defined by | ||
|---|---|---|---|
| _activated : Boolean = false
Activation status of this complex action.
| ComplexAction | ||
| _cursorid : int = -1
Cursor ID to be used by this complex action.
| ComplexAction | ||
| _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 | |
| Method | Defined by | ||
|---|---|---|---|
|
ComplexAction(id:String)
Creates a new ComplexAction instance having
id as ID. | ComplexAction | ||
|
abort():void
Terminates the execution of this action with
success
equal to false. | ComplexAction | ||
|
changeCursor(cursorclass:Class, dx:Number, dy:Number):void
Changes the current cursor.
| ComplexAction | ||
|
execute(dob:IDiagramElement = null, event:Event = null, args:Array = null):Boolean
Executes the tasks of this action.
| ComplexAction | ||
|
removeCursor():void
Removes the used cursor.
| ComplexAction | ||
|
rollOut(dob:IDiagramElement, event:MouseEvent):void
Sets the roll out reaction given a DiagramElement and a mouse event.
| ComplexAction | ||
|
rollOver(dob:IDiagramElement, event:MouseEvent):void
Sets the roll over reaction given a DiagramElement and a mouse event.
| ComplexAction | ||
|
terminate(success:Boolean):void
Terminates the execution of this action with a termination status
equal to
success. | ComplexAction | ||
|
uiCompleted():void
| ComplexAction | ||
| _activated | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesprotected var _activated:Boolean = falseActivation status of this complex action.
| activated | property |
activated:Boolean [read-only]Indicates whether this ComplexAction is activated or not.
Implementation public function get activated():Boolean
| _cursorid | property |
protected var _cursorid:int = -1Cursor ID to be used by this complex action.
| ComplexAction | () | constructor |
public function ComplexAction(id:String)
Creates a new ComplexAction instance having id as ID.
id:String — ID of the new ComplexAction instance.
|
| abort | () | method |
public override function abort():void
Terminates the execution of this action with success
equal to false.
| changeCursor | () | method |
public function changeCursor(cursorclass:Class, dx:Number, dy:Number):voidChanges the current cursor.
Parameterscursorclass:Class — Cursor class (holds information for generating the customized system cursor properties).
|
|
dx:Number — X position.
|
|
dy:Number — Y position.
|
| execute | () | method |
public override function execute(dob:IDiagramElement = null, event:Event = null, args:Array = null):BooleanExecutes the tasks of this action.
Parametersdob:IDiagramElement (default = null) |
|
event:Event (default = null) |
|
args:Array (default = null) |
Boolean — Termination status of the execution of this action.
|
| removeCursor | () | method |
public function removeCursor():voidRemoves the used cursor.
| rollOut | () | method |
public function rollOut(dob:IDiagramElement, event:MouseEvent):voidSets the roll out reaction given a DiagramElement and a mouse event.
Parametersdob:IDiagramElement — Diagram Element calling this action event.
|
|
event:MouseEvent — Detected Mouse Event
|
| rollOver | () | method |
public function rollOver(dob:IDiagramElement, event:MouseEvent):voidSets the roll over reaction given a DiagramElement and a mouse event.
Parametersdob:IDiagramElement — Diagram Element calling this action event.
|
|
event:MouseEvent — Detected Mouse Event
|
| terminate | () | method |
public override 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.
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.
|
| uiCompleted | () | method |
public function uiCompleted():void