X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..f562e4c6e5fac7bcb445985b99acbea4d706e6f0:/docs/source/KeyNav2.html diff --git a/docs/source/KeyNav2.html b/docs/source/KeyNav2.html index e0392677..72ef815a 100644 --- a/docs/source/KeyNav2.html +++ b/docs/source/KeyNav2.html @@ -1,5 +1,22 @@ -Sencha Documentation Project
/**
- * @class Ext.util.KeyNav
+
+
+
+  
+  The source code
+  
+  
+  
+  
+
+
+  
/**
+ * @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>
@@ -19,9 +36,6 @@ var nav = new Ext.util.KeyNav("my-element", {
     scope : this
 });
 </code></pre>
- * @constructor
- * @param {Mixed} el The element to bind to
- * @param {Object} config The config
  */
 Ext.define('Ext.util.KeyNav', {
     
@@ -47,16 +61,21 @@ Ext.define('Ext.util.KeyNav', {
             tab: 9
         }
     },
-    
+
+    /**
+     * 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 || {});
     },
     
-    /**
+    /**
      * 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) {
@@ -88,7 +107,7 @@ Ext.define('Ext.util.KeyNav', {
         }
     },
     
-    /**
+    /**
      * Method for filtering out the map argument
      * @private
      * @param {Ext.util.KeyMap} map
@@ -99,29 +118,29 @@ Ext.define('Ext.util.KeyNav', {
         return handler.call(this, event);
     },
     
-    /**
+    /**
      * @cfg {Boolean} disabled
-     * True to disable this KeyNav instance (defaults to false)
+     * True to disable this KeyNav instance.
      */
     disabled: false,
     
-    /**
+    /**
      * @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",
     
-    /**
+    /**
      * @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,
     
-    /**
+    /**
      * Destroy this KeyNav (this is the same as calling disable).
      * @param {Boolean} removeEl True to remove the element associated with this KeyNav.
      */
@@ -130,7 +149,7 @@ Ext.define('Ext.util.KeyNav', {
         delete this.map;
     },
 
-    /**
+    /**
      * Enable this KeyNav
      */
     enable: function() {
@@ -138,7 +157,7 @@ Ext.define('Ext.util.KeyNav', {
         this.disabled = false;
     },
 
-    /**
+    /**
      * Disable this KeyNav
      */
     disable: function() {
@@ -146,7 +165,7 @@ Ext.define('Ext.util.KeyNav', {
         this.disabled = true;
     },
     
-    /**
+    /**
      * Convenience function for setting disabled/enabled by boolean.
      * @param {Boolean} disabled
      */
@@ -155,7 +174,7 @@ Ext.define('Ext.util.KeyNav', {
         this.disabled = disabled;
     },
     
-    /**
+    /**
      * 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.
@@ -164,4 +183,6 @@ Ext.define('Ext.util.KeyNav', {
         return (forceKeyDown || Ext.EventManager.useKeyDown) ? 'keydown' : 'keypress';
     }
 });
-

\ No newline at end of file
+
+ +