This class is used to load content via Ajax into a Ext.Component. In general\nthis class will not be instanced directly, rather a loader configuration will be passed to the\nconstructor of the Ext.Component.
\n\nBy default, the content loaded will be processed as raw html. The response text\nfrom the request is taken and added to the component. This can be used in\nconjunction with the scripts option to execute any inline scripts in\nthe resulting content. Using this renderer has the same effect as passing the\nExt.Component.html configuration option.
\n\nThis renderer allows content to be added by using JSON data and a Ext.XTemplate.\nThe content received from the response is passed to the Ext.Component.update method.\nThis content is run through the attached Ext.Component.tpl and the data is added to\nthe Component. Using this renderer has the same effect as using the Ext.Component.data\nconfiguration in conjunction with a Ext.Component.tpl.
\n\nThis renderer can only be used with a Ext.Container and subclasses. It allows for\nComponents to be loaded remotely into a Container. The response is expected to be a single/series of\nExt.Component configuration objects. When the response is received, the data is decoded\nand then passed to Ext.Container.add. Using this renderer has the same effect as specifying\nthe Ext.Container.items configuration on a Container.
\n\nA custom function can be passed to handle any other special case, see the renderer option.
\n\nnew Ext.Component({\n tpl: '{firstName} - {lastName}',\n loader: {\n url: 'myPage.php',\n renderer: 'data',\n params: {\n userId: 1\n }\n }\n});\nAny additional options to be passed to the request, for example timeout or headers. Defaults to null.
\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": "True to have the loader make a request as soon as it is created. Defaults to false.\nThis argument can also be a set of options that will be passed to load is called.
\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": "Params that will be attached to every request. These parameters\nwill not be overridden by any params in the load options. Defaults to null.
\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": "A function to be called when a load request fails.
\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": "(optional)
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\naddListener example for attaching multiple handlers at once.
\n\nDOM events from ExtJs Components
\n\n\nWhile some ExtJs Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this\n\n\n
is usually only done when extra value can be added. For example the DataView's\nclick event passing the node clicked on. To access DOM\nevents directly from a child element of a Component, we need to specify the element option to\nidentify the Component property to add a DOM listener to:
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});\nTrue or a Ext.LoadMask configuration to enable masking during loading. Defaults to false.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ComponentLoader.js", - "linenr": 102, - "html_filename": "ComponentLoader.html", - "href": "ComponentLoader.html#Ext-ComponentLoader-cfg-loadMask" - }, - { - "tagname": "cfg", - "name": "params", - "member": "Ext.ElementLoader", - "type": "Object", - "doc": "Any params to be attached to the Ajax request. These parameters will\nbe overridden by any params in the load options. Defaults to null.
\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.ComponentLoader", - "type": "String/Function", - "doc": "The type of content that is to be loaded into, which can be one of 3 types:
\n\nDefaults to html.
Alternatively, you can pass a function which is called with the following parameters.
\n\nThe function must return false is loading is not successful. Below is a sample of using a custom renderer:
\n\nnew Ext.Component({\n loader: {\n url: 'myPage.php',\n renderer: function(loader, response, active) {\n var text = response.responseText;\n loader.getTarget().update('The response is ' + text);\n return true;\n }\n }\n});\nThe scope to execute the success and failure functions in.
\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.ComponentLoader", - "type": "Boolean", - "doc": "True to parse any inline script tags in the response. This only used when using the html\nrenderer.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ComponentLoader.js", - "linenr": 107, - "html_filename": "ComponentLoader.html", - "href": "ComponentLoader.html#Ext-ComponentLoader-cfg-scripts" - }, - { - "tagname": "cfg", - "name": "success", - "member": "Ext.ElementLoader", - "type": "Function", - "doc": "A function to be called when a load request is successful.
\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.ComponentLoader", - "type": "Ext.Component/String", - "doc": "The target Ext.Component for the loader. Defaults to null.\nIf a string is passed it will be looked up via the id.
\n", - "private": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ComponentLoader.js", - "linenr": 96, - "html_filename": "ComponentLoader.html", - "href": "ComponentLoader.html#Ext-ComponentLoader-cfg-target" - }, - { - "tagname": "cfg", - "name": "url", - "member": "Ext.ElementLoader", - "type": "String", - "doc": "The url to retrieve the content from. Defaults to null.
\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": "Aborts the active load request
\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": "Any additional options to be passed to the request, for example timeout or headers. Defaults to null.
\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": "Aborts the active load request
\n" - }, - { - "tagname": "method", - "name": "addEvents", - "member": "Ext.util.Observable", - "doc": "Adds the specified events to the list of events which this Observable may fire.
\n", - "params": [ - { - "type": "Object/String", - "name": "o", - "doc": "Either an object with event names as properties with a value of true\nor the first event name string if multiple event names are being passed as separate parameters.
[additional] Optional additional event names if multiple event names are being passed as separate parameters.\nUsage:
\n\nthis.addEvents('storeloaded', 'storecleared');\nTrue to have the loader make a request as soon as it is created. Defaults to false.\nThis argument can also be a set of options that will be passed to load is called.
\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": "Adds the specified events to the list of events which this Observable may fire.
\n" - }, - { - "tagname": "method", - "name": "addListener", - "member": "Ext.util.Observable", - "doc": "Appends an event handler to this object.
\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "The name of the event to listen for. May also be an object who's property names are event names. See
\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": "Params that will be attached to every request. These parameters\nwill not be overridden by any params in the load options. Defaults to null.
\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": "A function to be called when a load request fails.
\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": "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 addListener example for attaching multiple\nhandlers at once.
\n\nDOM events from ExtJS Components
\n\nWhile some 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 DataView's itemclick event passing the node clicked on. To access DOM events directly from a\nchild element of a Component, we need to specify the element option to identify the Component property to add a\nDOM listener to:
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});\nTrue or a Ext.LoadMask configuration to enable masking during loading. Defaults to false.
\n", + "linenr": 102, + "html_filename": "ComponentLoader.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": "Any params to be attached to the Ajax request. These parameters will\nbe overridden by any params in the load options. Defaults to null.
\n", + "linenr": 47, + "html_filename": "ElementLoader.html" + }, + { + "type": "String/Function", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "ComponentLoader.html#Ext-ComponentLoader-cfg-renderer", + "shortDoc": "The type of content that is to be loaded into, which can be one of 3 types:\n\n\nhtml : Loads raw html content, see Ext....", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ComponentLoader.js", + "private": false, + "name": "renderer", + "owner": "Ext.ComponentLoader", + "doc": "The type of content that is to be loaded into, which can be one of 3 types:
\n\nDefaults to html.
Alternatively, you can pass a function which is called with the following parameters.
\n\nThe function must return false is loading is not successful. Below is a sample of using a custom renderer:
\n\nnew Ext.Component({\n loader: {\n url: 'myPage.php',\n renderer: function(loader, response, active) {\n var text = response.responseText;\n loader.getTarget().update('The response is ' + text);\n return true;\n }\n }\n});\nThe scope to execute the success and failure functions in.
\n", + "linenr": 93, + "html_filename": "ElementLoader.html" + }, + { + "type": "Boolean", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "ComponentLoader.html#Ext-ComponentLoader-cfg-scripts", + "shortDoc": "True to parse any inline script tags in the response. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ComponentLoader.js", + "private": false, + "name": "scripts", + "owner": "Ext.ComponentLoader", + "doc": "True to parse any inline script tags in the response. This only used when using the html\nrenderer.
\n", + "linenr": 107, + "html_filename": "ComponentLoader.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": "A function to be called when a load request is successful.
\n", + "linenr": 85, + "html_filename": "ElementLoader.html" + }, + { + "type": "Ext.Component/String", + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "cfg", + "href": "ComponentLoader.html#Ext-ComponentLoader-cfg-target", + "shortDoc": "The target Ext.Component for the loader. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ComponentLoader.js", + "private": false, + "name": "target", + "owner": "Ext.ComponentLoader", + "doc": "The target Ext.Component for the loader. Defaults to null.\nIf a string is passed it will be looked up via the id.
\n", + "linenr": 96, + "html_filename": "ComponentLoader.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": "The url to retrieve the content from. Defaults to null.
\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": "Aborts the active load request
\n", + "linenr": 180, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Function", - "name": "handler", - "doc": "The method the event invokes.
\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": "Either an object with event names as properties with a value of true or the first\nevent name string if multiple event names are being passed as separate parameters. Usage:
this.addEvents({\n storeloaded: true,\n storecleared: true\n});\nOptional additional event names if multiple event names are being passed as separate\nparameters. Usage:
\n\nthis.addEvents('storeloaded', 'storecleared');\nAdds the specified events to the list of events which this Observable may fire.
\n", + "linenr": 494, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "scope", - "doc": "(optional) The scope (this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.
The name of the event to listen for. May also be an object who's property names are\nevent names.
\n", + "name": "eventName" + }, + { + "type": "Function", + "optional": false, + "doc": "The method the event invokes. Will be called with arguments given to\nfireEvent plus the options parameter described below.
(optional) The scope (this reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.
(optional) An object containing handler configuration.
\n\nNote: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.
\n\nThis object may contain any of the following properties:
\n\nscope : Object
\n\nThe scope (this reference) in which the handler function is executed. If omitted, defaults to the object\nwhich fired the event.
delay : Number
\n\nThe number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
\n\nTrue to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
\n\nCauses the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is not invoked, but the new\nhandler is scheduled in its place.
target : Observable
\n\nOnly call the handler if the event was fired on the target Observable, not if the event was bubbled up from a\nchild Observable.
element : String
\n\nThis option is only valid for listeners bound to Components. The name of a Component\nproperty which references an element to add a listener to.
\n\nThis option is useful during Component construction to add DOM event listeners to elements of\nComponents which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:
\n\nnew Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\nCombining Options
\n\nUsing the options argument, it is possible to combine different types of listeners:
\n\nA delayed, one-time listener.
\n\nmyPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\nAttaching multiple handlers in 1 call
\n\nThe method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:
\n\nmyGridPanel.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});\nOne can also specify options for each event handler separately:
\n\nmyGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\nAppends an event handler to this object.
\n", + "linenr": 278, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "options", - "doc": "(optional) An object containing handler configuration.\nproperties. This may contain any of the following properties:
this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.This option is useful during Component construction to add DOM event listeners to elements of Components which\nwill exist only after the Component is rendered. For example, to add a click listener to a Panel's body:\n
new Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\nWhen added in this way, the options available are the options applicable to Ext.core.Element.addListener
\n\n\n\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA delayed, one-time listener.\n
myPanel.on('hide', this.handleClick, this, {\nsingle: true,\ndelay: 100\n});\nAttaching multiple handlers in 1 call
\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
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\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": "
Appends an event handler to this object.
\n" - }, - { - "tagname": "method", - "name": "addManagedListener", - "member": "Ext.util.Observable", - "doc": "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": "
The item to which to add a listener/listeners.
\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": "The item to which to add a listener/listeners.
\n", + "name": "item" + }, + { + "type": "Object/String", + "optional": false, + "doc": "The event name, or an object containing event name properties.
\n", + "name": "ename" + }, + { + "type": "Function", + "optional": true, + "doc": "(optional) If the ename parameter was an event name, this is the handler function.
(optional) If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
(optional) If the ename parameter was an event name, this is the\naddListener options.
Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed.
\n", + "linenr": 156, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object/String", - "name": "ename", - "doc": "The event name, or an object containing event name properties.
\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": "Add / override static properties of this class.
\n\nExt.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});\nthis
\n" }, - { - "type": "Function", - "name": "fn", - "doc": "Optional. If the ename parameter was an event name, this\nis the handler function.
The arguments, either an array or the arguments object
Call the original method that was previously overridden with Ext.Base.override
\n\nExt.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\"\nReturns the result after calling the overridden method
\n" }, - { - "type": "Object", - "name": "scope", - "doc": "Optional. If the ename parameter was an event name, this\nis the scope (this reference) in which the handler function is executed.
The arguments, either an array or the arguments object\nfrom the current method, for example: this.callParent(arguments)
Call the parent's overridden method. For example:
\n\nExt.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'\nReturns the result from the superclass' method
\n" }, - { - "type": "Object", - "name": "opt", - "doc": "Optional. If the ename parameter was an event name, this\nis the addListener options.
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": "
Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.
\n", - "params": [ - { - "type": "Observable", - "name": "o", - "doc": "The Observable to capture events from.
\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": "The Observable to capture events from.
\n", + "name": "o" + }, + { + "type": "Function", + "optional": false, + "doc": "The function to call when an event is fired.
\n", + "name": "fn" + }, + { + "type": "Object", + "optional": true, + "doc": "(optional) The scope (this reference) in which the function is executed. Defaults to\nthe Observable firing the event.
Starts capture on the specified Observable. All events will be passed to the supplied function with the event\nname + standard signature of the event before the event is fired. If the supplied function returns false,\nthe event will not fire.
\n", + "linenr": 54, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Function", - "name": "fn", - "doc": "The function to call when an event is fired.
\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": "Removes all listeners for this object including the managed listeners
\n", + "linenr": 425, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "scope", - "doc": "(optional) The scope (this reference) in which the function is executed. Defaults to the Observable firing the event.
Removes all listeners for this object including the managed listeners
\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": "Removes all managed listeners for this object.
\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": "Removes all listeners for this object including the managed listeners
\n" - }, - { - "tagname": "method", - "name": "clearManagedListeners", - "member": "Ext.util.Observable", - "doc": "Removes all managed listeners for this object.
\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": "Create a new instance of this Class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.create({\n someConfig: true\n});\nAll parameters are passed to the constructor of the class.
\n", + "linenr": 329, + "return": { + "type": "Object", + "doc": "the created instance.
\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": "Removes all managed listeners for this object.
\n" - }, - { - "tagname": "method", - "name": "destroy", - "member": "Ext.ElementLoader", - "doc": "Destroys the loader. Any active requests will be aborted.
\n", - "params": [ + { + "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": "The new method name, or an object to set multiple aliases. See\nflexSetter
\n", + "name": "alias" + }, + { + "type": "String/Object", + "optional": false, + "doc": "The original method name
\n", + "name": "origin" + } + ], + "name": "createAlias", + "owner": "Ext.Base", + "doc": "Create aliases for existing prototype methods. Example:
\n\nExt.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()\nDestroys the loader. Any active requests will be aborted.
\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": "Destroys the loader. Any active requests will be aborted.
\n" - }, - { - "tagname": "method", - "name": "enableBubble", - "member": "Ext.util.Observable", - "doc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling\nthis.getBubbleTarget() if present. There is no implementation in the Observable base class.
This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default\nimplementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to\naccess the required target more quickly.
\n\n\nExample:
\n\n\nExt.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});\nThe event name to bubble, or an Array of event names.
\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": "The event name to bubble, or an Array of event names.
\n", + "name": "events" + } + ], + "name": "enableBubble", + "owner": "Ext.util.Observable", + "doc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if\npresent. There is no implementation in the Observable base class.
This is commonly used by Ext.Components to bubble events to owner Containers.\nSee Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the\nComponent's immediate owner. But if a known target is required, this can be overridden to access the\nrequired target more quickly.
\n\nExample:
\n\nExt.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});\nFires the specified event with the passed parameters (minus the event name).
\n\n\nAn event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget)\nby calling enableBubble.
\n\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "The name of the event to fire.
\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": "The name of the event to fire.
\n", + "name": "eventName" + }, + { + "type": "Object...", + "optional": false, + "doc": "Variable number of parameters are passed to handlers.
\n", + "name": "args" + } + ], + "name": "fireEvent", + "owner": "Ext.util.Observable", + "doc": "Fires the specified event with the passed parameters (minus the event name, plus the options object passed\nto addListener).
An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by\ncalling enableBubble.
\n", + "linenr": 233, + "return": { + "type": "Boolean", + "doc": "returns false if any of the handlers return false otherwise it returns true.
\n" }, - { - "type": "Object...", - "name": "args", - "doc": "Variable number of parameters are passed to handlers.
\n", - "optional": false - } - ], - "return": { - "type": "Boolean", - "doc": "returns false if any of the handlers return false otherwise it returns true.
\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": "Get the target of this loader.
\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": "target The target, null if none exists.
\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": "Get the target of this loader.
\n" - }, - { - "tagname": "method", - "name": "hasListener", - "member": "Ext.util.Observable", - "doc": "Checks to see if this object has any listeners for a specified event
\n", - "params": [ - { + ], + "name": "getName", + "owner": "Ext.Base", + "doc": "Get the current class' name in string format.
\n\nExt.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'\nThe name of the event to check for
\n", - "optional": false - } - ], - "return": { - "type": "Boolean", - "doc": "True if the event is being listened for, else false
\n" + "doc": "className
\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": "Checks to see if this object has any listeners for a specified event
\n" - }, - { - "tagname": "method", - "name": "isAutoRefreshing", - "member": "Ext.ElementLoader", - "doc": "Checks whether the loader is automatically refreshing. See startAutoRefresh.
\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": "True if the loader is automatically refreshing
\n" - }, - "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": "Checks whether the loader is automatically refreshing. See startAutoRefresh.
\n" - }, - { - "tagname": "method", - "name": "load", - "member": "Ext.ElementLoader", - "doc": "Load new data from the server.
\n", - "params": [ - { - "type": "Object", - "name": "options", - "doc": "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.
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" - }, - "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": "Load new data from the server.
\n" - }, - { - "tagname": "method", - "name": "observe", - "member": "Ext.util.Observable", - "doc": "Sets observability on the passed class constructor.
\n\nThis makes any event fired on any instance of the passed class also fire a single event through\nthe class allowing for central handling of events on many instances at once.
\n\nUsage:
\n\nExt.util.Observable.observe(Ext.data.Connection);\nExt.data.Connection.on('beforerequest', function(con, options) {\n console.log('Ajax request made to ' + options.url);\n});\nThe class constructor to make observable.
\n", - "optional": false + ], + "name": "getTarget", + "owner": "Ext.ElementLoader", + "doc": "Get the target of this loader.
\n", + "linenr": 172, + "return": { + "type": "Ext.Component", + "doc": "target The target, null if none exists.
\n" }, - { - "type": "Object", - "name": "listeners", - "doc": "An object containing a series of listeners to add. See addListener.
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + "html_filename": "ElementLoader.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": "Appends an event handler to this object (shorthand for addListener.)
\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "The type of event to listen for
\n", - "optional": false + { + "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": "The name of the event to check for
\n", + "name": "eventName" + } + ], + "name": "hasListener", + "owner": "Ext.util.Observable", + "doc": "Checks to see if this object has any listeners for a specified event
\n", + "linenr": 530, + "return": { + "type": "Boolean", + "doc": "True if the event is being listened for, else false
\n" }, - { - "type": "Function", - "name": "handler", - "doc": "The method the event invokes
\n", - "optional": false + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-implement", + "shortDoc": "Add methods / properties to the prototype of this class. ...", + "static": true, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "members" + } + ], + "name": "implement", + "owner": "Ext.Base", + "doc": "Add methods / properties to the prototype of this class.
\n\nExt.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();\nInitialize configuration for this class. a typical example:
\n\nExt.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(optional) The scope (this reference) in which the handler function is executed.\nIf omitted, defaults to the object which fired the event.
mixins The mixin prototypes as key - value pairs
\n" }, - { - "type": "Object", - "name": "options", - "doc": "(optional) An object containing handler configuration.
\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": 616, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-on", - "shortDoc": "Appends an event handler to this object (shorthand for addListener.)
\n" - }, - { - "tagname": "method", - "name": "relayEvents", - "member": "Ext.util.Observable", - "doc": "Relays selected events from the specified Observable as if the events were fired by this.
The Observable whose events this object is to relay.
\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": "Checks whether the loader is automatically refreshing. See startAutoRefresh.
\n", + "linenr": 356, + "return": { + "type": "Boolean", + "doc": "True if the loader is automatically refreshing
\n" }, - { - "type": "Array", - "name": "events", - "doc": "Array of event names to relay.
\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": "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.
\n", + "name": "options" + } + ], + "name": "load", + "owner": "Ext.ElementLoader", + "doc": "Load new data from the server.
\n", + "linenr": 211, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "prefix", - "doc": "\n", - "optional": false - } - ], - "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": 520, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-relayEvents", - "shortDoc": "Relays selected events from the specified Observable as if the events were fired by this.
Removes all added captures from the Observable.
\n", - "params": [ - { - "type": "Observable", - "name": "o", - "doc": "The Observable to release
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + { + "deprecated": null, + "alias": { + "tagname": "alias", + "cls": "Ext.util.Observable", + "doc": null, + "owner": "addManagedListener" + }, + "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": "The item to which to add a listener/listeners.
\n", + "name": "item" + }, + { + "type": "Object/String", + "optional": false, + "doc": "The event name, or an object containing event name properties.
\n", + "name": "ename" + }, + { + "type": "Function", + "optional": true, + "doc": "(optional) If the ename parameter was an event name, this is the handler function.
(optional) If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
(optional) If the ename parameter was an event name, this is the\naddListener options.
Shorthand for addManagedListener.
\n\nAdds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed.
\n", + "linenr": 681, + "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": "Removes all added captures from the Observable.
\n" - }, - { - "tagname": "method", - "name": "removeListener", - "member": "Ext.util.Observable", - "doc": "Removes an event handler.
\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "The type of event the handler was associated with.
\n", - "optional": false + { + "deprecated": null, + "alias": { + "tagname": "alias", + "cls": "Ext.util.Observable", + "doc": null, + "owner": "removeManagedListener" }, - { - "type": "Function", - "name": "handler", - "doc": "The handler to remove. This must be a reference to the function passed into the addListener call.
\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": "The item from which to remove a listener/listeners.
\n", + "name": "item" + }, + { + "type": "Object|String", + "optional": false, + "doc": "The event name, or an object containing event name properties.
\n", + "name": "ename" + }, + { + "type": "Function", + "optional": false, + "doc": "Optional. If the ename parameter was an event name, this is the handler function.
Optional. If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
Shorthand for removeManagedListener.
\n\nRemoves listeners that were added by the mon method.
\n", + "linenr": 687, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "scope", - "doc": "(optional) The scope originally specified for the handler.
\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": "Removes an event handler.
\n" - }, - { - "tagname": "method", - "name": "removeManagedListener", - "member": "Ext.util.Observable", - "doc": "Removes listeners that were added by the mon method.
\n", - "params": [ - { - "type": "Observable|Element", - "name": "item", - "doc": "The item from which to remove a listener/listeners.
\n", - "optional": false + { + "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": "The class constructor to make observable.
\n", + "name": "c" + }, + { + "type": "Object", + "optional": false, + "doc": "An object containing a series of listeners to add. See addListener.
\n", + "name": "listeners" + } + ], + "name": "observe", + "owner": "Ext.util.Observable", + "doc": "Sets observability on the passed class constructor.
\n\nThis makes any event fired on any instance of the passed class also fire a single event through\nthe class allowing for central handling of events on many instances at once.
\n\nUsage:
\n\nExt.util.Observable.observe(Ext.data.Connection);\nExt.data.Connection.on('beforerequest', function(con, options) {\n console.log('Ajax request made to ' + options.url);\n});\nThe event name, or an object containing event name properties.
\n", - "optional": false + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": { + "tagname": "alias", + "cls": "Ext.util.Observable", + "doc": null, + "owner": "addListener" }, - { - "type": "Function", - "name": "fn", - "doc": "Optional. If the ename parameter was an event name, this\nis the handler function.
The name of the event to listen for. May also be an object who's property names are\nevent names.
\n", + "name": "eventName" + }, + { + "type": "Function", + "optional": false, + "doc": "The method the event invokes. Will be called with arguments given to\nfireEvent plus the options parameter described below.
(optional) The scope (this reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.
(optional) An object containing handler configuration.
\n\nNote: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.
\n\nThis object may contain any of the following properties:
\n\nscope : Object
\n\nThe scope (this reference) in which the handler function is executed. If omitted, defaults to the object\nwhich fired the event.
delay : Number
\n\nThe number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
\n\nTrue to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
\n\nCauses the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is not invoked, but the new\nhandler is scheduled in its place.
target : Observable
\n\nOnly call the handler if the event was fired on the target Observable, not if the event was bubbled up from a\nchild Observable.
element : String
\n\nThis option is only valid for listeners bound to Components. The name of a Component\nproperty which references an element to add a listener to.
\n\nThis option is useful during Component construction to add DOM event listeners to elements of\nComponents which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:
\n\nnew Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\nCombining Options
\n\nUsing the options argument, it is possible to combine different types of listeners:
\n\nA delayed, one-time listener.
\n\nmyPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\nAttaching multiple handlers in 1 call
\n\nThe method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:
\n\nmyGridPanel.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});\nOne can also specify options for each event handler separately:
\n\nmyGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\nShorthand for addListener.
\n\nAppends an event handler to this object.
\n", + "linenr": 669, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "scope", - "doc": "Optional. If the ename parameter was an event name, this\nis the scope (this reference) in which the handler function is executed.
Removes listeners that were added by the mon method.
\n" - }, - { - "tagname": "method", - "name": "resumeEvents", - "member": "Ext.util.Observable", - "doc": "Resume firing events. (see suspendEvents)\nIf events were suspended using the queueSuspended parameter, then all\nevents fired during event suspension will be sent to any listeners now.
Override prototype members of this class. Overridden methods can be invoked via\nExt.Base.callOverridden
\n\nExt.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\"\nthis
\n" + }, + "html_filename": "Base3.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": "setOptions", - "member": "Ext.ComponentLoader", - "doc": "Get the target of this loader.
\n", - "params": [ - { - "type": "Object", - "name": "active", - "doc": "\n", - "optional": false + { + "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": "The Observable whose events this object is to relay.
\n", + "name": "origin" + }, + { + "type": "[String]", + "optional": false, + "doc": "Array of event names to relay.
\n", + "name": "events" + }, + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "prefix" + } + ], + "name": "relayEvents", + "owner": "Ext.util.Observable", + "doc": "Relays selected events from the specified Observable as if the events were fired by this.
target The target, null if none exists.
\n" + "html_filename": "Observable.html" + }, + { + "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": "The Observable to release
\n", + "name": "o" + } + ], + "name": "releaseCapture", + "owner": "Ext.util.Observable", + "doc": "Removes all added captures from the Observable.
\n", + "linenr": 44, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ComponentLoader.js", - "linenr": 178, - "html_filename": "ComponentLoader.html", - "href": "ComponentLoader.html#Ext-ComponentLoader-method-setOptions", - "shortDoc": "Get the target of this loader.
\n" - }, - { - "tagname": "method", - "name": "setTarget", - "member": "Ext.ComponentLoader", - "doc": "Set a {Ext.Component} as the target of this loader. Note that if the target is changed,\nany active requests will be aborted.
\n", - "params": [ - { - "type": "String/Ext.Component", - "name": "target", - "doc": "The component to be the target of this loader. If a string is passed\nit will be looked up via its id.
\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": "The type of event the handler was associated with.
\n", + "name": "eventName" + }, + { + "type": "Function", + "optional": false, + "doc": "The handler to remove. This must be a reference to the function passed into the\naddListener call.
\n", + "name": "handler" + }, + { + "type": "Object", + "optional": true, + "doc": "(optional) The scope originally specified for the handler.
\n", + "name": "scope" + } + ], + "name": "removeListener", + "owner": "Ext.util.Observable", + "doc": "Removes an event handler.
\n", + "linenr": 392, + "return": { + "type": "void", + "doc": "\n" + }, + "html_filename": "Observable.html" }, - "private": false, - "static": false, - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ComponentLoader.js", - "linenr": 145, - "html_filename": "ComponentLoader.html", - "href": "ComponentLoader.html#Ext-ComponentLoader-method-setTarget", - "shortDoc": "Set a {Ext.Component} as the target of this loader. Note that if the target is changed,\nany active requests will be a..." - }, - { - "tagname": "method", - "name": "startAutoRefresh", - "member": "Ext.ElementLoader", - "doc": "Automatically refreshes the content over a specified period.
\n", - "params": [ - { - "type": "Number", - "name": "interval", - "doc": "The interval to refresh in ms.
\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": "The item from which to remove a listener/listeners.
\n", + "name": "item" + }, + { + "type": "Object|String", + "optional": false, + "doc": "The event name, or an object containing event name properties.
\n", + "name": "ename" + }, + { + "type": "Function", + "optional": false, + "doc": "Optional. If the ename parameter was an event name, this is the handler function.
Optional. If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
Removes listeners that were added by the mon method.
\n", + "linenr": 197, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "options", - "doc": "(optional) The options to pass to the load method. See load
\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": "Automatically refreshes the content over a specified period.
\n" - }, - { - "tagname": "method", - "name": "stopAutoRefresh", - "member": "Ext.ElementLoader", - "doc": "Clears any auto refresh. See startAutoRefresh.
\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": "Resumes firing events (see suspendEvents).
\n\nIf events were suspended using the **queueSuspended** parameter, then all events fired\nduring event suspension will be sent to any listeners now.
Clears any auto refresh. See startAutoRefresh.
\n" - }, - { - "tagname": "method", - "name": "suspendEvents", - "member": "Ext.util.Observable", - "doc": "Suspend the firing of all events. (see resumeEvents)
\n", - "params": [ - { - "type": "Boolean", - "name": "queueSuspended", - "doc": "Pass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events;
\n", - "optional": false - } - ], - "return": { - "type": "void", - "doc": "\n" + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "ComponentLoader.html#Ext-ComponentLoader-method-setOptions", + "shortDoc": "Get the target of this loader. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ComponentLoader.js", + "private": false, + "params": [ + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "active" + }, + { + "type": "Object", + "optional": false, + "doc": "\n", + "name": "options" + } + ], + "name": "setOptions", + "owner": "Ext.ComponentLoader", + "doc": "Get the target of this loader.
\n", + "linenr": 178, + "return": { + "type": "Ext.Component", + "doc": "target The target, null if none exists.
\n" + }, + "html_filename": "ComponentLoader.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": "Suspend the firing of all events. (see resumeEvents)
\n" - }, - { - "tagname": "method", - "name": "un", - "member": "Ext.util.Observable", - "doc": "Removes an event handler (shorthand for removeListener.)
\n", - "params": [ - { - "type": "String", - "name": "eventName", - "doc": "The type of event the handler was associated with.
\n", - "optional": false + { + "deprecated": null, + "alias": null, + "protected": false, + "tagname": "method", + "href": "ComponentLoader.html#Ext-ComponentLoader-method-setTarget", + "shortDoc": "Set a {Ext.Component} as the target of this loader. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ComponentLoader.js", + "private": false, + "params": [ + { + "type": "String/Ext.Component", + "optional": false, + "doc": "The component to be the target of this loader. If a string is passed\nit will be looked up via its id.
\n", + "name": "target" + } + ], + "name": "setTarget", + "owner": "Ext.ComponentLoader", + "doc": "Set a {Ext.Component} as the target of this loader. Note that if the target is changed,\nany active requests will be aborted.
\n", + "linenr": 145, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Function", - "name": "handler", - "doc": "The handler to remove. This must be a reference to the function passed into the addListener call.
\n", - "optional": false + "html_filename": "ComponentLoader.html" + }, + { + "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": "The interval to refresh in ms.
\n", + "name": "interval" + }, + { + "type": "Object", + "optional": true, + "doc": "(optional) The options to pass to the load method. See load
\n", + "name": "options" + } + ], + "name": "startAutoRefresh", + "owner": "Ext.ElementLoader", + "doc": "Automatically refreshes the content over a specified period.
\n", + "linenr": 335, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "scope", - "doc": "(optional) The scope originally specified for the handler.
\n", - "optional": true - } - ], - "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": 608, - "html_filename": "Observable.html", - "href": "Observable.html#Ext-util-Observable-method-un", - "shortDoc": "Removes an event handler (shorthand for removeListener.)
\n" - } - ], - "property": [ + { + "deprecated": null, + "alias": null, + "protected": true, + "tagname": "method", + "href": "Base3.html#Ext-Base-method-statics", + "shortDoc": "Get the reference to the class from which this object was instantiated. ...", + "static": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", + "private": false, + "params": [ - ], - "event": [ - { - "tagname": "event", - "name": "beforeload", - "member": "Ext.ElementLoader", - "doc": "Fires before a load request is made to the server.\nReturning false from an event listener can prevent the load\nfrom occurring.
\n", - "params": [ - { - "type": "Ext.ElementLoader", - "name": "this", - "doc": "\n", - "optional": false + ], + "name": "statics", + "owner": "Ext.Base", + "doc": "Get the reference to the class from which this object was instantiated. Note that unlike Ext.Base.self,\nthis.statics() is scope-independent and it always returns the class from which it was called, regardless of what\nthis points to during run-time
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\nThe options passed to the request
\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": "Fires after a successful load.
\n", - "params": [ - { - "type": "Ext.ElementLoader", - "name": "this", - "doc": "\n", - "optional": false + "html_filename": "Base3.html" + }, + { + "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": [ + + ], + "name": "stopAutoRefresh", + "owner": "Ext.ElementLoader", + "doc": "Clears any auto refresh. See startAutoRefresh.
\n", + "linenr": 348, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "response", - "doc": "The response from the server
\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": "Pass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events.
\n", + "name": "queueSuspended" + } + ], + "name": "suspendEvents", + "owner": "Ext.util.Observable", + "doc": "Suspends the firing of all events. (see resumeEvents)
\n", + "linenr": 541, + "return": { + "type": "void", + "doc": "\n" }, - { - "type": "Object", - "name": "options", - "doc": "The options passed to the request
\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": "Fires after a successful load.
\n" - } - ], - "filename": "/Users/nick/Projects/sencha/SDK/platform/src/ComponentLoader.js", - "linenr": 1, - "html_filename": "ComponentLoader.html", - "href": "ComponentLoader.html#Ext-ComponentLoader", - "cssVar": [ + "html_filename": "Observable.html" + }, + { + "deprecated": null, + "alias": { + "tagname": "alias", + "cls": "Ext.util.Observable", + "doc": null, + "owner": "removeListener" + }, + "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": "The type of event the handler was associated with.
\n", + "name": "eventName" + }, + { + "type": "Function", + "optional": false, + "doc": "The handler to remove. This must be a reference to the function passed into the\naddListener call.
\n", + "name": "handler" + }, + { + "type": "Object", + "optional": true, + "doc": "(optional) The scope originally specified for the handler.
\n", + "name": "scope" + } + ], + "name": "un", + "owner": "Ext.util.Observable", + "doc": "Shorthand for removeListener.
\n\nRemoves an event handler.
\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": "Get the reference to the current class from which this object was instantiated. Unlike Ext.Base.statics,\nthis.self is scope-dependent and it's meant to be used for dynamic inheritance. See Ext.Base.statics\nfor a detailed comparison
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'\nThe options passed to the request
\n", + "name": "options" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "The options object passed to Ext.util.Observable.addListener.
\n" + } + ], + "name": "beforeload", + "owner": "Ext.ElementLoader", + "doc": "Fires before a load request is made to the server.\nReturning false from an event listener can prevent the load\nfrom occurring.
\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": "The response from the server
\n", + "name": "response" + }, + { + "type": "Object", + "optional": false, + "doc": "The options passed to the request
\n", + "name": "options" + }, + { + "type": "Object", + "tagname": "param", + "name": "options", + "doc": "The options object passed to Ext.util.Observable.addListener.
\n" + } + ], + "name": "exception", + "owner": "Ext.ElementLoader", + "doc": "Fires after a successful load.
\n", + "linenr": 136, + "html_filename": "ElementLoader.html" + } + ] + }, + "singleton": false, + "alias": null, "superclasses": [ + "Ext.Base", "Ext.ElementLoader" ], + "protected": false, + "tagname": "class", + "mixins": [ + + ], + "href": "ComponentLoader.html#Ext-ComponentLoader", "subclasses": [ ], + "static": false, + "author": null, + "component": false, + "filename": "/mnt/ebs/nightly/git/SDK/platform/src/ComponentLoader.js", + "private": false, + "alternateClassNames": [ + + ], + "name": "Ext.ComponentLoader", + "doc": "This class is used to load content via Ajax into a Ext.Component. In general\nthis class will not be instanced directly, rather a loader configuration will be passed to the\nconstructor of the Ext.Component.
\n\nBy default, the content loaded will be processed as raw html. The response text\nfrom the request is taken and added to the component. This can be used in\nconjunction with the scripts option to execute any inline scripts in\nthe resulting content. Using this renderer has the same effect as passing the\nExt.Component.html configuration option.
\n\nThis renderer allows content to be added by using JSON data and a Ext.XTemplate.\nThe content received from the response is passed to the Ext.Component.update method.\nThis content is run through the attached Ext.Component.tpl and the data is added to\nthe Component. Using this renderer has the same effect as using the Ext.Component.data\nconfiguration in conjunction with a Ext.Component.tpl.
\n\nThis renderer can only be used with a Ext.container.Container and subclasses. It allows for\nComponents to be loaded remotely into a Container. The response is expected to be a single/series of\nExt.Component configuration objects. When the response is received, the data is decoded\nand then passed to Ext.container.Container.add. Using this renderer has the same effect as specifying\nthe Ext.container.Container.items configuration on a Container.
\n\nA custom function can be passed to handle any other special case, see the renderer option.
\n\nnew Ext.Component({\n tpl: '{firstName} - {lastName}',\n loader: {\n url: 'myPage.php',\n renderer: 'data',\n params: {\n userId: 1\n }\n }\n});\n