Ext.data.JsonP.Ext_ElementLoader({
- "tagname": "class",
- "name": "Ext.ElementLoader",
- "doc": "<p>A class used to load remote content to an Element. Sample usage:</p>\n\n<pre><code>Ext.get('el').load({\n url: 'myPage.php',\n scripts: true,\n params: {\n id: 1\n }\n});\n</code></pre>\n\n\n<p>\nIn general this class will not be instanced directly, rather the <a href=\"#/api/Ext.core.Element-event-load\" rel=\"Ext.core.Element-event-load\" class=\"docClass\">Ext.core.Element.load</a> method\nwill be used.\n</p>\n\n",
- "extends": null,
- "mixins": [
+ "allMixins": [
"Ext.util.Observable"
],
- "alternateClassNames": [
-
- ],
- "xtype": null,
- "author": null,
+ "deprecated": null,
"docauthor": null,
- "singleton": false,
- "private": false,
- "cfg": [
- {
- "tagname": "cfg",
- "name": "ajaxOptions",
- "member": "Ext.ElementLoader",
- "type": "Object",
- "doc": "<p>Any additional options to be passed to the request, for example timeout or headers. Defaults to <tt>null</tt>.</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
- "linenr": 75,
- "html_filename": "ElementLoader.html",
- "href": "ElementLoader.html#Ext-ElementLoader-cfg-ajaxOptions"
- },
- {
- "tagname": "cfg",
- "name": "autoLoad",
- "member": "Ext.ElementLoader",
- "type": "Boolean/Object",
- "doc": "<p>True to have the loader make a request as soon as it is created. Defaults to <tt>false</tt>.\nThis argument can also be a set of options that will be passed to <a href=\"#/api/Ext.ElementLoader-method-load\" rel=\"Ext.ElementLoader-method-load\" class=\"docClass\">load</a> is called.</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
- "linenr": 59,
- "html_filename": "ElementLoader.html",
- "href": "ElementLoader.html#Ext-ElementLoader-cfg-autoLoad",
- "shortDoc": "True to have the loader make a request as soon as it is created. Defaults to false.\nThis argument can also be a set o..."
- },
- {
- "tagname": "cfg",
- "name": "baseParams",
- "member": "Ext.ElementLoader",
- "type": "Object",
- "doc": "<p>Params that will be attached to every request. These parameters\nwill not be overridden by any params in the load options. Defaults to <tt>null</tt>.</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
- "linenr": 53,
- "html_filename": "ElementLoader.html",
- "href": "ElementLoader.html#Ext-ElementLoader-cfg-baseParams",
- "shortDoc": "Params that will be attached to every request. These parameters\nwill not be overridden by any params in the load opti..."
- },
- {
- "tagname": "cfg",
- "name": "failure",
- "member": "Ext.ElementLoader",
- "type": "Function",
- "doc": "<p>A function to be called when a load request fails.</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
- "linenr": 89,
- "html_filename": "ElementLoader.html",
- "href": "ElementLoader.html#Ext-ElementLoader-cfg-failure"
- },
- {
- "tagname": "cfg",
- "name": "listeners",
- "member": "Ext.util.Observable",
- "type": "Object",
- "doc": "<p>(optional) <p>A config object containing one or more event handlers to be added to this\nobject during initialization. This should be a valid listeners config object as specified in the\n<a href=\"#/api/Ext.ElementLoader-method-addListener\" rel=\"Ext.ElementLoader-method-addListener\" class=\"docClass\">addListener</a> example for attaching multiple handlers at once.</p></p>\n\n<br><p><b><u>DOM events from ExtJs <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a></u></b></p>\n\n\n<br><p>While <i>some</i> ExtJs Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this\n\n\n<p>is usually only done when extra value can be added. For example the <a href=\"#/api/Ext.view.View\" rel=\"Ext.view.View\" class=\"docClass\">DataView</a>'s\n<b><code><a href=\"#/api/Ext.view.View--click\" rel=\"Ext.view.View--click\" class=\"docClass\">click</a></code></b> event passing the node clicked on. To access DOM\nevents directly from a child element of a Component, we need to specify the <code>element</code> option to\nidentify the Component property to add a DOM listener to:</p>\n\n<pre><code>new Ext.panel.Panel({\n width: 400,\n height: 200,\n dockedItems: [{\n xtype: 'toolbar'\n }],\n listeners: {\n click: {\n element: 'el', //bind to the underlying el property on the panel\n fn: function(){ console.log('click el'); }\n },\n dblclick: {\n element: 'body', //bind to the underlying body property on the panel\n fn: function(){ console.log('dblclick body'); }\n }\n }\n});\n</code></pre>\n\n\n<p></p></p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 103,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-cfg-listeners",
- "shortDoc": "(optional) A config object containing one or more event handlers to be added to this\nobject during initialization. T..."
- },
- {
- "tagname": "cfg",
- "name": "loadMask",
- "member": "Ext.ElementLoader",
- "type": "Mixed",
- "doc": "<p>True or a string to show when the element is loading.</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
- "linenr": 70,
- "html_filename": "ElementLoader.html",
- "href": "ElementLoader.html#Ext-ElementLoader-cfg-loadMask"
- },
- {
- "tagname": "cfg",
- "name": "params",
- "member": "Ext.ElementLoader",
- "type": "Object",
- "doc": "<p>Any params to be attached to the Ajax request. These parameters will\nbe overridden by any params in the load options. Defaults to <tt>null</tt>.</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
- "linenr": 47,
- "html_filename": "ElementLoader.html",
- "href": "ElementLoader.html#Ext-ElementLoader-cfg-params",
- "shortDoc": "Any params to be attached to the Ajax request. These parameters will\nbe overridden by any params in the load options...."
- },
- {
- "tagname": "cfg",
- "name": "renderer",
- "member": "Ext.ElementLoader",
- "type": "Function",
- "doc": "<p>A custom function to render the content to the element. The passed parameters\nare</p>\n\n<ul>\n<li>The loader</li>\n<li>The response</li>\n<li>The active request</li>\n</ul>\n\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
- "linenr": 97,
- "html_filename": "ElementLoader.html",
- "href": "ElementLoader.html#Ext-ElementLoader-cfg-renderer",
- "shortDoc": "A custom function to render the content to the element. The passed parameters\nare\n\n\nThe loader\nThe response\nThe activ..."
- },
- {
- "tagname": "cfg",
- "name": "scope",
- "member": "Ext.ElementLoader",
- "type": "Object",
- "doc": "<p>The scope to execute the <a href=\"#/api/Ext.ElementLoader-cfg-success\" rel=\"Ext.ElementLoader-cfg-success\" class=\"docClass\">success</a> and <a href=\"#/api/Ext.ElementLoader-cfg-failure\" rel=\"Ext.ElementLoader-cfg-failure\" class=\"docClass\">failure</a> functions in.</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
- "linenr": 93,
- "html_filename": "ElementLoader.html",
- "href": "ElementLoader.html#Ext-ElementLoader-cfg-scope"
- },
- {
- "tagname": "cfg",
- "name": "scripts",
- "member": "Ext.ElementLoader",
- "type": "Boolean",
- "doc": "<p>True to parse any inline script tags in the response.</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
- "linenr": 80,
- "html_filename": "ElementLoader.html",
- "href": "ElementLoader.html#Ext-ElementLoader-cfg-scripts"
- },
- {
- "tagname": "cfg",
- "name": "success",
- "member": "Ext.ElementLoader",
- "type": "Function",
- "doc": "<p>A function to be called when a load request is successful.</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
- "linenr": 85,
- "html_filename": "ElementLoader.html",
- "href": "ElementLoader.html#Ext-ElementLoader-cfg-success"
- },
- {
- "tagname": "cfg",
- "name": "target",
- "member": "Ext.ElementLoader",
- "type": "Mixed",
- "doc": "<p>The target element for the loader. It can be the DOM element, the id or an Ext.Element.</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
- "linenr": 65,
- "html_filename": "ElementLoader.html",
- "href": "ElementLoader.html#Ext-ElementLoader-cfg-target"
- },
- {
- "tagname": "cfg",
- "name": "url",
- "member": "Ext.ElementLoader",
- "type": "String",
- "doc": "<p>The url to retrieve the content from. Defaults to <tt>null</tt>.</p>\n",
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
- "linenr": 42,
- "html_filename": "ElementLoader.html",
- "href": "ElementLoader.html#Ext-ElementLoader-cfg-url"
- }
- ],
- "method": [
- {
- "tagname": "method",
- "name": "abort",
- "member": "Ext.ElementLoader",
- "doc": "<p>Aborts the active load request</p>\n",
- "params": [
-
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ "members": {
+ "cfg": [
+ {
+ "type": "Object",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "ElementLoader.html#Ext-ElementLoader-cfg-ajaxOptions",
+ "shortDoc": "Any additional options to be passed to the request, for example timeout or headers. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ElementLoader.js",
+ "private": false,
+ "name": "ajaxOptions",
+ "owner": "Ext.ElementLoader",
+ "doc": "<p>Any additional options to be passed to the request, for example timeout or headers. Defaults to <tt>null</tt>.</p>\n",
+ "linenr": 75,
+ "html_filename": "ElementLoader.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
- "linenr": 180,
- "html_filename": "ElementLoader.html",
- "href": "ElementLoader.html#Ext-ElementLoader-method-abort",
- "shortDoc": "<p>Aborts the active load request</p>\n"
- },
- {
- "tagname": "method",
- "name": "addEvents",
- "member": "Ext.util.Observable",
- "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
- "params": [
- {
- "type": "Object/String",
- "name": "o",
- "doc": "<p>Either an object with event names as properties with a value of <code>true</code>\nor the first event name string if multiple event names are being passed as separate parameters.</p>\n",
- "optional": false
- },
- {
- "type": "String",
- "name": "",
- "doc": "<p>[additional] Optional additional event names if multiple event names are being passed as separate parameters.\nUsage:</p>\n\n<pre><code>this.addEvents('storeloaded', 'storecleared');\n</code></pre>\n\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ {
+ "type": "Boolean/Object",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "ElementLoader.html#Ext-ElementLoader-cfg-autoLoad",
+ "shortDoc": "True to have the loader make a request as soon as it is created. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ElementLoader.js",
+ "private": false,
+ "name": "autoLoad",
+ "owner": "Ext.ElementLoader",
+ "doc": "<p>True to have the loader make a request as soon as it is created. Defaults to <tt>false</tt>.\nThis argument can also be a set of options that will be passed to <a href=\"#/api/Ext.ElementLoader-method-load\" rel=\"Ext.ElementLoader-method-load\" class=\"docClass\">load</a> is called.</p>\n",
+ "linenr": 59,
+ "html_filename": "ElementLoader.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 452,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-addEvents",
- "shortDoc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n"
- },
- {
- "tagname": "method",
- "name": "addListener",
- "member": "Ext.util.Observable",
- "doc": "<p>Appends an event handler to this object.</p>\n",
- "params": [
- {
- "type": "String",
- "name": "eventName",
- "doc": "<p>The name of the event to listen for. May also be an object who's property names are event names. See</p>\n",
- "optional": false
+ {
+ "type": "Object",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "ElementLoader.html#Ext-ElementLoader-cfg-baseParams",
+ "shortDoc": "Params that will be attached to every request. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ElementLoader.js",
+ "private": false,
+ "name": "baseParams",
+ "owner": "Ext.ElementLoader",
+ "doc": "<p>Params that will be attached to every request. These parameters\nwill not be overridden by any params in the load options. Defaults to <tt>null</tt>.</p>\n",
+ "linenr": 53,
+ "html_filename": "ElementLoader.html"
+ },
+ {
+ "type": "Function",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "ElementLoader.html#Ext-ElementLoader-cfg-failure",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ElementLoader.js",
+ "private": false,
+ "name": "failure",
+ "owner": "Ext.ElementLoader",
+ "doc": "<p>A function to be called when a load request fails.</p>\n",
+ "linenr": 89,
+ "html_filename": "ElementLoader.html"
+ },
+ {
+ "type": "Object",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "Observable.html#Ext-util-Observable-cfg-listeners",
+ "shortDoc": "A config object containing one or more event handlers to be added to this object during initialization. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "name": "listeners",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>A config object containing one or more event handlers to be added to this object during initialization. This\nshould be a valid listeners config object as specified in the <a href=\"#/api/Ext.ElementLoader-method-addListener\" rel=\"Ext.ElementLoader-method-addListener\" class=\"docClass\">addListener</a> example for attaching multiple\nhandlers at once.</p>\n\n<p><strong>DOM events from ExtJS <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a></strong></p>\n\n<p>While <em>some</em> ExtJs Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this is usually\nonly done when extra value can be added. For example the <a href=\"#/api/Ext.view.View\" rel=\"Ext.view.View\" class=\"docClass\">DataView</a>'s <strong><code><a href=\"#/api/Ext.view.View-event-itemclick\" rel=\"Ext.view.View-event-itemclick\" class=\"docClass\">itemclick</a></code></strong> event passing the node clicked on. To access DOM events directly from a\nchild element of a Component, we need to specify the <code>element</code> option to identify the Component property to add a\nDOM listener to:</p>\n\n<pre><code>new Ext.panel.Panel({\n width: 400,\n height: 200,\n dockedItems: [{\n xtype: 'toolbar'\n }],\n listeners: {\n click: {\n element: 'el', //bind to the underlying el property on the panel\n fn: function(){ console.log('click el'); }\n },\n dblclick: {\n element: 'body', //bind to the underlying body property on the panel\n fn: function(){ console.log('dblclick body'); }\n }\n }\n});\n</code></pre>\n",
+ "linenr": 102,
+ "html_filename": "Observable.html"
+ },
+ {
+ "type": "Mixed",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "ElementLoader.html#Ext-ElementLoader-cfg-loadMask",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ElementLoader.js",
+ "private": false,
+ "name": "loadMask",
+ "owner": "Ext.ElementLoader",
+ "doc": "<p>True or a string to show when the element is loading.</p>\n",
+ "linenr": 70,
+ "html_filename": "ElementLoader.html"
+ },
+ {
+ "type": "Object",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "ElementLoader.html#Ext-ElementLoader-cfg-params",
+ "shortDoc": "Any params to be attached to the Ajax request. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ElementLoader.js",
+ "private": false,
+ "name": "params",
+ "owner": "Ext.ElementLoader",
+ "doc": "<p>Any params to be attached to the Ajax request. These parameters will\nbe overridden by any params in the load options. Defaults to <tt>null</tt>.</p>\n",
+ "linenr": 47,
+ "html_filename": "ElementLoader.html"
+ },
+ {
+ "type": "Function",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "ElementLoader.html#Ext-ElementLoader-cfg-renderer",
+ "shortDoc": "A custom function to render the content to the element. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ElementLoader.js",
+ "private": false,
+ "name": "renderer",
+ "owner": "Ext.ElementLoader",
+ "doc": "<p>A custom function to render the content to the element. The passed parameters\nare</p>\n\n<ul>\n<li>The loader</li>\n<li>The response</li>\n<li>The active request</li>\n</ul>\n\n",
+ "linenr": 97,
+ "html_filename": "ElementLoader.html"
+ },
+ {
+ "type": "Object",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "ElementLoader.html#Ext-ElementLoader-cfg-scope",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ElementLoader.js",
+ "private": false,
+ "name": "scope",
+ "owner": "Ext.ElementLoader",
+ "doc": "<p>The scope to execute the <a href=\"#/api/Ext.ElementLoader-cfg-success\" rel=\"Ext.ElementLoader-cfg-success\" class=\"docClass\">success</a> and <a href=\"#/api/Ext.ElementLoader-cfg-failure\" rel=\"Ext.ElementLoader-cfg-failure\" class=\"docClass\">failure</a> functions in.</p>\n",
+ "linenr": 93,
+ "html_filename": "ElementLoader.html"
+ },
+ {
+ "type": "Boolean",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "ElementLoader.html#Ext-ElementLoader-cfg-scripts",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ElementLoader.js",
+ "private": false,
+ "name": "scripts",
+ "owner": "Ext.ElementLoader",
+ "doc": "<p>True to parse any inline script tags in the response.</p>\n",
+ "linenr": 80,
+ "html_filename": "ElementLoader.html"
+ },
+ {
+ "type": "Function",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "ElementLoader.html#Ext-ElementLoader-cfg-success",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ElementLoader.js",
+ "private": false,
+ "name": "success",
+ "owner": "Ext.ElementLoader",
+ "doc": "<p>A function to be called when a load request is successful.</p>\n",
+ "linenr": 85,
+ "html_filename": "ElementLoader.html"
+ },
+ {
+ "type": "Mixed",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "ElementLoader.html#Ext-ElementLoader-cfg-target",
+ "shortDoc": "The target element for the loader. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ElementLoader.js",
+ "private": false,
+ "name": "target",
+ "owner": "Ext.ElementLoader",
+ "doc": "<p>The target element for the loader. It can be the DOM element, the id or an Ext.Element.</p>\n",
+ "linenr": 65,
+ "html_filename": "ElementLoader.html"
+ },
+ {
+ "type": "String",
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "cfg",
+ "href": "ElementLoader.html#Ext-ElementLoader-cfg-url",
+ "shortDoc": "The url to retrieve the content from. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ElementLoader.js",
+ "private": false,
+ "name": "url",
+ "owner": "Ext.ElementLoader",
+ "doc": "<p>The url to retrieve the content from. Defaults to <tt>null</tt>.</p>\n",
+ "linenr": 42,
+ "html_filename": "ElementLoader.html"
+ }
+ ],
+ "method": [
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "ElementLoader.html#Ext-ElementLoader-method-abort",
+ "shortDoc": "Aborts the active load request ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ElementLoader.js",
+ "private": false,
+ "params": [
+
+ ],
+ "name": "abort",
+ "owner": "Ext.ElementLoader",
+ "doc": "<p>Aborts the active load request</p>\n",
+ "linenr": 180,
+ "return": {
+ "type": "void",
+ "doc": "\n"
},
- {
- "type": "Function",
- "name": "handler",
- "doc": "<p>The method the event invokes.</p>\n",
- "optional": false
+ "html_filename": "ElementLoader.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-addEvents",
+ "shortDoc": "Adds the specified events to the list of events which this Observable may fire. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Object/String",
+ "optional": false,
+ "doc": "<p>Either an object with event names as properties with a value of <code>true</code> or the first\nevent name string if multiple event names are being passed as separate parameters. Usage:</p>\n\n<pre><code>this.addEvents({\n storeloaded: true,\n storecleared: true\n});\n</code></pre>\n",
+ "name": "o"
+ },
+ {
+ "type": "String...",
+ "optional": false,
+ "doc": "<p>Optional additional event names if multiple event names are being passed as separate\nparameters. Usage:</p>\n\n<pre><code>this.addEvents('storeloaded', 'storecleared');\n</code></pre>\n",
+ "name": "more"
+ }
+ ],
+ "name": "addEvents",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Adds the specified events to the list of events which this Observable may fire.</p>\n",
+ "linenr": 494,
+ "return": {
+ "type": "void",
+ "doc": "\n"
},
- {
- "type": "Object",
- "name": "scope",
- "doc": "<p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></p>\n",
- "optional": true
+ "html_filename": "Observable.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-addListener",
+ "shortDoc": "Appends an event handler to this object. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "String",
+ "optional": false,
+ "doc": "<p>The name of the event to listen for. May also be an object who's property names are\nevent names.</p>\n",
+ "name": "eventName"
+ },
+ {
+ "type": "Function",
+ "optional": false,
+ "doc": "<p>The method the event invokes. Will be called with arguments given to\n<a href=\"#/api/Ext.ElementLoader-method-fireEvent\" rel=\"Ext.ElementLoader-method-fireEvent\" class=\"docClass\">fireEvent</a> plus the <code>options</code> parameter described below.</p>\n",
+ "name": "handler"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) The scope (<code>this</code> reference) in which the handler function is executed. <strong>If\nomitted, defaults to the object which fired the event.</strong></p>\n",
+ "name": "scope"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) An object containing handler configuration.</p>\n\n<p><strong>Note:</strong> Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.</p>\n\n<p>This object may contain any of the following properties:</p>\n\n<ul>\n<li><p><strong>scope</strong> : Object</p>\n\n<p>The scope (<code>this</code> reference) in which the handler function is executed. <strong>If omitted, defaults to the object\nwhich fired the event.</strong></p></li>\n<li><p><strong>delay</strong> : Number</p>\n\n<p>The number of milliseconds to delay the invocation of the handler after the event fires.</p></li>\n<li><p><strong>single</strong> : Boolean</p>\n\n<p>True to add a handler to handle just the next firing of the event, and then remove itself.</p></li>\n<li><p><strong>buffer</strong> : Number</p>\n\n<p>Causes the handler to be scheduled to run in an <a href=\"#/api/Ext.util.DelayedTask\" rel=\"Ext.util.DelayedTask\" class=\"docClass\">Ext.util.DelayedTask</a> delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is <em>not</em> invoked, but the new\nhandler is scheduled in its place.</p></li>\n<li><p><strong>target</strong> : Observable</p>\n\n<p>Only call the handler if the event was fired on the target Observable, <em>not</em> if the event was bubbled up from a\nchild Observable.</p></li>\n<li><p><strong>element</strong> : String</p>\n\n<p><strong>This option is only valid for listeners bound to <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a>.</strong> The name of a Component\nproperty which references an element to add a listener to.</p>\n\n<p>This option is useful during Component construction to add DOM event listeners to elements of\n<a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a> which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:</p>\n\n<pre><code>new Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n</code></pre></li>\n</ul>\n\n\n<p><strong>Combining Options</strong></p>\n\n<p>Using the options argument, it is possible to combine different types of listeners:</p>\n\n<p>A delayed, one-time listener.</p>\n\n<pre><code>myPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\n</code></pre>\n\n<p><strong>Attaching multiple handlers in 1 call</strong></p>\n\n<p>The method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:</p>\n\n<pre><code>myGridPanel.on({\n cellClick: this.onCellClick,\n mouseover: this.onMouseOver,\n mouseout: this.onMouseOut,\n scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n</code></pre>\n\n<p>One can also specify options for each event handler separately:</p>\n\n<pre><code>myGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n</code></pre>\n",
+ "name": "options"
+ }
+ ],
+ "name": "addListener",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Appends an event handler to this object.</p>\n",
+ "linenr": 278,
+ "return": {
+ "type": "void",
+ "doc": "\n"
},
- {
- "type": "Object",
- "name": "options",
- "doc": "<p>(optional) An object containing handler configuration.\nproperties. This may contain any of the following properties:<ul>\n<li><b>scope</b> : Object<div class=\"sub-desc\">The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></div></li>\n<li><b>delay</b> : Number<div class=\"sub-desc\">The number of milliseconds to delay the invocation of the handler after the event fires.</div></li>\n<li><b>single</b> : Boolean<div class=\"sub-desc\">True to add a handler to handle just the next firing of the event, and then remove itself.</div></li>\n<li><b>buffer</b> : Number<div class=\"sub-desc\">Causes the handler to be scheduled to run in an <a href=\"#/api/Ext.util.DelayedTask\" rel=\"Ext.util.DelayedTask\" class=\"docClass\">Ext.util.DelayedTask</a> delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</div></li>\n<li><b>target</b> : Observable<div class=\"sub-desc\">Only call the handler if the event was fired on the target Observable, <i>not</i>\nif the event was bubbled up from a child Observable.</div></li>\n<li><b>element</b> : String<div class=\"sub-desc\"><b>This option is only valid for listeners bound to <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a>.</b>\nThe name of a Component property which references an element to add a listener to.</p>\n\n<p>This option is useful during Component construction to add DOM event listeners to elements of <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a> which\nwill exist only after the Component is rendered. For example, to add a click listener to a Panel's body:\n<pre><code>new Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n</code></pre></p>\n\n\n<p>When added in this way, the options available are the options applicable to <a href=\"#/api/Ext.core.Element-method-addListener\" rel=\"Ext.core.Element-method-addListener\" class=\"docClass\">Ext.core.Element.addListener</a></p>\n\n\n<p></div></li>\n</ul><br></p>\n\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA delayed, one-time listener.\n<pre><code>myPanel.on('hide', this.handleClick, this, {\nsingle: true,\ndelay: 100\n});</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple events. For example:\n<pre><code>myGridPanel.on({\n cellClick: this.onCellClick,\n mouseover: this.onMouseOver,\n mouseout: this.onMouseOut,\n scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n</code></pre>.\n<p>\n\n",
- "optional": true
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ "html_filename": "Observable.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 271,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-addListener",
- "shortDoc": "<p>Appends an event handler to this object.</p>\n"
- },
- {
- "tagname": "method",
- "name": "addManagedListener",
- "member": "Ext.util.Observable",
- "doc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n",
- "params": [
- {
- "type": "Observable/Element",
- "name": "item",
- "doc": "<p>The item to which to add a listener/listeners.</p>\n",
- "optional": false
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-addManagedListener",
+ "shortDoc": "Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Observable/Element",
+ "optional": false,
+ "doc": "<p>The item to which to add a listener/listeners.</p>\n",
+ "name": "item"
+ },
+ {
+ "type": "Object/String",
+ "optional": false,
+ "doc": "<p>The event name, or an object containing event name properties.</p>\n",
+ "name": "ename"
+ },
+ {
+ "type": "Function",
+ "optional": true,
+ "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the handler function.</p>\n",
+ "name": "fn"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the scope (<code>this</code> reference)\nin which the handler function is executed.</p>\n",
+ "name": "scope"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the\n<a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">addListener</a> options.</p>\n",
+ "name": "opt"
+ }
+ ],
+ "name": "addManagedListener",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed.</p>\n",
+ "linenr": 156,
+ "return": {
+ "type": "void",
+ "doc": "\n"
},
- {
- "type": "Object/String",
- "name": "ename",
- "doc": "<p>The event name, or an object containing event name properties.</p>\n",
- "optional": false
+ "html_filename": "Observable.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"
},
- {
- "type": "Function",
- "name": "fn",
- "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
- "optional": false
+ "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",
+ "doc": "<p>Returns the result after calling the overridden method</p>\n"
},
- {
- "type": "Object",
- "name": "scope",
- "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the scope (<code>this</code> reference) in which the handler function is executed.</p>\n",
- "optional": false
+ "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"
},
- {
- "type": "Object",
- "name": "opt",
- "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">addListener</a> options.</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ "html_filename": "Base3.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 155,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-addManagedListener",
- "shortDoc": "<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component\nis destroyed.\n\n"
- },
- {
- "tagname": "method",
- "name": "capture",
- "member": "Ext.util.Observable",
- "doc": "<p>Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.</p>\n",
- "params": [
- {
- "type": "Observable",
- "name": "o",
- "doc": "<p>The Observable to capture events from.</p>\n",
- "optional": false
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-capture",
+ "shortDoc": "Starts capture on the specified Observable. ...",
+ "static": true,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Observable",
+ "optional": false,
+ "doc": "<p>The Observable to capture events from.</p>\n",
+ "name": "o"
+ },
+ {
+ "type": "Function",
+ "optional": false,
+ "doc": "<p>The function to call when an event is fired.</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\nthe Observable firing the event.</p>\n",
+ "name": "scope"
+ }
+ ],
+ "name": "capture",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Starts capture on the specified Observable. All events will be passed to the supplied function with the event\nname + standard signature of the event <strong>before</strong> the event is fired. If the supplied function returns false,\nthe event will not fire.</p>\n",
+ "linenr": 54,
+ "return": {
+ "type": "void",
+ "doc": "\n"
},
- {
- "type": "Function",
- "name": "fn",
- "doc": "<p>The function to call when an event is fired.</p>\n",
- "optional": false
+ "html_filename": "Observable.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-clearListeners",
+ "shortDoc": "Removes all listeners for this object including the managed listeners ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+
+ ],
+ "name": "clearListeners",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Removes all listeners for this object including the managed listeners</p>\n",
+ "linenr": 425,
+ "return": {
+ "type": "void",
+ "doc": "\n"
},
- {
- "type": "Object",
- "name": "scope",
- "doc": "<p>(optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the Observable firing the event.</p>\n",
- "optional": true
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ "html_filename": "Observable.html"
},
- "private": false,
- "static": true,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 55,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-capture",
- "shortDoc": "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + ..."
- },
- {
- "tagname": "method",
- "name": "clearListeners",
- "member": "Ext.util.Observable",
- "doc": "<p>Removes all listeners for this object including the managed listeners</p>\n",
- "params": [
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners",
+ "shortDoc": "Removes all managed listeners for this object. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ ],
+ "name": "clearManagedListeners",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Removes all managed listeners for this object.</p>\n",
+ "linenr": 454,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Observable.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 383,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-clearListeners",
- "shortDoc": "<p>Removes all listeners for this object including the managed listeners</p>\n"
- },
- {
- "tagname": "method",
- "name": "clearManagedListeners",
- "member": "Ext.util.Observable",
- "doc": "<p>Removes all managed listeners for this object.</p>\n",
- "params": [
+ {
+ "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": [
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ ],
+ "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",
+ "doc": "<p>the created instance.</p>\n"
+ },
+ "html_filename": "Base3.html"
+ },
+ {
+ "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/platform/src/util/Observable.js",
- "linenr": 412,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners",
- "shortDoc": "<p>Removes all managed listeners for this object.</p>\n"
- },
- {
- "tagname": "method",
- "name": "destroy",
- "member": "Ext.ElementLoader",
- "doc": "<p>Destroys the loader. Any active requests will be aborted.</p>\n",
- "params": [
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "ElementLoader.html#Ext-ElementLoader-method-destroy",
+ "shortDoc": "Destroys the loader. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ElementLoader.js",
+ "private": false,
+ "params": [
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ ],
+ "name": "destroy",
+ "owner": "Ext.ElementLoader",
+ "doc": "<p>Destroys the loader. Any active requests will be aborted.</p>\n",
+ "linenr": 364,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "ElementLoader.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
- "linenr": 364,
- "html_filename": "ElementLoader.html",
- "href": "ElementLoader.html#Ext-ElementLoader-method-destroy",
- "shortDoc": "<p>Destroys the loader. Any active requests will be aborted.</p>\n"
- },
- {
- "tagname": "method",
- "name": "enableBubble",
- "member": "Ext.util.Observable",
- "doc": "<p>Enables events fired by this Observable to bubble up an owner hierarchy by calling\n<code>this.getBubbleTarget()</code> if present. There is no implementation in the Observable base class.</p>\n\n\n<p>This is commonly used by Ext.Components to bubble events to owner Containers. See <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>. The default\nimplementation in <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Ext.Component</a> returns the Component's immediate owner. But if a known target is required, this can be overridden to\naccess the required target more quickly.</p>\n\n\n<p>Example:</p>\n\n\n<pre><code>Ext.override(Ext.form.field.Base, {\n// Add functionality to Field's initComponent to enable the change event to bubble\ninitComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n this.enableBubble('change');\n}),\n\n// We know that we want Field's events to bubble directly to the FormPanel.\ngetBubbleTarget : function() {\n if (!this.formPanel) {\n this.formPanel = this.findParentByType('form');\n }\n return this.formPanel;\n}\n});\n\nvar myForm = new Ext.formPanel({\ntitle: 'User Details',\nitems: [{\n ...\n}],\nlisteners: {\n change: function() {\n // Title goes red if form has been modified.\n myForm.header.setStyle('color', 'red');\n }\n}\n});\n</code></pre>\n\n",
- "params": [
- {
- "type": "String/Array",
- "name": "events",
- "doc": "<p>The event name to bubble, or an Array of event names.</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-enableBubble",
+ "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if\npresent. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "String/[String]",
+ "optional": false,
+ "doc": "<p>The event name to bubble, or an Array of event names.</p>\n",
+ "name": "events"
+ }
+ ],
+ "name": "enableBubble",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Enables events fired by this Observable to bubble up an owner hierarchy by calling <code>this.getBubbleTarget()</code> if\npresent. There is no implementation in the Observable base class.</p>\n\n<p>This is commonly used by Ext.Components to bubble events to owner Containers.\nSee <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>. The default implementation in <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Ext.Component</a> returns the\nComponent's immediate owner. But if a known target is required, this can be overridden to access the\nrequired target more quickly.</p>\n\n<p>Example:</p>\n\n<pre><code>Ext.override(Ext.form.field.Base, {\n // Add functionality to Field's initComponent to enable the change event to bubble\n initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n this.enableBubble('change');\n }),\n\n // We know that we want Field's events to bubble directly to the FormPanel.\n getBubbleTarget : function() {\n if (!this.formPanel) {\n this.formPanel = this.findParentByType('form');\n }\n return this.formPanel;\n }\n});\n\nvar myForm = new Ext.formPanel({\n title: 'User Details',\n items: [{\n ...\n }],\n listeners: {\n change: function() {\n // Title goes red if form has been modified.\n myForm.header.setStyle('color', 'red');\n }\n }\n});\n</code></pre>\n",
+ "linenr": 609,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Observable.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 554,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-enableBubble",
- "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present...."
- },
- {
- "tagname": "method",
- "name": "fireEvent",
- "member": "Ext.util.Observable",
- "doc": "<p>Fires the specified event with the passed parameters (minus the event name).</p>\n\n\n<p>An event may be set to bubble up an Observable parent hierarchy (See <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>)\nby calling <a href=\"#/api/Ext.ElementLoader-method-enableBubble\" rel=\"Ext.ElementLoader-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n\n",
- "params": [
- {
- "type": "String",
- "name": "eventName",
- "doc": "<p>The name of the event to fire.</p>\n",
- "optional": false
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-fireEvent",
+ "shortDoc": "Fires the specified event with the passed parameters (minus the event name, plus the options object passed\nto addList...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "String",
+ "optional": false,
+ "doc": "<p>The name of the event to fire.</p>\n",
+ "name": "eventName"
+ },
+ {
+ "type": "Object...",
+ "optional": false,
+ "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
+ "name": "args"
+ }
+ ],
+ "name": "fireEvent",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Fires the specified event with the passed parameters (minus the event name, plus the <code>options</code> object passed\nto <a href=\"#/api/Ext.ElementLoader-method-addListener\" rel=\"Ext.ElementLoader-method-addListener\" class=\"docClass\">addListener</a>).</p>\n\n<p>An event may be set to bubble up an Observable parent hierarchy (See <a href=\"#/api/Ext.Component-method-getBubbleTarget\" rel=\"Ext.Component-method-getBubbleTarget\" class=\"docClass\">Ext.Component.getBubbleTarget</a>) by\ncalling <a href=\"#/api/Ext.ElementLoader-method-enableBubble\" rel=\"Ext.ElementLoader-method-enableBubble\" class=\"docClass\">enableBubble</a>.</p>\n",
+ "linenr": 233,
+ "return": {
+ "type": "Boolean",
+ "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
},
- {
- "type": "Object...",
- "name": "args",
- "doc": "<p>Variable number of parameters are passed to handlers.</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "Boolean",
- "doc": "<p>returns false if any of the handlers return false otherwise it returns true.</p>\n"
+ "html_filename": "Observable.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 232,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-fireEvent",
- "shortDoc": "Fires the specified event with the passed parameters (minus the event name).\n\n\nAn event may be set to bubble up an Ob..."
- },
- {
- "tagname": "method",
- "name": "getTarget",
- "member": "Ext.ElementLoader",
- "doc": "<p>Get the target of this loader.</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": "Ext.Component",
- "doc": "<p>target The target, null if none exists.</p>\n"
- },
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
- "linenr": 172,
- "html_filename": "ElementLoader.html",
- "href": "ElementLoader.html#Ext-ElementLoader-method-getTarget",
- "shortDoc": "<p>Get the target of this loader.</p>\n"
- },
- {
- "tagname": "method",
- "name": "hasListener",
- "member": "Ext.util.Observable",
- "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
- "params": [
- {
+ ],
+ "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",
- "name": "eventName",
- "doc": "<p>The name of the event to check for</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "Boolean",
- "doc": "<p>True if the event is being listened for, else false</p>\n"
+ "doc": "<p>className</p>\n"
+ },
+ "html_filename": "Base3.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 480,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-hasListener",
- "shortDoc": "<p>Checks to see if this object has any listeners for a specified event</p>\n"
- },
- {
- "tagname": "method",
- "name": "isAutoRefreshing",
- "member": "Ext.ElementLoader",
- "doc": "<p>Checks whether the loader is automatically refreshing. See <a href=\"#/api/Ext.ElementLoader-method-startAutoRefresh\" rel=\"Ext.ElementLoader-method-startAutoRefresh\" class=\"docClass\">startAutoRefresh</a>.</p>\n",
- "params": [
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "ElementLoader.html#Ext-ElementLoader-method-getTarget",
+ "shortDoc": "Get the target of this loader. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ElementLoader.js",
+ "private": false,
+ "params": [
- ],
- "return": {
- "type": "Boolean",
- "doc": "<p>True if the loader is automatically refreshing</p>\n"
+ ],
+ "name": "getTarget",
+ "owner": "Ext.ElementLoader",
+ "doc": "<p>Get the target of this loader.</p>\n",
+ "linenr": 172,
+ "return": {
+ "type": "Ext.Component",
+ "doc": "<p>target The target, null if none exists.</p>\n"
+ },
+ "html_filename": "ElementLoader.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
- "linenr": 356,
- "html_filename": "ElementLoader.html",
- "href": "ElementLoader.html#Ext-ElementLoader-method-isAutoRefreshing",
- "shortDoc": "<p>Checks whether the loader is automatically refreshing. See <a href=\"#/api/Ext.ElementLoader-method-startAutoRefresh\" rel=\"Ext.ElementLoader-method-startAutoRefresh\" class=\"docClass\">startAutoRefresh</a>.</p>\n"
- },
- {
- "tagname": "method",
- "name": "load",
- "member": "Ext.ElementLoader",
- "doc": "<p>Load new data from the server.</p>\n",
- "params": [
- {
- "type": "Object",
- "name": "options",
- "doc": "<p>The options for the request. They can be any configuration option that can be specified for\nthe class, with the exception of the target option. Note that any options passed to the method will override any\nclass defaults.</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-hasListener",
+ "shortDoc": "Checks to see if this object has any listeners for a specified event ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "String",
+ "optional": false,
+ "doc": "<p>The name of the event to check for</p>\n",
+ "name": "eventName"
+ }
+ ],
+ "name": "hasListener",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Checks to see if this object has any listeners for a specified event</p>\n",
+ "linenr": 530,
+ "return": {
+ "type": "Boolean",
+ "doc": "<p>True if the event is being listened for, else false</p>\n"
+ },
+ "html_filename": "Observable.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
- "linenr": 211,
- "html_filename": "ElementLoader.html",
- "href": "ElementLoader.html#Ext-ElementLoader-method-load",
- "shortDoc": "<p>Load new data from the server.</p>\n"
- },
- {
- "tagname": "method",
- "name": "observe",
- "member": "Ext.util.Observable",
- "doc": "<p>Sets observability on the passed class constructor.</p>\n\n<p>This makes any event fired on any instance of the passed class also fire a single event through\nthe <strong>class</strong> allowing for central handling of events on many instances at once.</p>\n\n<p>Usage:</p>\n\n<pre><code>Ext.util.Observable.observe(Ext.data.Connection);\nExt.data.Connection.on('beforerequest', function(con, options) {\n console.log('Ajax request made to ' + options.url);\n});\n</code></pre>\n",
- "params": [
- {
- "type": "Function",
- "name": "c",
- "doc": "<p>The class constructor to make observable.</p>\n",
- "optional": false
+ {
+ "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": "listeners",
- "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.ElementLoader-method-addListener\" rel=\"Ext.ElementLoader-method-addListener\" class=\"docClass\">addListener</a>.</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ "doc": "<p>mixins The mixin prototypes as key - value pairs</p>\n"
+ },
+ "html_filename": "Base3.html"
},
- "private": false,
- "static": true,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 69,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-observe",
- "shortDoc": "Sets observability on the passed class constructor.\n\nThis makes any event fired on any instance of the passed class a..."
- },
- {
- "tagname": "method",
- "name": "on",
- "member": "Ext.util.Observable",
- "doc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.ElementLoader-method-addListener\" rel=\"Ext.ElementLoader-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n",
- "params": [
- {
- "type": "String",
- "name": "eventName",
- "doc": "<p>The type of event to listen for</p>\n",
- "optional": false
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "ElementLoader.html#Ext-ElementLoader-method-isAutoRefreshing",
+ "shortDoc": "Checks whether the loader is automatically refreshing. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ElementLoader.js",
+ "private": false,
+ "params": [
+
+ ],
+ "name": "isAutoRefreshing",
+ "owner": "Ext.ElementLoader",
+ "doc": "<p>Checks whether the loader is automatically refreshing. See <a href=\"#/api/Ext.ElementLoader-method-startAutoRefresh\" rel=\"Ext.ElementLoader-method-startAutoRefresh\" class=\"docClass\">startAutoRefresh</a>.</p>\n",
+ "linenr": 356,
+ "return": {
+ "type": "Boolean",
+ "doc": "<p>True if the loader is automatically refreshing</p>\n"
},
- {
- "type": "Function",
- "name": "handler",
- "doc": "<p>The method the event invokes</p>\n",
- "optional": false
+ "html_filename": "ElementLoader.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "ElementLoader.html#Ext-ElementLoader-method-load",
+ "shortDoc": "Load new data from the server. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ElementLoader.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "<p>The options for the request. They can be any configuration option that can be specified for\nthe class, with the exception of the target option. Note that any options passed to the method will override any\nclass defaults.</p>\n",
+ "name": "options"
+ }
+ ],
+ "name": "load",
+ "owner": "Ext.ElementLoader",
+ "doc": "<p>Load new data from the server.</p>\n",
+ "linenr": 211,
+ "return": {
+ "type": "void",
+ "doc": "\n"
},
- {
- "type": "Object",
- "name": "scope",
- "doc": "<p>(optional) The scope (<code><b>this</b></code> reference) in which the handler function is executed.\n<b>If omitted, defaults to the object which fired the event.</b></p>\n",
- "optional": true
+ "html_filename": "ElementLoader.html"
+ },
+ {
+ "deprecated": null,
+ "alias": {
+ "tagname": "alias",
+ "cls": "Ext.util.Observable",
+ "doc": null,
+ "owner": "addManagedListener"
},
- {
- "type": "Object",
- "name": "options",
- "doc": "<p>(optional) An object containing handler configuration.</p>\n",
- "optional": true
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-mon",
+ "shortDoc": "Shorthand for addManagedListener. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Observable/Element",
+ "optional": false,
+ "doc": "<p>The item to which to add a listener/listeners.</p>\n",
+ "name": "item"
+ },
+ {
+ "type": "Object/String",
+ "optional": false,
+ "doc": "<p>The event name, or an object containing event name properties.</p>\n",
+ "name": "ename"
+ },
+ {
+ "type": "Function",
+ "optional": true,
+ "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the handler function.</p>\n",
+ "name": "fn"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the scope (<code>this</code> reference)\nin which the handler function is executed.</p>\n",
+ "name": "scope"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) If the <code>ename</code> parameter was an event name, this is the\n<a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">addListener</a> options.</p>\n",
+ "name": "opt"
+ }
+ ],
+ "name": "mon",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Shorthand for <a href=\"#/api/Ext.ElementLoader-method-addManagedListener\" rel=\"Ext.ElementLoader-method-addManagedListener\" class=\"docClass\">addManagedListener</a>.</p>\n\n<p>Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed.</p>\n",
+ "linenr": 681,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Observable.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 616,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-on",
- "shortDoc": "<p>Appends an event handler to this object (shorthand for <a href=\"#/api/Ext.ElementLoader-method-addListener\" rel=\"Ext.ElementLoader-method-addListener\" class=\"docClass\">addListener</a>.)</p>\n"
- },
- {
- "tagname": "method",
- "name": "relayEvents",
- "member": "Ext.util.Observable",
- "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n",
- "params": [
- {
- "type": "Object",
- "name": "origin",
- "doc": "<p>The Observable whose events this object is to relay.</p>\n",
- "optional": false
+ {
+ "deprecated": null,
+ "alias": {
+ "tagname": "alias",
+ "cls": "Ext.util.Observable",
+ "doc": null,
+ "owner": "removeManagedListener"
},
- {
- "type": "Array",
- "name": "events",
- "doc": "<p>Array of event names to relay.</p>\n",
- "optional": false
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-mun",
+ "shortDoc": "Shorthand for removeManagedListener. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Observable|Element",
+ "optional": false,
+ "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
+ "name": "item"
+ },
+ {
+ "type": "Object|String",
+ "optional": false,
+ "doc": "<p>The event name, or an object containing event name properties.</p>\n",
+ "name": "ename"
+ },
+ {
+ "type": "Function",
+ "optional": false,
+ "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this is the handler function.</p>\n",
+ "name": "fn"
+ },
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this is the scope (<code>this</code> reference)\nin which the handler function is executed.</p>\n",
+ "name": "scope"
+ }
+ ],
+ "name": "mun",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Shorthand for <a href=\"#/api/Ext.ElementLoader-method-removeManagedListener\" rel=\"Ext.ElementLoader-method-removeManagedListener\" class=\"docClass\">removeManagedListener</a>.</p>\n\n<p>Removes listeners that were added by the <a href=\"#/api/Ext.ElementLoader-method-mon\" rel=\"Ext.ElementLoader-method-mon\" class=\"docClass\">mon</a> method.</p>\n",
+ "linenr": 687,
+ "return": {
+ "type": "void",
+ "doc": "\n"
},
- {
- "type": "Object",
- "name": "prefix",
- "doc": "\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ "html_filename": "Observable.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 520,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-relayEvents",
- "shortDoc": "<p>Relays selected events from the specified Observable as if the events were fired by <code><b>this</b></code>.</p>\n"
- },
- {
- "tagname": "method",
- "name": "releaseCapture",
- "member": "Ext.util.Observable",
- "doc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n",
- "params": [
- {
- "type": "Observable",
- "name": "o",
- "doc": "<p>The Observable to release</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-observe",
+ "shortDoc": "Sets observability on the passed class constructor. ...",
+ "static": true,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Function",
+ "optional": false,
+ "doc": "<p>The class constructor to make observable.</p>\n",
+ "name": "c"
+ },
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.ElementLoader-method-addListener\" rel=\"Ext.ElementLoader-method-addListener\" class=\"docClass\">addListener</a>.</p>\n",
+ "name": "listeners"
+ }
+ ],
+ "name": "observe",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Sets observability on the passed class constructor.</p>\n\n<p>This makes any event fired on any instance of the passed class also fire a single event through\nthe <strong>class</strong> allowing for central handling of events on many instances at once.</p>\n\n<p>Usage:</p>\n\n<pre><code>Ext.util.Observable.observe(Ext.data.Connection);\nExt.data.Connection.on('beforerequest', function(con, options) {\n console.log('Ajax request made to ' + options.url);\n});\n</code></pre>\n",
+ "linenr": 69,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Observable.html"
},
- "private": false,
- "static": true,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 46,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
- "shortDoc": "<p>Removes <b>all</b> added captures from the Observable.</p>\n"
- },
- {
- "tagname": "method",
- "name": "removeListener",
- "member": "Ext.util.Observable",
- "doc": "<p>Removes an event handler.</p>\n",
- "params": [
- {
- "type": "String",
- "name": "eventName",
- "doc": "<p>The type of event the handler was associated with.</p>\n",
- "optional": false
+ {
+ "deprecated": null,
+ "alias": {
+ "tagname": "alias",
+ "cls": "Ext.util.Observable",
+ "doc": null,
+ "owner": "addListener"
},
- {
- "type": "Function",
- "name": "handler",
- "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.ElementLoader-method-addListener\" rel=\"Ext.ElementLoader-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
- "optional": false
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-on",
+ "shortDoc": "Shorthand for addListener. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "String",
+ "optional": false,
+ "doc": "<p>The name of the event to listen for. May also be an object who's property names are\nevent names.</p>\n",
+ "name": "eventName"
+ },
+ {
+ "type": "Function",
+ "optional": false,
+ "doc": "<p>The method the event invokes. Will be called with arguments given to\n<a href=\"#/api/Ext.ElementLoader-method-fireEvent\" rel=\"Ext.ElementLoader-method-fireEvent\" class=\"docClass\">fireEvent</a> plus the <code>options</code> parameter described below.</p>\n",
+ "name": "handler"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) The scope (<code>this</code> reference) in which the handler function is executed. <strong>If\nomitted, defaults to the object which fired the event.</strong></p>\n",
+ "name": "scope"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) An object containing handler configuration.</p>\n\n<p><strong>Note:</strong> Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.</p>\n\n<p>This object may contain any of the following properties:</p>\n\n<ul>\n<li><p><strong>scope</strong> : Object</p>\n\n<p>The scope (<code>this</code> reference) in which the handler function is executed. <strong>If omitted, defaults to the object\nwhich fired the event.</strong></p></li>\n<li><p><strong>delay</strong> : Number</p>\n\n<p>The number of milliseconds to delay the invocation of the handler after the event fires.</p></li>\n<li><p><strong>single</strong> : Boolean</p>\n\n<p>True to add a handler to handle just the next firing of the event, and then remove itself.</p></li>\n<li><p><strong>buffer</strong> : Number</p>\n\n<p>Causes the handler to be scheduled to run in an <a href=\"#/api/Ext.util.DelayedTask\" rel=\"Ext.util.DelayedTask\" class=\"docClass\">Ext.util.DelayedTask</a> delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is <em>not</em> invoked, but the new\nhandler is scheduled in its place.</p></li>\n<li><p><strong>target</strong> : Observable</p>\n\n<p>Only call the handler if the event was fired on the target Observable, <em>not</em> if the event was bubbled up from a\nchild Observable.</p></li>\n<li><p><strong>element</strong> : String</p>\n\n<p><strong>This option is only valid for listeners bound to <a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a>.</strong> The name of a Component\nproperty which references an element to add a listener to.</p>\n\n<p>This option is useful during Component construction to add DOM event listeners to elements of\n<a href=\"#/api/Ext.Component\" rel=\"Ext.Component\" class=\"docClass\">Components</a> which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:</p>\n\n<pre><code>new Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n</code></pre></li>\n</ul>\n\n\n<p><strong>Combining Options</strong></p>\n\n<p>Using the options argument, it is possible to combine different types of listeners:</p>\n\n<p>A delayed, one-time listener.</p>\n\n<pre><code>myPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\n</code></pre>\n\n<p><strong>Attaching multiple handlers in 1 call</strong></p>\n\n<p>The method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:</p>\n\n<pre><code>myGridPanel.on({\n cellClick: this.onCellClick,\n mouseover: this.onMouseOver,\n mouseout: this.onMouseOut,\n scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n</code></pre>\n\n<p>One can also specify options for each event handler separately:</p>\n\n<pre><code>myGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n</code></pre>\n",
+ "name": "options"
+ }
+ ],
+ "name": "on",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Shorthand for <a href=\"#/api/Ext.ElementLoader-method-addListener\" rel=\"Ext.ElementLoader-method-addListener\" class=\"docClass\">addListener</a>.</p>\n\n<p>Appends an event handler to this object.</p>\n",
+ "linenr": 669,
+ "return": {
+ "type": "void",
+ "doc": "\n"
},
- {
- "type": "Object",
- "name": "scope",
- "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
- "optional": true
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ "html_filename": "Observable.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 352,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-removeListener",
- "shortDoc": "<p>Removes an event handler.</p>\n"
- },
- {
- "tagname": "method",
- "name": "removeManagedListener",
- "member": "Ext.util.Observable",
- "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.ElementLoader--mon\" rel=\"Ext.ElementLoader--mon\" class=\"docClass\">mon</a> method.</p>\n",
- "params": [
- {
- "type": "Observable|Element",
- "name": "item",
- "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
- "optional": false
- },
- {
- "type": "Object|String",
- "name": "ename",
- "doc": "<p>The event name, or an object containing event name properties.</p>\n",
- "optional": false
+ {
+ "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"
},
- {
- "type": "Function",
- "name": "fn",
- "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the handler function.</p>\n",
- "optional": false
+ "html_filename": "Base3.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-relayEvents",
+ "shortDoc": "Relays selected events from the specified Observable as if the events were fired by this. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "<p>The Observable whose events this object is to relay.</p>\n",
+ "name": "origin"
+ },
+ {
+ "type": "[String]",
+ "optional": false,
+ "doc": "<p>Array of event names to relay.</p>\n",
+ "name": "events"
+ },
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "\n",
+ "name": "prefix"
+ }
+ ],
+ "name": "relayEvents",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Relays selected events from the specified Observable as if the events were fired by <code>this</code>.</p>\n",
+ "linenr": 573,
+ "return": {
+ "type": "void",
+ "doc": "\n"
},
- {
- "type": "Object",
- "name": "scope",
- "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this\nis the scope (<code>this</code> reference) in which the handler function is executed.</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ "html_filename": "Observable.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 196,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
- "shortDoc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.ElementLoader--mon\" rel=\"Ext.ElementLoader--mon\" class=\"docClass\">mon</a> method.</p>\n"
- },
- {
- "tagname": "method",
- "name": "resumeEvents",
- "member": "Ext.util.Observable",
- "doc": "<p>Resume firing events. (see <a href=\"#/api/Ext.ElementLoader-method-suspendEvents\" rel=\"Ext.ElementLoader-method-suspendEvents\" class=\"docClass\">suspendEvents</a>)\nIf events were suspended using the <code><b>queueSuspended</b></code> parameter, then all\nevents fired during event suspension will be sent to any listeners now.</p>\n",
- "params": [
-
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-releaseCapture",
+ "shortDoc": "Removes all added captures from the Observable. ...",
+ "static": true,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Observable",
+ "optional": false,
+ "doc": "<p>The Observable to release</p>\n",
+ "name": "o"
+ }
+ ],
+ "name": "releaseCapture",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Removes <strong>all</strong> added captures from the Observable.</p>\n",
+ "linenr": 44,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Observable.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 502,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
- "shortDoc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevent..."
- },
- {
- "tagname": "method",
- "name": "setTarget",
- "member": "Ext.ElementLoader",
- "doc": "<p>Set an {Ext.Element} as the target of this loader. Note that if the target is changed,\nany active requests will be aborted.</p>\n",
- "params": [
- {
- "type": "Mixed",
- "name": "target",
- "doc": "<p>The element</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-removeListener",
+ "shortDoc": "Removes an event handler. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "String",
+ "optional": false,
+ "doc": "<p>The type of event the handler was associated with.</p>\n",
+ "name": "eventName"
+ },
+ {
+ "type": "Function",
+ "optional": false,
+ "doc": "<p>The handler to remove. <strong>This must be a reference to the function passed into the\n<a href=\"#/api/Ext.ElementLoader-method-addListener\" rel=\"Ext.ElementLoader-method-addListener\" class=\"docClass\">addListener</a> call.</strong></p>\n",
+ "name": "handler"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
+ "name": "scope"
+ }
+ ],
+ "name": "removeListener",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Removes an event handler.</p>\n",
+ "linenr": 392,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Observable.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
- "linenr": 158,
- "html_filename": "ElementLoader.html",
- "href": "ElementLoader.html#Ext-ElementLoader-method-setTarget",
- "shortDoc": "Set an {Ext.Element} as the target of this loader. Note that if the target is changed,\nany active requests will be ab..."
- },
- {
- "tagname": "method",
- "name": "startAutoRefresh",
- "member": "Ext.ElementLoader",
- "doc": "<p>Automatically refreshes the content over a specified period.</p>\n",
- "params": [
- {
- "type": "Number",
- "name": "interval",
- "doc": "<p>The interval to refresh in ms.</p>\n",
- "optional": false
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-removeManagedListener",
+ "shortDoc": "Removes listeners that were added by the mon method. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Observable|Element",
+ "optional": false,
+ "doc": "<p>The item from which to remove a listener/listeners.</p>\n",
+ "name": "item"
+ },
+ {
+ "type": "Object|String",
+ "optional": false,
+ "doc": "<p>The event name, or an object containing event name properties.</p>\n",
+ "name": "ename"
+ },
+ {
+ "type": "Function",
+ "optional": false,
+ "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this is the handler function.</p>\n",
+ "name": "fn"
+ },
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "<p>Optional. If the <code>ename</code> parameter was an event name, this is the scope (<code>this</code> reference)\nin which the handler function is executed.</p>\n",
+ "name": "scope"
+ }
+ ],
+ "name": "removeManagedListener",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Removes listeners that were added by the <a href=\"#/api/Ext.ElementLoader-method-mon\" rel=\"Ext.ElementLoader-method-mon\" class=\"docClass\">mon</a> method.</p>\n",
+ "linenr": 197,
+ "return": {
+ "type": "void",
+ "doc": "\n"
},
- {
- "type": "Object",
- "name": "options",
- "doc": "<p>(optional) The options to pass to the load method. See <a href=\"#/api/Ext.ElementLoader-method-load\" rel=\"Ext.ElementLoader-method-load\" class=\"docClass\">load</a></p>\n",
- "optional": true
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ "html_filename": "Observable.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
- "linenr": 335,
- "html_filename": "ElementLoader.html",
- "href": "ElementLoader.html#Ext-ElementLoader-method-startAutoRefresh",
- "shortDoc": "<p>Automatically refreshes the content over a specified period.</p>\n"
- },
- {
- "tagname": "method",
- "name": "stopAutoRefresh",
- "member": "Ext.ElementLoader",
- "doc": "<p>Clears any auto refresh. See <a href=\"#/api/Ext.ElementLoader-method-startAutoRefresh\" rel=\"Ext.ElementLoader-method-startAutoRefresh\" class=\"docClass\">startAutoRefresh</a>.</p>\n",
- "params": [
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-resumeEvents",
+ "shortDoc": "Resumes firing events (see suspendEvents). ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ ],
+ "name": "resumeEvents",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Resumes firing events (see <a href=\"#/api/Ext.ElementLoader-method-suspendEvents\" rel=\"Ext.ElementLoader-method-suspendEvents\" class=\"docClass\">suspendEvents</a>).</p>\n\n<p>If events were suspended using the <code>**queueSuspended**</code> parameter, then all events fired\nduring event suspension will be sent to any listeners now.</p>\n",
+ "linenr": 554,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Observable.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
- "linenr": 348,
- "html_filename": "ElementLoader.html",
- "href": "ElementLoader.html#Ext-ElementLoader-method-stopAutoRefresh",
- "shortDoc": "<p>Clears any auto refresh. See <a href=\"#/api/Ext.ElementLoader-method-startAutoRefresh\" rel=\"Ext.ElementLoader-method-startAutoRefresh\" class=\"docClass\">startAutoRefresh</a>.</p>\n"
- },
- {
- "tagname": "method",
- "name": "suspendEvents",
- "member": "Ext.util.Observable",
- "doc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.ElementLoader-method-resumeEvents\" rel=\"Ext.ElementLoader-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n",
- "params": [
- {
- "type": "Boolean",
- "name": "queueSuspended",
- "doc": "<p>Pass as true to queue up suspended events to be fired\nafter the <a href=\"#/api/Ext.ElementLoader-method-resumeEvents\" rel=\"Ext.ElementLoader-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events;</p>\n",
- "optional": false
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "ElementLoader.html#Ext-ElementLoader-method-setTarget",
+ "shortDoc": "Set an {Ext.Element} as the target of this loader. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ElementLoader.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Mixed",
+ "optional": false,
+ "doc": "<p>The element</p>\n",
+ "name": "target"
+ }
+ ],
+ "name": "setTarget",
+ "owner": "Ext.ElementLoader",
+ "doc": "<p>Set an {Ext.Element} as the target of this loader. Note that if the target is changed,\nany active requests will be aborted.</p>\n",
+ "linenr": 158,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "ElementLoader.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 490,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
- "shortDoc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.ElementLoader-method-resumeEvents\" rel=\"Ext.ElementLoader-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n"
- },
- {
- "tagname": "method",
- "name": "un",
- "member": "Ext.util.Observable",
- "doc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.ElementLoader-method-removeListener\" rel=\"Ext.ElementLoader-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n",
- "params": [
- {
- "type": "String",
- "name": "eventName",
- "doc": "<p>The type of event the handler was associated with.</p>\n",
- "optional": false
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "ElementLoader.html#Ext-ElementLoader-method-startAutoRefresh",
+ "shortDoc": "Automatically refreshes the content over a specified period. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ElementLoader.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Number",
+ "optional": false,
+ "doc": "<p>The interval to refresh in ms.</p>\n",
+ "name": "interval"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) The options to pass to the load method. See <a href=\"#/api/Ext.ElementLoader-method-load\" rel=\"Ext.ElementLoader-method-load\" class=\"docClass\">load</a></p>\n",
+ "name": "options"
+ }
+ ],
+ "name": "startAutoRefresh",
+ "owner": "Ext.ElementLoader",
+ "doc": "<p>Automatically refreshes the content over a specified period.</p>\n",
+ "linenr": 335,
+ "return": {
+ "type": "void",
+ "doc": "\n"
},
- {
- "type": "Function",
- "name": "handler",
- "doc": "<p>The handler to remove. <b>This must be a reference to the function passed into the <a href=\"#/api/Ext.ElementLoader-method-addListener\" rel=\"Ext.ElementLoader-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
- "optional": false
+ "html_filename": "ElementLoader.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": [
+
+ ],
+ "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"
},
- {
- "type": "Object",
- "name": "scope",
- "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
- "optional": true
- }
- ],
- "return": {
- "type": "void",
- "doc": "\n"
+ "html_filename": "Base3.html"
},
- "private": false,
- "static": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Observable.js",
- "linenr": 608,
- "html_filename": "Observable.html",
- "href": "Observable.html#Ext-util-Observable-method-un",
- "shortDoc": "<p>Removes an event handler (shorthand for <a href=\"#/api/Ext.ElementLoader-method-removeListener\" rel=\"Ext.ElementLoader-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n"
- }
- ],
- "property": [
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "ElementLoader.html#Ext-ElementLoader-method-stopAutoRefresh",
+ "shortDoc": "Clears any auto refresh. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ElementLoader.js",
+ "private": false,
+ "params": [
- ],
- "event": [
- {
- "tagname": "event",
- "name": "beforeload",
- "member": "Ext.ElementLoader",
- "doc": "<p>Fires before a load request is made to the server.\nReturning false from an event listener can prevent the load\nfrom occurring.</p>\n",
- "params": [
- {
- "type": "Ext.ElementLoader",
- "name": "this",
- "doc": "\n",
- "optional": false
+ ],
+ "name": "stopAutoRefresh",
+ "owner": "Ext.ElementLoader",
+ "doc": "<p>Clears any auto refresh. See <a href=\"#/api/Ext.ElementLoader-method-startAutoRefresh\" rel=\"Ext.ElementLoader-method-startAutoRefresh\" class=\"docClass\">startAutoRefresh</a>.</p>\n",
+ "linenr": 348,
+ "return": {
+ "type": "void",
+ "doc": "\n"
},
- {
- "type": "Object",
- "name": "options",
- "doc": "<p>The options passed to the request</p>\n",
- "optional": false
- }
- ],
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
- "linenr": 117,
- "html_filename": "ElementLoader.html",
- "href": "ElementLoader.html#Ext-ElementLoader-event-beforeload",
- "shortDoc": "Fires before a load request is made to the server.\nReturning false from an event listener can prevent the load\nfrom o..."
- },
- {
- "tagname": "event",
- "name": "exception",
- "member": "Ext.ElementLoader",
- "doc": "<p>Fires after a successful load.</p>\n",
- "params": [
- {
- "type": "Ext.ElementLoader",
- "name": "this",
- "doc": "\n",
- "optional": false
+ "html_filename": "ElementLoader.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
+ "shortDoc": "Suspends the firing of all events. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Boolean",
+ "optional": false,
+ "doc": "<p>Pass as true to queue up suspended events to be fired\nafter the <a href=\"#/api/Ext.ElementLoader-method-resumeEvents\" rel=\"Ext.ElementLoader-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events.</p>\n",
+ "name": "queueSuspended"
+ }
+ ],
+ "name": "suspendEvents",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Suspends the firing of all events. (see <a href=\"#/api/Ext.ElementLoader-method-resumeEvents\" rel=\"Ext.ElementLoader-method-resumeEvents\" class=\"docClass\">resumeEvents</a>)</p>\n",
+ "linenr": 541,
+ "return": {
+ "type": "void",
+ "doc": "\n"
},
- {
- "type": "Object",
- "name": "response",
- "doc": "<p>The response from the server</p>\n",
- "optional": false
+ "html_filename": "Observable.html"
+ },
+ {
+ "deprecated": null,
+ "alias": {
+ "tagname": "alias",
+ "cls": "Ext.util.Observable",
+ "doc": null,
+ "owner": "removeListener"
},
- {
- "type": "Object",
- "name": "options",
- "doc": "<p>The options passed to the request</p>\n",
- "optional": false
- }
- ],
- "private": false,
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
- "linenr": 136,
- "html_filename": "ElementLoader.html",
- "href": "ElementLoader.html#Ext-ElementLoader-event-exception",
- "shortDoc": "<p>Fires after a successful load.</p>\n"
- }
- ],
- "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ElementLoader.js",
- "linenr": 1,
- "html_filename": "ElementLoader.html",
- "href": "ElementLoader.html#Ext-ElementLoader",
- "cssVar": [
+ "protected": false,
+ "tagname": "method",
+ "href": "Observable.html#Ext-util-Observable-method-un",
+ "shortDoc": "Shorthand for removeListener. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
+ "private": false,
+ "params": [
+ {
+ "type": "String",
+ "optional": false,
+ "doc": "<p>The type of event the handler was associated with.</p>\n",
+ "name": "eventName"
+ },
+ {
+ "type": "Function",
+ "optional": false,
+ "doc": "<p>The handler to remove. <strong>This must be a reference to the function passed into the\n<a href=\"#/api/Ext.ElementLoader-method-addListener\" rel=\"Ext.ElementLoader-method-addListener\" class=\"docClass\">addListener</a> call.</strong></p>\n",
+ "name": "handler"
+ },
+ {
+ "type": "Object",
+ "optional": true,
+ "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
+ "name": "scope"
+ }
+ ],
+ "name": "un",
+ "owner": "Ext.util.Observable",
+ "doc": "<p>Shorthand for <a href=\"#/api/Ext.ElementLoader-method-removeListener\" rel=\"Ext.ElementLoader-method-removeListener\" class=\"docClass\">removeListener</a>.</p>\n\n<p>Removes an event handler.</p>\n",
+ "linenr": 675,
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "html_filename": "Observable.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": [
- ],
- "cssMixin": [
+ ],
+ "cssMixin": [
- ],
- "component": false,
+ ],
+ "event": [
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "event",
+ "href": "ElementLoader.html#Ext-ElementLoader-event-beforeload",
+ "shortDoc": "Fires before a load request is made to the server. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ElementLoader.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Ext.ElementLoader",
+ "optional": false,
+ "doc": "\n",
+ "name": "this"
+ },
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "<p>The options passed to the request</p>\n",
+ "name": "options"
+ },
+ {
+ "type": "Object",
+ "tagname": "param",
+ "name": "options",
+ "doc": "<p>The options object passed to <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">Ext.util.Observable.addListener</a>.</p>\n"
+ }
+ ],
+ "name": "beforeload",
+ "owner": "Ext.ElementLoader",
+ "doc": "<p>Fires before a load request is made to the server.\nReturning false from an event listener can prevent the load\nfrom occurring.</p>\n",
+ "linenr": 117,
+ "html_filename": "ElementLoader.html"
+ },
+ {
+ "deprecated": null,
+ "alias": null,
+ "protected": false,
+ "tagname": "event",
+ "href": "ElementLoader.html#Ext-ElementLoader-event-exception",
+ "shortDoc": "Fires after a successful load. ...",
+ "static": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ElementLoader.js",
+ "private": false,
+ "params": [
+ {
+ "type": "Ext.ElementLoader",
+ "optional": false,
+ "doc": "\n",
+ "name": "this"
+ },
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "<p>The response from the server</p>\n",
+ "name": "response"
+ },
+ {
+ "type": "Object",
+ "optional": false,
+ "doc": "<p>The options passed to the request</p>\n",
+ "name": "options"
+ },
+ {
+ "type": "Object",
+ "tagname": "param",
+ "name": "options",
+ "doc": "<p>The options object passed to <a href=\"#/api/Ext.util.Observable-method-addListener\" rel=\"Ext.util.Observable-method-addListener\" class=\"docClass\">Ext.util.Observable.addListener</a>.</p>\n"
+ }
+ ],
+ "name": "exception",
+ "owner": "Ext.ElementLoader",
+ "doc": "<p>Fires after a successful load.</p>\n",
+ "linenr": 136,
+ "html_filename": "ElementLoader.html"
+ }
+ ]
+ },
+ "singleton": false,
+ "alias": null,
"superclasses": [
-
+ "Ext.Base"
+ ],
+ "protected": false,
+ "tagname": "class",
+ "mixins": [
+ "Ext.util.Observable"
],
+ "href": "ElementLoader.html#Ext-ElementLoader",
"subclasses": [
"Ext.ComponentLoader"
],
+ "static": false,
+ "author": null,
+ "component": false,
+ "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ElementLoader.js",
+ "private": false,
+ "alternateClassNames": [
+
+ ],
+ "name": "Ext.ElementLoader",
+ "doc": "<p>A class used to load remote content to an Element. Sample usage:</p>\n\n<pre><code>Ext.get('el').load({\n url: 'myPage.php',\n scripts: true,\n params: {\n id: 1\n }\n});\n</code></pre>\n\n\n<p>\nIn general this class will not be instanced directly, rather the <a href=\"#/api/Ext.core.Element-event-load\" rel=\"Ext.core.Element-event-load\" class=\"docClass\">Ext.core.Element.load</a> method\nwill be used.\n</p>\n\n",
"mixedInto": [
],
- "allMixins": [
- "Ext.util.Observable"
- ]
+ "linenr": 1,
+ "xtypes": [
+
+ ],
+ "html_filename": "ElementLoader.html",
+ "extends": "Ext.Base"
});
\ No newline at end of file
git.ithinksw.org / extjs.git / blobdiff