-<!DOCTYPE html><html><head><title>Sencha Documentation Project</title><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../prettify.css" type="text/css"><link rel="stylesheet" href="../prettify_sa.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script></head><body onload="prettyPrint()"><pre class="prettyprint"><pre><span id='Ext-util.KeyNav-method-constructor'><span id='Ext-util.KeyNav'>/**
-</span></span> * @class Ext.util.KeyNav
+<!DOCTYPE html>
+<html>
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+ <title>The source code</title>
+ <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
+ <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
+ <style type="text/css">
+ .highlight { display: block; background-color: #ddd; }
+ </style>
+ <script type="text/javascript">
+ function highlight() {
+ document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
+ }
+ </script>
+</head>
+<body onload="prettyPrint(); highlight();">
+ <pre class="prettyprint lang-js"><span id='Ext-util-KeyNav'>/**
+</span> * @class Ext.util.KeyNav
* <p>Provides a convenient wrapper for normalized keyboard navigation. KeyNav allows you to bind
* navigation keys to function calls that will get called when the keys are pressed, providing an easy
* way to implement custom navigation schemes for any UI component.</p>
scope : this
});
</code></pre>
- * @constructor
- * @param {Mixed} el The element to bind to
- * @param {Object} config The config
*/
Ext.define('Ext.util.KeyNav', {
tab: 9
}
},
-
+
+<span id='Ext-util-KeyNav-method-constructor'> /**
+</span> * Creates new KeyNav.
+ * @param {String/HTMLElement/Ext.Element} el The element or its ID to bind to
+ * @param {Object} config The config
+ */
constructor: function(el, config){
this.setConfig(el, config || {});
},
-<span id='Ext-util.KeyNav-method-setConfig'> /**
+<span id='Ext-util-KeyNav-method-setConfig'> /**
</span> * Sets up a configuration for the KeyNav.
* @private
- * @param {Mixed} el The element to bind to
- * @param {Object}A configuration object as specified in the constructor.
+ * @param {String/HTMLElement/Ext.Element} el The element or its ID to bind to
+ * @param {Object} config A configuration object as specified in the constructor.
*/
setConfig: function(el, config) {
if (this.map) {
}
},
-<span id='Ext-util.KeyNav-method-handleEvent'> /**
+<span id='Ext-util-KeyNav-method-handleEvent'> /**
</span> * Method for filtering out the map argument
* @private
* @param {Ext.util.KeyMap} map
return handler.call(this, event);
},
-<span id='Ext-util.KeyNav-cfg-disabled'> /**
+<span id='Ext-util-KeyNav-cfg-disabled'> /**
</span> * @cfg {Boolean} disabled
- * True to disable this KeyNav instance (defaults to false)
+ * True to disable this KeyNav instance.
*/
disabled: false,
-<span id='Ext-util.KeyNav-cfg-defaultEventAction'> /**
+<span id='Ext-util-KeyNav-cfg-defaultEventAction'> /**
</span> * @cfg {String} defaultEventAction
* The method to call on the {@link Ext.EventObject} after this KeyNav intercepts a key. Valid values are
* {@link Ext.EventObject#stopEvent}, {@link Ext.EventObject#preventDefault} and
- * {@link Ext.EventObject#stopPropagation} (defaults to 'stopEvent')
+ * {@link Ext.EventObject#stopPropagation}.
*/
defaultEventAction: "stopEvent",
-<span id='Ext-util.KeyNav-cfg-forceKeyDown'> /**
+<span id='Ext-util-KeyNav-cfg-forceKeyDown'> /**
</span> * @cfg {Boolean} forceKeyDown
- * Handle the keydown event instead of keypress (defaults to false). KeyNav automatically does this for IE since
+ * Handle the keydown event instead of keypress. KeyNav automatically does this for IE since
* IE does not propagate special keys on keypress, but setting this to true will force other browsers to also
* handle keydown instead of keypress.
*/
forceKeyDown: false,
-<span id='Ext-util.KeyNav-method-destroy'> /**
+<span id='Ext-util-KeyNav-method-destroy'> /**
</span> * Destroy this KeyNav (this is the same as calling disable).
* @param {Boolean} removeEl True to remove the element associated with this KeyNav.
*/
delete this.map;
},
-<span id='Ext-util.KeyNav-method-enable'> /**
+<span id='Ext-util-KeyNav-method-enable'> /**
</span> * Enable this KeyNav
*/
enable: function() {
this.disabled = false;
},
-<span id='Ext-util.KeyNav-method-disable'> /**
+<span id='Ext-util-KeyNav-method-disable'> /**
</span> * Disable this KeyNav
*/
disable: function() {
this.disabled = true;
},
-<span id='Ext-util.KeyNav-method-setDisabled'> /**
+<span id='Ext-util-KeyNav-method-setDisabled'> /**
</span> * Convenience function for setting disabled/enabled by boolean.
* @param {Boolean} disabled
*/
this.disabled = disabled;
},
-<span id='Ext-util.KeyNav-method-getKeyEvent'> /**
+<span id='Ext-util-KeyNav-method-getKeyEvent'> /**
</span> * Determines the event to bind to listen for keys. Depends on the {@link #forceKeyDown} setting,
* as well as the useKeyDown option on the EventManager.
* @return {String} The type of event to listen for.
return (forceKeyDown || Ext.EventManager.useKeyDown) ? 'keydown' : 'keypress';
}
});
-</pre></pre></body></html>
\ No newline at end of file
+</pre>
+</body>
+</html>