| Package | com.kapit.diagram.actions |
| Class | public class KeyboardAction |
| Inheritance | KeyboardAction  Action |
| Subclasses | AbortAction, DebugAction, DeleteAction, GroupAction, InsertPanelAction, SelectAllAction, UngroupAction |
| 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 | |
| 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 | |
| Method | Defined by | ||
|---|---|---|---|
|
KeyboardAction(id:String)
Creates a new KeyboardAction instance.
| KeyboardAction | ||
|
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 | |
| _alt | property |
Hide Inherited Public Properties
Show Inherited Public Propertiesprotected var _alt:* = undefinedALT Key Enabled/Disabled (true boolean value if enabled)
| altkey | property |
altkey:* [read-write]Indicates whether the ALT key has to be pressed or not to consider the KeyboardAction.
Implementation public function get altkey():*
public function set altkey(value:*):void
| _charcode | property |
protected var _charcode:* = undefinedA Char Code Key used with the Ctrl, Shift or ALT key in a keys combination.
| charcode | property |
charcode:* [read-write]The charcode of the key used in combination with the SHIFT, ALT and/or CTRL keys.
Implementation public function get charcode():*
public function set charcode(value:*):void
| controlkey | property |
controlkey:* [read-write]Indicates whether the CTRL key has to be pressed or not to consider the KeyboardAction.
Implementation public function get controlkey():*
public function set controlkey(value:*):void
| _ctrl | property |
protected var _ctrl:* = undefinedCtrl Key Enabled/Disabled (true boolean value if enabled).
| _keycode | property |
protected var _keycode:* = undefinedA Key Code (no combination) like delete key.
| keycode | property |
keycode:* [read-write]The key used in combination with the SHIFT, ALT and/or CTRL keys.
Implementation public function get keycode():*
public function set keycode(value:*):void
| _shift | property |
protected var _shift:* = undefinedShift Key Enabled/Disabled (true boolean value if enabled).
| shiftkey | property |
shiftkey:* [read-write]Indicates whether the SHIFT key has to be pressed or not to consider the KeyboardAction.
Implementation public function get shiftkey():*
public function set shiftkey(value:*):void
| KeyboardAction | () | constructor |
public function KeyboardAction(id:String)Creates a new KeyboardAction instance.
Parametersid:String — Action ID.
|