Files
KeyMap.js

Handles mapping keys to actions for an element. One key map can be used for multiple actions.\nThe constructor accepts the same config object as defined by addBinding.\nIf you bind a callback function to a KeyMap, anytime the KeyMap handles an expected key\ncombination it will call the function with this signature (if the match is a multi-key\ncombination the callback will still be called only once): (String key, Ext.EventObject e)\nA KeyMap can also handle a string representation of keys.
\nUsage:

\n\n

// map one key by key code\nvar map = new Ext.KeyMap(\"my-element\", {\n    key: 13, // or Ext.EventObject.ENTER\n    fn: myHandler,\n    scope: myObject\n});\n\n// map multiple keys to one action by string\nvar map = new Ext.KeyMap(\"my-element\", {\n    key: \"a\\r\\n\\t\",\n    fn: myHandler,\n    scope: myObject\n});\n\n// map multiple keys to multiple actions by strings and array of codes\nvar map = new Ext.KeyMap(\"my-element\", [\n    {\n        key: [10,13],\n        fn: function(){ alert(\"Return was pressed\"); }\n    }, {\n        key: \"abc\",\n        fn: function(){ alert('a, b or c was pressed'); }\n    }, {\n        key: \"\\t\",\n        ctrl:true,\n        shift:true,\n        fn: function(){ alert('Control + shift + tab was pressed.'); }\n    }\n]);\n

\n\n\n

Note: A KeyMap starts enabled

Defined By

Properties

Ext.KeyMap
view source

stopEvent : Boolean

True to stop the event from bubbling and prevent the default browser action if the\nkey was handled by the KeyMap (def...

True to stop the event from bubbling and prevent the default browser action if the\nkey was handled by the KeyMap (defaults to false)

Defaults to: false

Defined By

Methods

Ext.KeyMap
view source

newExt.KeyMap( el, config, [eventName] ) : Ext.KeyMap

...

Parameters

el : Mixed
The element to bind to
\n
config : Object
The config (see addBinding)
\n
eventName : String (optional)
The event to bind to (defaults to \"keydown\")
\n

Returns

Ext.KeyMap
\n

Ext.KeyMap
view source

addBinding( config )

Add a new binding to this KeyMap. ...

Add a new binding to this KeyMap. The following config object properties are supported:

\n\n

Property    Type             Description\n----------  ---------------  ----------------------------------------------------------------------\nkey         String/Array     A single keycode or an array of keycodes to handle\nshift       Boolean          True to handle key only when shift is pressed, False to handle the key only when shift is not pressed (defaults to undefined)\nctrl        Boolean          True to handle key only when ctrl is pressed, False to handle the key only when ctrl is not pressed (defaults to undefined)\nalt         Boolean          True to handle key only when alt is pressed, False to handle the key only when alt is not pressed (defaults to undefined)\nhandler     Function         The function to call when KeyMap finds the expected key combination\nfn          Function         Alias of handler (for backwards-compatibility)\nscope       Object           The scope of the callback function\nstopEvent   Boolean          True to stop the event from bubbling and prevent the default browser action if the key was handled by the KeyMap (defaults to false)\n

\n\n\n

Usage:

\n\n

// Create a KeyMap\nvar map = new Ext.KeyMap(document, {\n    key: Ext.EventObject.ENTER,\n    fn: handleKey,\n    scope: this\n});\n\n//Add a new binding to the existing KeyMap later\nmap.addBinding({\n    key: 'abc',\n    shift: true,\n    fn: handleKey,\n    scope: this\n});\n

\n\n

Parameters

config : Object/Array
A single KeyMap config or an array of configs
\n

Ext.KeyMap
view source

disable( )

Disable this KeyMap ...

Disable this KeyMap

Ext.KeyMap
view source

enable( )

Enables this KeyMap ...

Enables this KeyMap

Ext.KeyMap
view source

isEnabled( ) : Boolean

Returns true if this KeyMap is enabled ...

Returns true if this KeyMap is enabled

Returns

Boolean
\n

Ext.KeyMap
view source

on( key, fn, [scope] )

Shorthand for adding a single key listener ...

Shorthand for adding a single key listener

Parameters

key : Number/Array/Object
Either the numeric key code, array of key codes or an object with the\nfollowing options:\n{key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)}
\n
fn : Function
The function to call
\n
scope : Object (optional)
The scope (this reference) in which the function is executed. Defaults to the browser window.
\n

Ext.KeyMap
view source

setDisabled( disabled )

Convenience function for setting disabled/enabled by boolean. ...

Convenience function for setting disabled/enabled by boolean.

Parameters

disabled : Boolean
\n