Class eclipse.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/I201106021400/plugins/org.eclipse.orion.client.editor/web/js/editor.js>.

Class Summary
Constructor Attributes	Constructor Name and Description
	eclipse.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
	keyCode The key code.
	mod1 The primary modifier (usually Command on Mac and Control on other platforms).
	mod2 The secondary modifier (usually Shift).
	mod3 The third modifier (usually Alt).
	mod4 The fourth modifier (usually Control on the Mac).

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

eclipse.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:: eclipse.Editor#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).

Method Detail

{Boolean} equals(kb)

Returns whether this key binding is the same as the given parameter.

Parameters:
{eclipse.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.

Classes

Class eclipse.KeyBinding