Ext.data.JsonP.Ext_util_KeyMap({
- "tagname": "class",
- "name": "Ext.util.KeyMap",
- "doc": "<p>Handles mapping keys to actions for an element. One key map can be used for multiple actions.\nThe constructor accepts the same config object as defined by <a href=\"#/api/Ext.util.KeyMap-method-addBinding\" rel=\"Ext.util.KeyMap-method-addBinding\" class=\"docClass\">addBinding</a>.\nIf you bind a callback function to a KeyMap, anytime the KeyMap handles an expected key\ncombination it will call the function with this signature (if the match is a multi-key\ncombination the callback will still be called only once): (String key, <a href=\"#/api/Ext.EventObject\" rel=\"Ext.EventObject\" class=\"docClass\">Ext.EventObject</a> e)\nA KeyMap can also handle a string representation of keys.<br />\nUsage:</p>\n\n<pre><code>// map one key by key code\nvar map = new Ext.util.KeyMap(\"my-element\", {\n key: 13, // or Ext.EventObject.ENTER\n fn: myHandler,\n scope: myObject\n});\n\n// map multiple keys to one action by string\nvar map = new Ext.util.KeyMap(\"my-element\", {\n key: \"a\\r\\n\\t\",\n fn: myHandler,\n scope: myObject\n});\n\n// map multiple keys to multiple actions by strings and array of codes\nvar map = new Ext.util.KeyMap(\"my-element\", [\n {\n key: [10,13],\n fn: function(){ alert(\"Return was pressed\"); }\n }, {\n key: \"abc\",\n fn: function(){ alert('a, b or c was pressed'); }\n }, {\n key: \"\\t\",\n ctrl:true,\n shift:true,\n fn: function(){ alert('Control + shift + tab was pressed.'); }\n }\n]);\n</code></pre>\n\n\n<p><b>Note: A KeyMap starts enabled</b></p>\n",
- "extends": null,
- "mixins": [
+ "allMixins": [
],
- "alternateClassNames": [
- "Ext.KeyMap"
- ],
- "xtype": null,
- "author": null,
+ "deprecated": null,
"docauthor": null,
- "singleton": false,
- "private": false,
- "cfg": [
+ "members": {
+ "cfg": [
- ],
- "method": [
- {
- "tagname": "method",
- "name": "KeyMap",
- "member": "Ext.util.KeyMap",
- "doc": "\n",
- "params": [
- {
+ ],
+ "method": [
+ {
+ "deprecated": null,
+ "alias": null,
+ "href": "KeyMap.html#Ext-util-KeyMap-method-constructor",
+ "tagname": "method",
+ "protected": false,
+ "shortDoc": "Creates new KeyMap. ...",
+ "static": false,
+ "params": [
+ {
+ "type": "Mixed",
+ "optional": false,
+ "doc": "<p>The element to bind to</p>\n",
+ "name": "el"
+ },
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "<p>The binding (see <a href=\"#/api/Ext.util.KeyMap-method-addBinding\" rel=\"Ext.util.KeyMap-method-addBinding\" class=\"docClass\">addBinding</a>)</p>\n",
+ "name": "binding"
+ },
+ {
+ "type": "String",
+ "optional": true,
+ "doc": "<p>(optional) The event to bind to (defaults to \"keydown\")</p>\n",
+ "name": "eventName"
+ }
+ ],
+ "private": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/KeyMap.js",
+ "doc": "<p>Creates new KeyMap.</p>\n",
+ "owner": "Ext.util.KeyMap",
+ "name": "KeyMap",
+ "html_filename": "KeyMap.html",
+ "return": {
+ "type": "Object",
+ "doc": "\n"
+ },
+ "linenr": 46
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "KeyMap.html#Ext-util-KeyMap-method-addBinding",
+ "shortDoc": "Add a new binding to this KeyMap. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/KeyMap.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Object/Array",
+ "optional": false,
+ "doc": "<p>A single KeyMap config or an array of configs</p>\n",
+ "name": "binding"
+ }
+ ],
+ "name": "addBinding",
+ "owner": "Ext.util.KeyMap",
+ "doc": "<p>Add a new binding to this KeyMap. The following config object properties are supported:</p>\n\n<pre>Property Type Description\n---------- --------------- ----------------------------------------------------------------------\nkey String/Array A single keycode or an array of keycodes to handle\nshift Boolean True to handle key only when shift is pressed, False to handle the key only when shift is not pressed (defaults to undefined)\nctrl Boolean True to handle key only when ctrl is pressed, False to handle the key only when ctrl is not pressed (defaults to undefined)\nalt Boolean True to handle key only when alt is pressed, False to handle the key only when alt is not pressed (defaults to undefined)\nhandler Function The function to call when KeyMap finds the expected key combination\nfn Function Alias of handler (for backwards-compatibility)\nscope Object The scope of the callback function\ndefaultEventAction String A default action to apply to the event. Possible values are: stopEvent, stopPropagation, preventDefault. If no value is set no action is performed. \n</pre>\n\n\n<p>Usage:</p>\n\n<pre><code>// Create a KeyMap\nvar map = new Ext.util.KeyMap(document, {\n key: Ext.EventObject.ENTER,\n fn: handleKey,\n scope: this\n});\n\n//Add a new binding to the existing KeyMap later\nmap.addBinding({\n key: 'abc',\n shift: true,\n fn: handleKey,\n scope: this\n});\n</code></pre>\n\n",
+ "linenr": 68,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "KeyMap.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Base3.html#Ext-Base-method-addStatics",
+ "shortDoc": "Add / override static properties of this class. ...",
+ "static": true,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "\n",
+ "name": "members"
+ }
+ ],
+ "name": "addStatics",
+ "owner": "Ext.Base",
+ "doc": "<p>Add / override static properties of this class.</p>\n\n<pre><code>Ext.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.addStatics({\n someProperty: 'someValue', // My.cool.Class.someProperty = 'someValue'\n method1: function() { ... }, // My.cool.Class.method1 = function() { ... };\n method2: function() { ... } // My.cool.Class.method2 = function() { ... };\n});\n</code></pre>\n",
+ "linenr": 388,
+ "return": {
+ "type": "Ext.Base",
+ "doc": "<p>this</p>\n"
+ },
+ "html_filename": "Base3.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Base3.html#Ext-Base-method-callOverridden",
+ "shortDoc": "Call the original method that was previously overridden with Ext.Base.override\n\nExt.define('My.Cat', {\n constructo...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Array/Arguments",
+ "optional": false,
+ "doc": "<p>The arguments, either an array or the <code>arguments</code> object</p>\n",
+ "name": "args"
+ }
+ ],
+ "name": "callOverridden",
+ "owner": "Ext.Base",
+ "doc": "<p>Call the original method that was previously overridden with <a href=\"#/api/Ext.Base-method-override\" rel=\"Ext.Base-method-override\" class=\"docClass\">Ext.Base.override</a></p>\n\n<pre><code>Ext.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\n</code></pre>\n",
+ "linenr": 269,
+ "return": {
"type": "Mixed",
- "name": "el",
- "doc": "<p>The element to bind to</p>\n",
- "optional": false
+ "doc": "<p>Returns the result after calling the overridden method</p>\n"
},
- {
+ "html_filename": "Base3.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": true,
+ "tagname": "method",
+ "href": "Base3.html#Ext-Base-method-callParent",
+ "shortDoc": "Call the parent's overridden method. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Array/Arguments",
+ "optional": false,
+ "doc": "<p>The arguments, either an array or the <code>arguments</code> object\nfrom the current method, for example: <code>this.callParent(arguments)</code></p>\n",
+ "name": "args"
+ }
+ ],
+ "name": "callParent",
+ "owner": "Ext.Base",
+ "doc": "<p>Call the parent's overridden method. For example:</p>\n\n<pre><code>Ext.define('My.own.A', {\n constructor: function(test) {\n alert(test);\n }\n});\n\nExt.define('My.own.B', {\n extend: 'My.own.A',\n\n constructor: function(test) {\n alert(test);\n\n this.callParent([test + 1]);\n }\n});\n\nExt.define('My.own.C', {\n extend: 'My.own.B',\n\n constructor: function() {\n alert(\"Going to call parent's overriden constructor...\");\n\n this.callParent(arguments);\n }\n});\n\nvar a = new My.own.A(1); // alerts '1'\nvar b = new My.own.B(1); // alerts '1', then alerts '2'\nvar c = new My.own.C(2); // alerts \"Going to call parent's overriden constructor...\"\n // alerts '2', then alerts '3'\n</code></pre>\n",
+ "linenr": 124,
+ "return": {
+ "type": "Mixed",
+ "doc": "<p>Returns the result from the superclass' method</p>\n"
+ },
+ "html_filename": "Base3.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Base3.html#Ext-Base-method-create",
+ "shortDoc": "Create a new instance of this Class. ...",
+ "static": true,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
+ "private": false,
+ "params": [
+
+ ],
+ "name": "create",
+ "owner": "Ext.Base",
+ "doc": "<p>Create a new instance of this Class.</p>\n\n<pre><code>Ext.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.create({\n someConfig: true\n});\n</code></pre>\n\n<p>All parameters are passed to the constructor of the class.</p>\n",
+ "linenr": 329,
+ "return": {
"type": "Object",
- "name": "binding",
- "doc": "<p>The binding (see <a href=\"#/api/Ext.util.KeyMap-method-addBinding\" rel=\"Ext.util.KeyMap-method-addBinding\" class=\"docClass\">addBinding</a>)</p>\n",
- "optional": false
+ "doc": "<p>the created instance.</p>\n"
},
- {
- "type": "String",
- "name": "eventName",
- "doc": "<p>(optional) The event to bind to (defaults to \"keydown\")</p>\n",
- "optional": true
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ "html_filename": "Base3.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/KeyMap.js",
- "linenr": 1,
- "html_filename": "KeyMap.html",
- "href": "KeyMap.html#Ext-util-KeyMap-method-constructor",
- "shortDoc": "\n"
- },
- {
- "tagname": "method",
- "name": "addBinding",
- "member": "Ext.util.KeyMap",
- "doc": "<p>Add a new binding to this KeyMap. The following config object properties are supported:</p>\n\n<pre>Property Type Description\n---------- --------------- ----------------------------------------------------------------------\nkey String/Array A single keycode or an array of keycodes to handle\nshift Boolean True to handle key only when shift is pressed, False to handle the key only when shift is not pressed (defaults to undefined)\nctrl Boolean True to handle key only when ctrl is pressed, False to handle the key only when ctrl is not pressed (defaults to undefined)\nalt Boolean True to handle key only when alt is pressed, False to handle the key only when alt is not pressed (defaults to undefined)\nhandler Function The function to call when KeyMap finds the expected key combination\nfn Function Alias of handler (for backwards-compatibility)\nscope Object The scope of the callback function\ndefaultEventAction String A default action to apply to the event. Possible values are: stopEvent, stopPropagation, preventDefault. If no value is set no action is performed. \n</pre>\n\n\n<p>Usage:</p>\n\n<pre><code>// Create a KeyMap\nvar map = new Ext.util.KeyMap(document, {\n key: Ext.EventObject.ENTER,\n fn: handleKey,\n scope: this\n});\n\n//Add a new binding to the existing KeyMap later\nmap.addBinding({\n key: 'abc',\n shift: true,\n fn: handleKey,\n scope: this\n});\n</code></pre>\n\n",
- "params": [
- {
- "type": "Object/Array",
- "name": "binding",
- "doc": "<p>A single KeyMap config or an array of configs</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Base3.html#Ext-Base-method-createAlias",
+ "shortDoc": "Create aliases for existing prototype methods. ...",
+ "static": true,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
+ "private": false,
+ "params": [
+ {
+ "type": "String/Object",
+ "optional": false,
+ "doc": "<p>The new method name, or an object to set multiple aliases. See\n<a href=\"#/api/Ext.Function-method-flexSetter\" rel=\"Ext.Function-method-flexSetter\" class=\"docClass\">flexSetter</a></p>\n",
+ "name": "alias"
+ },
+ {
+ "type": "String/Object",
+ "optional": false,
+ "doc": "<p>The original method name</p>\n",
+ "name": "origin"
+ }
+ ],
+ "name": "createAlias",
+ "owner": "Ext.Base",
+ "doc": "<p>Create aliases for existing prototype methods. Example:</p>\n\n<pre><code>Ext.define('My.cool.Class', {\n method1: function() { ... },\n method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n method3: 'method1',\n method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -> test.method1()\n</code></pre>\n",
+ "linenr": 648,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Base3.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/KeyMap.js",
- "linenr": 66,
- "html_filename": "KeyMap.html",
- "href": "KeyMap.html#Ext-util-KeyMap-method-addBinding",
- "shortDoc": "Add a new binding to this KeyMap. The following config object properties are supported:\n\nProperty Type ..."
- },
- {
- "tagname": "method",
- "name": "destroy",
- "member": "Ext.util.KeyMap",
- "doc": "<p>Destroys the KeyMap instance and removes all handlers.</p>\n",
- "params": [
- {
- "type": "Boolean",
- "name": "removeEl",
- "doc": "<p>True to also remove the attached element</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "KeyMap.html#Ext-util-KeyMap-method-destroy",
+ "shortDoc": "Destroys the KeyMap instance and removes all handlers. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/KeyMap.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Boolean",
+ "optional": false,
+ "doc": "<p>True to also remove the attached element</p>\n",
+ "name": "removeEl"
+ }
+ ],
+ "name": "destroy",
+ "owner": "Ext.util.KeyMap",
+ "doc": "<p>Destroys the KeyMap instance and removes all handlers.</p>\n",
+ "linenr": 297,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "KeyMap.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/KeyMap.js",
- "linenr": 295,
- "html_filename": "KeyMap.html",
- "href": "KeyMap.html#Ext-util-KeyMap-method-destroy",
- "shortDoc": "<p>Destroys the KeyMap instance and removes all handlers.</p>\n"
- },
- {
- "tagname": "method",
- "name": "disable",
- "member": "Ext.util.KeyMap",
- "doc": "<p>Disable this KeyMap</p>\n",
- "params": [
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "KeyMap.html#Ext-util-KeyMap-method-disable",
+ "shortDoc": "Disable this KeyMap ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/KeyMap.js",
+ "private": false,
+ "params": [
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ ],
+ "name": "disable",
+ "owner": "Ext.util.KeyMap",
+ "doc": "<p>Disable this KeyMap</p>\n",
+ "linenr": 275,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "KeyMap.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/KeyMap.js",
- "linenr": 273,
- "html_filename": "KeyMap.html",
- "href": "KeyMap.html#Ext-util-KeyMap-method-disable",
- "shortDoc": "<p>Disable this KeyMap</p>\n"
- },
- {
- "tagname": "method",
- "name": "enable",
- "member": "Ext.util.KeyMap",
- "doc": "<p>Enables this KeyMap</p>\n",
- "params": [
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "KeyMap.html#Ext-util-KeyMap-method-enable",
+ "shortDoc": "Enables this KeyMap ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/KeyMap.js",
+ "private": false,
+ "params": [
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ ],
+ "name": "enable",
+ "owner": "Ext.util.KeyMap",
+ "doc": "<p>Enables this KeyMap</p>\n",
+ "linenr": 265,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "KeyMap.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/KeyMap.js",
- "linenr": 263,
- "html_filename": "KeyMap.html",
- "href": "KeyMap.html#Ext-util-KeyMap-method-enable",
- "shortDoc": "<p>Enables this KeyMap</p>\n"
- },
- {
- "tagname": "method",
- "name": "isEnabled",
- "member": "Ext.util.KeyMap",
- "doc": "<p>Returns true if this KeyMap is enabled</p>\n",
- "params": [
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Base3.html#Ext-Base-method-getName",
+ "shortDoc": "Get the current class' name in string format. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
+ "private": false,
+ "params": [
- ],
- "return": {
- "type": "Boolean",
- "doc": "\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/KeyMap.js",
- "linenr": 255,
- "html_filename": "KeyMap.html",
- "href": "KeyMap.html#Ext-util-KeyMap-method-isEnabled",
- "shortDoc": "<p>Returns true if this KeyMap is enabled</p>\n"
- },
- {
- "tagname": "method",
- "name": "on",
- "member": "Ext.util.KeyMap",
- "doc": "<p>Shorthand for adding a single key listener</p>\n",
- "params": [
- {
- "type": "Number/Array/Object",
- "name": "key",
- "doc": "<p>Either the numeric key code, array of key codes or an object with the\nfollowing options:\n{key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)}</p>\n",
- "optional": false
+ ],
+ "name": "getName",
+ "owner": "Ext.Base",
+ "doc": "<p>Get the current class' name in string format.</p>\n\n<pre><code>Ext.define('My.cool.Class', {\n constructor: function() {\n alert(this.self.getName()); // alerts 'My.cool.Class'\n }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n</code></pre>\n",
+ "linenr": 631,
+ "return": {
+ "type": "String",
+ "doc": "<p>className</p>\n"
},
- {
- "type": "Function",
- "name": "fn",
- "doc": "<p>The function to call</p>\n",
- "optional": false
+ "html_filename": "Base3.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Base3.html#Ext-Base-method-implement",
+ "shortDoc": "Add methods / properties to the prototype of this class. ...",
+ "static": true,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "\n",
+ "name": "members"
+ }
+ ],
+ "name": "implement",
+ "owner": "Ext.Base",
+ "doc": "<p>Add methods / properties to the prototype of this class.</p>\n\n<pre><code>Ext.define('My.awesome.Cat', {\n constructor: function() {\n ...\n }\n});\n\n My.awesome.Cat.implement({\n meow: function() {\n alert('Meowww...');\n }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n</code></pre>\n",
+ "linenr": 415,
+ "return": {
+ "type": "void",
+ "doc": "\n"
},
- {
+ "html_filename": "Base3.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": true,
+ "tagname": "method",
+ "href": "Base3.html#Ext-Base-method-initConfig",
+ "shortDoc": "Initialize configuration for this class. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "\n",
+ "name": "config"
+ }
+ ],
+ "name": "initConfig",
+ "owner": "Ext.Base",
+ "doc": "<p>Initialize configuration for this class. a typical example:</p>\n\n<pre><code>Ext.define('My.awesome.Class', {\n // The default config\n config: {\n name: 'Awesome',\n isAwesome: true\n },\n\n constructor: function(config) {\n this.initConfig(config);\n\n return this;\n }\n});\n\nvar awesome = new My.awesome.Class({\n name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n</code></pre>\n",
+ "linenr": 63,
+ "return": {
"type": "Object",
- "name": "scope",
- "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the browser window.</p>\n",
- "optional": true
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ "doc": "<p>mixins The mixin prototypes as key - value pairs</p>\n"
+ },
+ "html_filename": "Base3.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/KeyMap.js",
- "linenr": 227,
- "html_filename": "KeyMap.html",
- "href": "KeyMap.html#Ext-util-KeyMap-method-on",
- "shortDoc": "<p>Shorthand for adding a single key listener</p>\n"
- },
- {
- "tagname": "method",
- "name": "setDisabled",
- "member": "Ext.util.KeyMap",
- "doc": "<p>Convenience function for setting disabled/enabled by boolean.</p>\n",
- "params": [
- {
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "KeyMap.html#Ext-util-KeyMap-method-isEnabled",
+ "shortDoc": "Returns true if this KeyMap is enabled ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/KeyMap.js",
+ "private": false,
+ "params": [
+
+ ],
+ "name": "isEnabled",
+ "owner": "Ext.util.KeyMap",
+ "doc": "<p>Returns true if this KeyMap is enabled</p>\n",
+ "linenr": 257,
+ "return": {
"type": "Boolean",
- "name": "disabled",
- "doc": "\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ "doc": "\n"
+ },
+ "html_filename": "KeyMap.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/KeyMap.js",
- "linenr": 283,
- "html_filename": "KeyMap.html",
- "href": "KeyMap.html#Ext-util-KeyMap-method-setDisabled",
- "shortDoc": "<p>Convenience function for setting disabled/enabled by boolean.</p>\n"
- }
- ],
- "property": [
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "KeyMap.html#Ext-util-KeyMap-method-on",
+ "shortDoc": "Shorthand for adding a single key listener ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/KeyMap.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Number/Array/Object",
+ "optional": false,
+ "doc": "<p>Either the numeric key code, array of key codes or an object with the\nfollowing options:\n{key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)}</p>\n",
+ "name": "key"
+ },
+ {
+ "type": "Function",
+ "optional": false,
+ "doc": "<p>The function to call</p>\n",
+ "name": "fn"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the browser window.</p>\n",
+ "name": "scope"
+ }
+ ],
+ "name": "on",
+ "owner": "Ext.util.KeyMap",
+ "doc": "<p>Shorthand for adding a single key listener</p>\n",
+ "linenr": 229,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "KeyMap.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Base3.html#Ext-Base-method-override",
+ "shortDoc": "Override prototype members of this class. ...",
+ "static": true,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "\n",
+ "name": "members"
+ }
+ ],
+ "name": "override",
+ "owner": "Ext.Base",
+ "doc": "<p>Override prototype members of this class. Overridden methods can be invoked via\n<a href=\"#/api/Ext.Base-method-callOverridden\" rel=\"Ext.Base-method-callOverridden\" class=\"docClass\">Ext.Base.callOverridden</a></p>\n\n<pre><code>Ext.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\n</code></pre>\n",
+ "linenr": 518,
+ "return": {
+ "type": "Ext.Base",
+ "doc": "<p>this</p>\n"
+ },
+ "html_filename": "Base3.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "KeyMap.html#Ext-util-KeyMap-method-setDisabled",
+ "shortDoc": "Convenience function for setting disabled/enabled by boolean. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/KeyMap.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Boolean",
+ "optional": false,
+ "doc": "\n",
+ "name": "disabled"
+ }
+ ],
+ "name": "setDisabled",
+ "owner": "Ext.util.KeyMap",
+ "doc": "<p>Convenience function for setting disabled/enabled by boolean.</p>\n",
+ "linenr": 285,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "KeyMap.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": true,
+ "tagname": "method",
+ "href": "Base3.html#Ext-Base-method-statics",
+ "shortDoc": "Get the reference to the class from which this object was instantiated. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
+ "private": false,
+ "params": [
- ],
- "event": [
+ ],
+ "name": "statics",
+ "owner": "Ext.Base",
+ "doc": "<p>Get the reference to the class from which this object was instantiated. Note that unlike <a href=\"#/api/Ext.Base-property-self\" rel=\"Ext.Base-property-self\" class=\"docClass\">Ext.Base.self</a>,\n<code>this.statics()</code> is scope-independent and it always returns the class from which it was called, regardless of what\n<code>this</code> points to during run-time</p>\n\n<pre><code>Ext.define('My.Cat', {\n statics: {\n totalCreated: 0,\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n var statics = this.statics();\n\n alert(statics.speciesName); // always equals to 'Cat' no matter what 'this' refers to\n // equivalent to: My.Cat.speciesName\n\n alert(this.self.speciesName); // dependent on 'this'\n\n statics.totalCreated++;\n\n return this;\n },\n\n clone: function() {\n var cloned = new this.self; // dependent on 'this'\n\n cloned.groupName = this.statics().speciesName; // equivalent to: My.Cat.speciesName\n\n return cloned;\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n },\n\n constructor: function() {\n this.callParent();\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\nalert(clone.groupName); // alerts 'Cat'\n\nalert(My.Cat.totalCreated); // alerts 3\n</code></pre>\n",
+ "linenr": 199,
+ "return": {
+ "type": "Class",
+ "doc": "\n"
+ },
+ "html_filename": "Base3.html"
+ }
+ ],
+ "property": [
+ {
+ "type": "Class",
+ "deprecated": null,
+ "alias": null,
+ "protected": true,
+ "tagname": "property",
+ "href": "Base3.html#Ext-Base-property-self",
+ "shortDoc": "Get the reference to the current class from which this object was instantiated. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
+ "private": false,
+ "name": "self",
+ "owner": "Ext.Base",
+ "doc": "<p>Get the reference to the current class from which this object was instantiated. Unlike <a href=\"#/api/Ext.Base-method-statics\" rel=\"Ext.Base-method-statics\" class=\"docClass\">Ext.Base.statics</a>,\n<code>this.self</code> is scope-dependent and it's meant to be used for dynamic inheritance. See <a href=\"#/api/Ext.Base-method-statics\" rel=\"Ext.Base-method-statics\" class=\"docClass\">Ext.Base.statics</a>\nfor a detailed comparison</p>\n\n<pre><code>Ext.define('My.Cat', {\n statics: {\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n alert(this.self.speciesName); / dependent on 'this'\n\n return this;\n },\n\n clone: function() {\n return new this.self();\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\n</code></pre>\n",
+ "linenr": 18,
+ "html_filename": "Base3.html"
+ }
+ ],
+ "cssVar": [
- ],
- "filename": "/Users/nick/Projects/sencha/SDK/extjs/src/util/KeyMap.js",
- "linenr": 1,
- "html_filename": "KeyMap.html",
- "href": "KeyMap.html#Ext-util-KeyMap",
- "cssVar": [
+ ],
+ "cssMixin": [
- ],
- "cssMixin": [
+ ],
+ "event": [
- ],
- "component": false,
+ ]
+ },
+ "singleton": false,
+ "alias": null,
"superclasses": [
+ "Ext.Base"
+ ],
+ "protected": false,
+ "tagname": "class",
+ "mixins": [
],
+ "href": "KeyMap.html#Ext-util-KeyMap",
"subclasses": [
],
+ "static": false,
+ "author": null,
+ "component": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/extjs/src/util/KeyMap.js",
+ "private": false,
+ "alternateClassNames": [
+ "Ext.KeyMap"
+ ],
+ "name": "Ext.util.KeyMap",
+ "doc": "<p>Handles mapping keys to actions for an element. One key map can be used for multiple actions.\nThe constructor accepts the same config object as defined by <a href=\"#/api/Ext.util.KeyMap-method-addBinding\" rel=\"Ext.util.KeyMap-method-addBinding\" class=\"docClass\">addBinding</a>.\nIf you bind a callback function to a KeyMap, anytime the KeyMap handles an expected key\ncombination it will call the function with this signature (if the match is a multi-key\ncombination the callback will still be called only once): (String key, <a href=\"#/api/Ext.EventObject\" rel=\"Ext.EventObject\" class=\"docClass\">Ext.EventObject</a> e)\nA KeyMap can also handle a string representation of keys.<br />\nUsage:</p>\n\n<pre><code>// map one key by key code\nvar map = new Ext.util.KeyMap(\"my-element\", {\n key: 13, // or Ext.EventObject.ENTER\n fn: myHandler,\n scope: myObject\n});\n\n// map multiple keys to one action by string\nvar map = new Ext.util.KeyMap(\"my-element\", {\n key: \"a\\r\\n\\t\",\n fn: myHandler,\n scope: myObject\n});\n\n// map multiple keys to multiple actions by strings and array of codes\nvar map = new Ext.util.KeyMap(\"my-element\", [\n {\n key: [10,13],\n fn: function(){ alert(\"Return was pressed\"); }\n }, {\n key: \"abc\",\n fn: function(){ alert('a, b or c was pressed'); }\n }, {\n key: \"\\t\",\n ctrl:true,\n shift:true,\n fn: function(){ alert('Control + shift + tab was pressed.'); }\n }\n]);\n</code></pre>\n\n\n<p><b>Note: A KeyMap starts enabled</b></p>\n",
"mixedInto": [
],
- "allMixins": [
+ "linenr": 1,
+ "xtypes": [
- ]
+ ],
+ "html_filename": "KeyMap.html",
+ "extends": "Ext.Base"
});
\ No newline at end of file
git.ithinksw.org / extjs.git / blobdiff