docs/output/Ext.util.KeyNav.js

   1 Ext.data.JsonP.Ext_util_KeyNav({
   2   "tagname": "class",
   3   "name": "Ext.util.KeyNav",
   4   "doc": "<p>Provides a convenient wrapper for normalized keyboard navigation.  KeyNav allows you to bind\nnavigation keys to function calls that will get called when the keys are pressed, providing an easy\nway to implement custom navigation schemes for any UI component.</p>\n\n\n<p>The following are all of the possible keys that can be implemented: enter, space, left, right, up, down, tab, esc,\npageUp, pageDown, del, backspace, home, end.  Usage:</p>\n\n\n\n\n<pre><code>var nav = new Ext.util.KeyNav(\"my-element\", {\n    \"left\" : function(e){\n        this.moveLeft(e.ctrlKey);\n    },\n    \"right\" : function(e){\n        this.moveRight(e.ctrlKey);\n    },\n    \"enter\" : function(e){\n        this.save();\n    },\n    scope : this\n});\n</code></pre>\n\n",
   5   "extends": null,
   6   "mixins": [
   7
   8   ],
   9   "alternateClassNames": [
  10     "Ext.KeyNav"
  11   ],
  12   "xtype": null,
  13   "author": null,
  14   "docauthor": null,
  15   "singleton": false,
  16   "private": false,
  17   "cfg": [
  18     {
  19       "tagname": "cfg",
  20       "name": "defaultEventAction",
  21       "member": "Ext.util.KeyNav",
  22       "type": "String",
  23       "doc": "<p>The method to call on the <a href=\"#/api/Ext.EventObject\" rel=\"Ext.EventObject\" class=\"docClass\">Ext.EventObject</a> after this KeyNav intercepts a key.  Valid values are\n<a href=\"#/api/Ext.EventObject-method-stopEvent\" rel=\"Ext.EventObject-method-stopEvent\" class=\"docClass\">Ext.EventObject.stopEvent</a>, <a href=\"#/api/Ext.EventObject-method-preventDefault\" rel=\"Ext.EventObject-method-preventDefault\" class=\"docClass\">Ext.EventObject.preventDefault</a> and\n<a href=\"#/api/Ext.EventObject-method-stopPropagation\" rel=\"Ext.EventObject-method-stopPropagation\" class=\"docClass\">Ext.EventObject.stopPropagation</a> (defaults to 'stopEvent')</p>\n",
  24       "private": false,
  25       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/KeyNav.js",
  26       "linenr": 108,
  27       "html_filename": "KeyNav2.html",
  28       "href": "KeyNav2.html#Ext-util-KeyNav-cfg-defaultEventAction",
  29       "shortDoc": "The method to call on the Ext.EventObject after this KeyNav intercepts a key.  Valid values are\nExt.EventObject.stopE..."
  30     },
  31     {
  32       "tagname": "cfg",
  33       "name": "disabled",
  34       "member": "Ext.util.KeyNav",
  35       "type": "Boolean",
  36       "doc": "<p>True to disable this KeyNav instance (defaults to false)</p>\n",
  37       "private": false,
  38       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/KeyNav.js",
  39       "linenr": 102,
  40       "html_filename": "KeyNav2.html",
  41       "href": "KeyNav2.html#Ext-util-KeyNav-cfg-disabled"
  42     },
  43     {
  44       "tagname": "cfg",
  45       "name": "forceKeyDown",
  46       "member": "Ext.util.KeyNav",
  47       "type": "Boolean",
  48       "doc": "<p>Handle the keydown event instead of keypress (defaults to false).  KeyNav automatically does this for IE since\nIE does not propagate special keys on keypress, but setting this to true will force other browsers to also\nhandle keydown instead of keypress.</p>\n",
  49       "private": false,
  50       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/KeyNav.js",
  51       "linenr": 116,
  52       "html_filename": "KeyNav2.html",
  53       "href": "KeyNav2.html#Ext-util-KeyNav-cfg-forceKeyDown",
  54       "shortDoc": "Handle the keydown event instead of keypress (defaults to false).  KeyNav automatically does this for IE since\nIE doe..."
  55     }
  56   ],
  57   "method": [
  58     {
  59       "tagname": "method",
  60       "name": "KeyNav",
  61       "member": "Ext.util.KeyNav",
  62       "doc": "\n",
  63       "params": [
  64         {
  65           "type": "Mixed",
  66           "name": "el",
  67           "doc": "<p>The element to bind to</p>\n",
  68           "optional": false
  69         },
  70         {
  71           "type": "Object",
  72           "name": "config",
  73           "doc": "<p>The config</p>\n",
  74           "optional": false
  75         }
  76       ],
  77       "return": {
  78         "type": "void",
  79         "doc": "\n"
  80       },
  81       "private": false,
  82       "static": false,
  83       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/KeyNav.js",
  84       "linenr": 1,
  85       "html_filename": "KeyNav2.html",
  86       "href": "KeyNav2.html#Ext-util-KeyNav-method-constructor",
  87       "shortDoc": "\n"
  88     },
  89     {
  90       "tagname": "method",
  91       "name": "destroy",
  92       "member": "Ext.util.KeyNav",
  93       "doc": "<p>Destroy this KeyNav (this is the same as calling disable).</p>\n",
  94       "params": [
  95         {
  96           "type": "Boolean",
  97           "name": "removeEl",
  98           "doc": "<p>True to remove the element associated with this KeyNav.</p>\n",
  99           "optional": false
 100         }
 101       ],
 102       "return": {
 103         "type": "void",
 104         "doc": "\n"
 105       },
 106       "private": false,
 107       "static": false,
 108       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/KeyNav.js",
 109       "linenr": 124,
 110       "html_filename": "KeyNav2.html",
 111       "href": "KeyNav2.html#Ext-util-KeyNav-method-destroy",
 112       "shortDoc": "<p>Destroy this KeyNav (this is the same as calling disable).</p>\n"
 113     },
 114     {
 115       "tagname": "method",
 116       "name": "disable",
 117       "member": "Ext.util.KeyNav",
 118       "doc": "<p>Disable this KeyNav</p>\n",
 119       "params": [
 120
 121       ],
 122       "return": {
 123         "type": "void",
 124         "doc": "\n"
 125       },
 126       "private": false,
 127       "static": false,
 128       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/KeyNav.js",
 129       "linenr": 141,
 130       "html_filename": "KeyNav2.html",
 131       "href": "KeyNav2.html#Ext-util-KeyNav-method-disable",
 132       "shortDoc": "<p>Disable this KeyNav</p>\n"
 133     },
 134     {
 135       "tagname": "method",
 136       "name": "enable",
 137       "member": "Ext.util.KeyNav",
 138       "doc": "<p>Enable this KeyNav</p>\n",
 139       "params": [
 140
 141       ],
 142       "return": {
 143         "type": "void",
 144         "doc": "\n"
 145       },
 146       "private": false,
 147       "static": false,
 148       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/KeyNav.js",
 149       "linenr": 133,
 150       "html_filename": "KeyNav2.html",
 151       "href": "KeyNav2.html#Ext-util-KeyNav-method-enable",
 152       "shortDoc": "<p>Enable this KeyNav</p>\n"
 153     },
 154     {
 155       "tagname": "method",
 156       "name": "getKeyEvent",
 157       "member": "Ext.util.KeyNav",
 158       "doc": "<p>Determines the event to bind to listen for keys. Depends on the <a href=\"#/api/Ext.util.KeyNav-cfg-forceKeyDown\" rel=\"Ext.util.KeyNav-cfg-forceKeyDown\" class=\"docClass\">forceKeyDown</a> setting,\nas well as the useKeyDown option on the EventManager.</p>\n",
 159       "params": [
 160         {
 161           "type": "Object",
 162           "name": "forceKeyDown",
 163           "doc": "\n",
 164           "optional": false
 165         }
 166       ],
 167       "return": {
 168         "type": "String",
 169         "doc": "<p>The type of event to listen for.</p>\n"
 170       },
 171       "private": false,
 172       "static": false,
 173       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/KeyNav.js",
 174       "linenr": 158,
 175       "html_filename": "KeyNav2.html",
 176       "href": "KeyNav2.html#Ext-util-KeyNav-method-getKeyEvent",
 177       "shortDoc": "Determines the event to bind to listen for keys. Depends on the forceKeyDown setting,\nas well as the useKeyDown optio..."
 178     },
 179     {
 180       "tagname": "method",
 181       "name": "setDisabled",
 182       "member": "Ext.util.KeyNav",
 183       "doc": "<p>Convenience function for setting disabled/enabled by boolean.</p>\n",
 184       "params": [
 185         {
 186           "type": "Boolean",
 187           "name": "disabled",
 188           "doc": "\n",
 189           "optional": false
 190         }
 191       ],
 192       "return": {
 193         "type": "void",
 194         "doc": "\n"
 195       },
 196       "private": false,
 197       "static": false,
 198       "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/KeyNav.js",
 199       "linenr": 149,
 200       "html_filename": "KeyNav2.html",
 201       "href": "KeyNav2.html#Ext-util-KeyNav-method-setDisabled",
 202       "shortDoc": "<p>Convenience function for setting disabled/enabled by boolean.</p>\n"
 203     }
 204   ],
 205   "property": [
 206
 207   ],
 208   "event": [
 209
 210   ],
 211   "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/KeyNav.js",
 212   "linenr": 1,
 213   "html_filename": "KeyNav2.html",
 214   "href": "KeyNav2.html#Ext-util-KeyNav",
 215   "cssVar": [
 216
 217   ],
 218   "cssMixin": [
 219
 220   ],
 221   "component": false,
 222   "superclasses": [
 223
 224   ],
 225   "subclasses": [
 226     "Ext.menu.KeyNav",
 227     "Ext.view.BoundListKeyNav"
 228   ],
 229   "mixedInto": [
 230
 231   ],
 232   "allMixins": [
 233
 234   ]
 235 });