Class Index | File Index

Classes


Class orion.editor.KeyBinding

A KeyBinding represents of a key code and a modifier state that can be triggered by the user using the keyboard.
Defined in: </shared/eclipse/e4/orion/I201305232230/plugins/org.eclipse.orion.client.core/web/orion/keyBinding.js>.

Class Summary
Constructor Attributes Constructor Name and Description
 
orion.editor.KeyBinding(keyCode, mod1, mod2, mod3, mod4)
Constructs a new key binding with the given key code and modifiers.
Field Summary
Field Attributes Field Name and Description
 
The key code.
 
The primary modifier (usually Command on Mac and Control on other platforms).
 
The secondary modifier (usually Shift).
 
The third modifier (usually Alt).
 
The fourth modifier (usually Control on the Mac).
 
The type of event that the keybinding matches; either "keydown" or "keypress"
Method Summary
Method Attributes Method Name and Description
 
equals(kb)
Returns whether this key binding is the same as the given parameter.
 
match(e)
Returns whether this key binding matches the given key event.
Class Detail
orion.editor.KeyBinding(keyCode, mod1, mod2, mod3, mod4)
Constructs a new key binding with the given key code and modifiers.
Parameters:
{String|Number} keyCode
the key code.
{Boolean} mod1
the primary modifier (usually Command on Mac and Control on other platforms).
{Boolean} mod2
the secondary modifier (usually Shift).
{Boolean} mod3
the third modifier (usually Alt).
{Boolean} mod4
the fourth modifier (usually Control on the Mac).
See:
orion.editor.TextView#setKeyBinding
Field Detail
{String|Number} keyCode
The key code.

{Boolean} mod1
The primary modifier (usually Command on Mac and Control on other platforms).

{Boolean} mod2
The secondary modifier (usually Shift).

{Boolean} mod3
The third modifier (usually Alt).

{Boolean} mod4
The fourth modifier (usually Control on the Mac).

{String} type
The type of event that the keybinding matches; either "keydown" or "keypress"
Default Value:
keydown
Method Detail
{Boolean} equals(kb)
Returns whether this key binding is the same as the given parameter.
Parameters:
{orion.editor.KeyBinding} kb
the key binding to compare with.
Returns:
{Boolean} whether or not the parameter and the receiver describe the same key binding.

{Boolean} match(e)
Returns whether this key binding matches the given key event.
Parameters:
e
the key event.
Returns:
{Boolean} true whether the key binding matches the key event.

Documentation generated by JsDoc Toolkit 2.4.0 on Thu May 23 2013 22:33:16 GMT-0400 (EDT)