Class Roo.KeyMap

Package:	Roo
Defined In:	Roo/KeyMap.js.
Class:	KeyMap

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

Usage:


// map one key by key code
var map = new Roo.KeyMap("my-element", {
    key: 13, // or Roo.EventObject.ENTER
    fn: myHandler,
    scope: myObject
});

// map multiple keys to one action by string
var map = new Roo.KeyMap("my-element", {
    key: "a\r\n\t",
    fn: myHandler,
    scope: myObject
});

// map multiple keys to multiple actions by strings and array of codes
var map = new Roo.KeyMap("my-element", [
    {
        key: [10,13],
        fn: function(){ alert("Return was pressed"); }
    }, {
        key: "abc",
        fn: function(){ alert('a, b or c was pressed'); }
    }, {
        key: "\t",
        ctrl:true,
        shift:true,
        fn: function(){ alert('Control + shift + tab was pressed.'); }
    }
]);

Note: A KeyMap starts enabled

Class Comments / Notes => [Add Your comment/notes about this class]

Public Methods
Method		Defined By
	new Roo.KeyMap (String/HTMLElement/Roo.Element el, Object *config, String eventName) Create a new Roo.KeyMap Create a new Roo.KeyMap Parameters: String/HTMLElement/Roo.Element el The element to bind to Object config* The config (see {link addBinding}) String eventName (optional) The event to bind to (defaults to "keydown")
	addBinding (Object/Array *config) Add a new binding to this KeyMap. Add a new binding to this KeyMap. The following config object properties are supported: Property Type Description ---------- --------------- ---------------------------------------------------------------------- key String/Array A single keycode or an array of keycodes to handle shift Boolean True to handle key only when shift is pressed (defaults to false) ctrl Boolean True to handle key only when ctrl is pressed (defaults to false) alt Boolean True to handle key only when alt is pressed (defaults to false) fn Function The function to call when KeyMap finds the expected key combination scope Object The scope of the callback function Usage: `// Create a KeyMap var map = new Roo.KeyMap(document, { key: Roo.EventObject.ENTER, fn: handleKey, scope: this }); //Add a new binding to the existing KeyMap later map.addBinding({ key: 'abc', shift: true, fn: handleKey, scope: this });` Parameters: Object/Array config* A single KeyMap config or an array of configs	Roo.KeyMap
	disable () Disable this KeyMap Disable this KeyMap	Roo.KeyMap
	enable () Enables this KeyMap Enables this KeyMap	Roo.KeyMap
	isEnabled () : Boolean Returns true if this KeyMap is enabled Returns true if this KeyMap is enabled Returns: Boolean	Roo.KeyMap
	on (Number/Array/Object *key, Function fn, Object scope) Shorthand for adding a single key listener Shorthand for adding a single key listener Parameters: Number/Array/Object key* Either the numeric key code, array of key codes or an object with the following options: {key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)} Function fn The function to call Object scope (optional) The scope of the function	Roo.KeyMap

Documentation generated by Introspection Doc Generator on Fri Jul 13 2018 14:10:53 GMT+0800 (HKT) Based on JsDoc Toolkit