Handles mapping keys to actions for an element. One key map can be used for multiple actions.
+
Package: | Ext |
Defined In: | KeyMap.js |
Class: | KeyMap |
Extends: | Object |
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
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
@@ -34,13 +34,13 @@ Usage:
fn:
function(){ alert(
'Control + shift + tab was pressed.'); }
}
]);
-
Note: A KeyMap starts enabledPublic Properties
|
| stopEvent : BooleanTrue to stop the event from bubbling and prevent the default browser action if the
+Note: A KeyMap starts enabled Public Properties|
| stopEvent : BooleanTrue to stop the event from bubbling and prevent the default browser action if the
key was handled by the KeyMap (de... True to stop the event from bubbling and prevent the default browser action if the
-key was handled by the KeyMap (defaults to false) | KeyMap |
Public Methods|
| KeyMap( Mixed el , Object config , [String eventName ] )
- | KeyMap | | addBinding( Object/Array config )
- :
- voidAdd a new binding to this KeyMap. The following config object properties are supported:
-
+key was handled by the KeyMap (defaults to false) | KeyMap |
Public Methods|
| KeyMap( Mixed el , Object config , [String eventName ] )
+ | KeyMap | | addBinding( Object/Array config )
+ :
+ voidAdd a new binding to this KeyMap. The following config object properties are supported:
+
Property Type ... Add a new binding to this KeyMap. The following config object properties are supported:
Property Type Description
@@ -68,16 +68,16 @@ map.addBinding({
shift: true,
fn: handleKey,
scope: this
-}); | KeyMap | | disable()
- :
- void | KeyMap | | enable()
- :
- void | KeyMap | | isEnabled()
- :
- BooleanReturns true if this KeyMap is enabled Returns true if this KeyMap is enabled | KeyMap | | on( Number/Array/Object key , Function fn , [Object scope ] )
- :
+}); | KeyMap | | disable()
+ :
+ void | KeyMap | | enable()
+ :
+ void | KeyMap | | isEnabled()
+ :
+ BooleanReturns true if this KeyMap is enabled Returns true if this KeyMap is enabled | KeyMap | | on( Number/Array/Object key , Function fn , [Object scope ] )
+ :
voidShorthand for adding a single key listener Shorthand for adding a single key listener Parameters:key : Number/Array/ObjectEither 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)} fn : FunctionThe function to call scope : Object(optional) The scope of the function Returns: | KeyMap | | setDisabled( Boolean disabled )
- :
+{key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)}fn : FunctionThe function to call scope : Object(optional) The scope (this reference) in which the function is executed. Defaults to the browser window. Returns: | KeyMap | | setDisabled( Boolean disabled )
+ :
voidConvenience function for setting disabled/enabled by boolean. Convenience function for setting disabled/enabled by boolean. | KeyMap |
Public EventsThis class has no public events.
\ No newline at end of file
|