com.kapit.diagram.actions.AbortAction

Public Properties

	Property		Defined by
		altkey : * Indicates whether the ALT key has to be pressed or not to consider the KeyboardAction.	KeyboardAction
		charcode : * The charcode of the key used in combination with the SHIFT, ALT and/or CTRL keys.	KeyboardAction
		controlkey : * Indicates whether the CTRL key has to be pressed or not to consider the KeyboardAction.	KeyboardAction
		id : String ID of this action.	Action
		keycode : * The key used in combination with the SHIFT, ALT and/or CTRL keys.	KeyboardAction
		manager : ActionsManager The ActionsManager instance controlling this action (cursors, properties...).	Action
		shiftkey : * Indicates whether the SHIFT key has to be pressed or not to consider the KeyboardAction.	KeyboardAction
		source : IDiagramElement The DiagramElement instance that has triggered this action.	Action
		view : DiagramView The DiagramView instance where this action has been triggered.	Action

Protected Properties

	Property		Defined by
		_alt : * = undefined ALT Key Enabled/Disabled (true boolean value if enabled)	KeyboardAction
		_charcode : * = undefined A Char Code Key used with the Ctrl, Shift or ALT key in a keys combination.	KeyboardAction
		_ctrl : * = undefined Ctrl Key Enabled/Disabled (true boolean value if enabled).	KeyboardAction
		_id : String ID reference of the action.	Action
		_keycode : * = undefined A Key Code (no combination) like delete key.	KeyboardAction
		_manager : ActionsManager = null ActionsManager dealing with the control of this action.	Action
		_shift : * = undefined Shift Key Enabled/Disabled (true boolean value if enabled).	KeyboardAction
		_source : IDiagramElement = null The DiagramElement that has triggered this action.	Action
		_view : DiagramView The DiagramView where this action has been triggered.	Action

Public Methods

	Method		Defined by
		AbortAction() Creates a new AbortAction instance having `"abort"` as ID and the ESCAPE key as `keycode`.	AbortAction
		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.	AbortAction
		terminate(success:Boolean):void Terminates the execution of this action with a termination status equal to `success`.	Action

Constructor detail

AbortAction

()

constructor

public function AbortAction()

Creates a new AbortAction instance having "abort" as ID and the ESCAPE key as keycode.

Method detail

execute

()

method

public override 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.

API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class AbortAction	Properties \| Methods

Package	com.kapit.diagram.actions
Class	public class AbortAction
Inheritance	AbortAction KeyboardAction Action