--- /dev/null
+Ext.data.JsonP.Ext_state_Stateful({
+ "tagname": "class",
+ "name": "Ext.state.Stateful",
+ "doc": "<p>A mixin for being able to save the state of an object to an underlying\n<a href=\"#/api/Ext.state.Provider\" rel=\"Ext.state.Provider\" class=\"docClass\">Ext.state.Provider</a>.</p>\n",
+ "extends": null,
+ "mixins": [
+ "Ext.util.Observable"
+ ],
+ "alternateClassNames": [
+
+ ],
+ "xtype": null,
+ "author": null,
+ "docauthor": null,
+ "singleton": false,
+ "private": false,
+ "cfg": [
+ {
+ "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.state.Stateful-method-addListener\" rel=\"Ext.state.Stateful-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": "saveBuffer",
+ "member": "Ext.state.Stateful",
+ "type": "Number",
+ "doc": "<p>A buffer to be applied if many state events are fired within\na short period. Defaults to 100.</p>\n",
+ "private": false,
+ "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js",
+ "linenr": 74,
+ "html_filename": "Stateful.html",
+ "href": "Stateful.html#Ext-state-Stateful-cfg-saveBuffer"
+ },
+ {
+ "tagname": "cfg",
+ "name": "stateEvents",
+ "member": "Ext.state.Stateful",
+ "type": "Array",
+ "doc": "<p>An array of events that, when fired, should trigger this object to\nsave its state (defaults to none). <code>stateEvents</code> may be any type\nof event supported by this object, including browser or custom events\n(e.g., <tt>['click', 'customerchange']</tt>).</p>\n\n\n<p>See <code><a href=\"#/api/Ext.state.Stateful-cfg-stateful\" rel=\"Ext.state.Stateful-cfg-stateful\" class=\"docClass\">stateful</a></code> for an explanation of saving and\nrestoring object state.</p>\n\n",
+ "private": false,
+ "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js",
+ "linenr": 64,
+ "html_filename": "Stateful.html",
+ "href": "Stateful.html#Ext-state-Stateful-cfg-stateEvents",
+ "shortDoc": "An array of events that, when fired, should trigger this object to\nsave its state (defaults to none). stateEvents may..."
+ },
+ {
+ "tagname": "cfg",
+ "name": "stateId",
+ "member": "Ext.state.Stateful",
+ "type": "String",
+ "doc": "<p>The unique id for this object to use for state management purposes.</p>\n\n<p>See <a href=\"#/api/Ext.state.Stateful-cfg-stateful\" rel=\"Ext.state.Stateful-cfg-stateful\" class=\"docClass\">stateful</a> for an explanation of saving and restoring state.</p>\n\n",
+ "private": false,
+ "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js",
+ "linenr": 58,
+ "html_filename": "Stateful.html",
+ "href": "Stateful.html#Ext-state-Stateful-cfg-stateId",
+ "shortDoc": "The unique id for this object to use for state management purposes.\n\nSee stateful for an explanation of saving and re..."
+ },
+ {
+ "tagname": "cfg",
+ "name": "stateful",
+ "member": "Ext.state.Stateful",
+ "type": "Boolean",
+ "doc": "<p>A flag which causes the object to attempt to restore the state of\ninternal properties from a saved state on startup. The object must have\na <code><a href=\"#/api/Ext.state.Stateful-cfg-stateId\" rel=\"Ext.state.Stateful-cfg-stateId\" class=\"docClass\">stateId</a></code> for state to be managed. \nAuto-generated ids are not guaranteed to be stable across page loads and \ncannot be relied upon to save and restore the same state for a object.<p>\n<p>For state saving to work, the state manager's provider must have been\nset to an implementation of <a href=\"#/api/Ext.state.Provider\" rel=\"Ext.state.Provider\" class=\"docClass\">Ext.state.Provider</a> which overrides the\n<a href=\"#/api/Ext.state.Provider-method-set\" rel=\"Ext.state.Provider-method-set\" class=\"docClass\">set</a> and <a href=\"#/api/Ext.state.Provider-method-get\" rel=\"Ext.state.Provider-method-get\" class=\"docClass\">get</a>\nmethods to save and recall name/value pairs. A built-in implementation,\n<a href=\"#/api/Ext.state.CookieProvider\" rel=\"Ext.state.CookieProvider\" class=\"docClass\">Ext.state.CookieProvider</a> is available.</p>\n<p>To set the state provider for the current page:</p>\n<pre><code>Ext.state.Manager.setProvider(new Ext.state.CookieProvider({\n expires: new Date(new Date().getTime()+(1000*60*60*24*7)), //7 days from now\n}));\n</code></pre>\n<p>A stateful object attempts to save state when one of the events\nlisted in the <code><a href=\"#/api/Ext.state.Stateful-cfg-stateEvents\" rel=\"Ext.state.Stateful-cfg-stateEvents\" class=\"docClass\">stateEvents</a></code> configuration fires.</p>\n<p>To save state, a stateful object first serializes its state by\ncalling <b><code><a href=\"#/api/Ext.state.Stateful-method-getState\" rel=\"Ext.state.Stateful-method-getState\" class=\"docClass\">getState</a></code></b>. By default, this function does\nnothing. The developer must provide an implementation which returns an\nobject hash which represents the restorable state of the object.</p>\n<p>The value yielded by getState is passed to <a href=\"#/api/Ext.state.Manager-method-set\" rel=\"Ext.state.Manager-method-set\" class=\"docClass\">Ext.state.Manager.set</a>\nwhich uses the configured <a href=\"#/api/Ext.state.Provider\" rel=\"Ext.state.Provider\" class=\"docClass\">Ext.state.Provider</a> to save the object\nkeyed by the <code><a href=\"#/api/stateId\" rel=\"stateId\" class=\"docClass\">stateId</a></code></p>.\n<p>During construction, a stateful object attempts to <i>restore</i>\nits state by calling <a href=\"#/api/Ext.state.Manager-method-get\" rel=\"Ext.state.Manager-method-get\" class=\"docClass\">Ext.state.Manager.get</a> passing the\n<code><a href=\"#/api/Ext.state.Stateful-cfg-stateId\" rel=\"Ext.state.Stateful-cfg-stateId\" class=\"docClass\">stateId</a></code></p>\n<p>The resulting object is passed to <b><code><a href=\"#/api/Ext.state.Stateful-method-applyState\" rel=\"Ext.state.Stateful-method-applyState\" class=\"docClass\">applyState</a></code></b>.\nThe default implementation of <code><a href=\"#/api/Ext.state.Stateful-method-applyState\" rel=\"Ext.state.Stateful-method-applyState\" class=\"docClass\">applyState</a></code> simply copies\nproperties into the object, but a developer may override this to support\nmore behaviour.</p>\n<p>You can perform extra processing on state save and restore by attaching\nhandlers to the <a href=\"#/api/Ext.state.Stateful-event-beforestaterestore\" rel=\"Ext.state.Stateful-event-beforestaterestore\" class=\"docClass\">beforestaterestore</a>, <a href=\"#/api/Ext.state.Stateful-event-staterestore\" rel=\"Ext.state.Stateful-event-staterestore\" class=\"docClass\">staterestore</a>,\n<a href=\"#/api/Ext.state.Stateful-event-beforestatesave\" rel=\"Ext.state.Stateful-event-beforestatesave\" class=\"docClass\">beforestatesave</a> and <a href=\"#/api/Ext.state.Stateful-event-statesave\" rel=\"Ext.state.Stateful-event-statesave\" class=\"docClass\">statesave</a> events.</p>\n\n",
+ "private": false,
+ "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js",
+ "linenr": 18,
+ "html_filename": "Stateful.html",
+ "href": "Stateful.html#Ext-state-Stateful-cfg-stateful",
+ "shortDoc": "A flag which causes the object to attempt to restore the state of\ninternal properties from a saved state on startup. ..."
+ }
+ ],
+ "method": [
+ {
+ "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"
+ },
+ "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": "Function",
+ "name": "handler",
+ "doc": "<p>The method the event invokes.</p>\n",
+ "optional": false
+ },
+ {
+ "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
+ },
+ {
+ "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"
+ },
+ "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
+ },
+ {
+ "type": "Object/String",
+ "name": "ename",
+ "doc": "<p>The event name, or an object containing event name properties.</p>\n",
+ "optional": false
+ },
+ {
+ "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
+ },
+ {
+ "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
+ },
+ {
+ "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"
+ },
+ "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": "addStateEvents",
+ "member": "Ext.state.Stateful",
+ "doc": "<p>Add events that will trigger the state to be saved.</p>\n",
+ "params": [
+ {
+ "type": "String/Array",
+ "name": "events",
+ "doc": "<p>The event name or an array of event names.</p>\n",
+ "optional": false
+ }
+ ],
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "private": false,
+ "static": false,
+ "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js",
+ "linenr": 159,
+ "html_filename": "Stateful.html",
+ "href": "Stateful.html#Ext-state-Stateful-method-addStateEvents",
+ "shortDoc": "<p>Add events that will trigger the state to be saved.</p>\n"
+ },
+ {
+ "tagname": "method",
+ "name": "applyState",
+ "member": "Ext.state.Stateful",
+ "doc": "<p>Applies the state to the object. This should be overridden in subclasses to do\nmore complex state operations. By default it applies the state properties onto\nthe current object.</p>\n",
+ "params": [
+ {
+ "type": "Object",
+ "name": "state",
+ "doc": "<p>The state</p>\n",
+ "optional": false
+ }
+ ],
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "private": false,
+ "static": false,
+ "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js",
+ "linenr": 225,
+ "html_filename": "Stateful.html",
+ "href": "Stateful.html#Ext-state-Stateful-method-applyState",
+ "shortDoc": "Applies the state to the object. This should be overridden in subclasses to do\nmore complex state operations. By defa..."
+ },
+ {
+ "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
+ },
+ {
+ "type": "Function",
+ "name": "fn",
+ "doc": "<p>The function to call when an event is fired.</p>\n",
+ "optional": false
+ },
+ {
+ "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"
+ },
+ "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": [
+
+ ],
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "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": [
+
+ ],
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "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.state.Stateful",
+ "doc": "<p>Destroys this stateful object.</p>\n",
+ "params": [
+
+ ],
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "private": false,
+ "static": false,
+ "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js",
+ "linenr": 274,
+ "html_filename": "Stateful.html",
+ "href": "Stateful.html#Ext-state-Stateful-method-destroy",
+ "shortDoc": "<p>Destroys this stateful object.</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"
+ },
+ "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.state.Stateful-method-enableBubble\" rel=\"Ext.state.Stateful-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
+ },
+ {
+ "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"
+ },
+ "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": "getState",
+ "member": "Ext.state.Stateful",
+ "doc": "<p>Gets the current state of the object. By default this function returns null,\nit should be overridden in subclasses to implement methods for getting the state.</p>\n",
+ "params": [
+
+ ],
+ "return": {
+ "type": "Object",
+ "doc": "<p>The current state</p>\n"
+ },
+ "private": false,
+ "static": false,
+ "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js",
+ "linenr": 216,
+ "html_filename": "Stateful.html",
+ "href": "Stateful.html#Ext-state-Stateful-method-getState",
+ "shortDoc": "Gets the current state of the object. By default this function returns null,\nit should be overridden in subclasses to..."
+ },
+ {
+ "tagname": "method",
+ "name": "getStateId",
+ "member": "Ext.state.Stateful",
+ "doc": "<p>Gets the state id for this object.</p>\n",
+ "params": [
+
+ ],
+ "return": {
+ "type": "String",
+ "doc": "<p>The state id, null if not found.</p>\n"
+ },
+ "private": false,
+ "static": false,
+ "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js",
+ "linenr": 237,
+ "html_filename": "Stateful.html",
+ "href": "Stateful.html#Ext-state-Stateful-method-getStateId",
+ "shortDoc": "<p>Gets the state id for this object.</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": [
+ {
+ "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"
+ },
+ "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": "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
+ },
+ {
+ "type": "Object",
+ "name": "listeners",
+ "doc": "<p>An object containing a series of listeners to add. See <a href=\"#/api/Ext.state.Stateful-method-addListener\" rel=\"Ext.state.Stateful-method-addListener\" class=\"docClass\">addListener</a>.</p>\n",
+ "optional": false
+ }
+ ],
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "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.state.Stateful-method-addListener\" rel=\"Ext.state.Stateful-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
+ },
+ {
+ "type": "Function",
+ "name": "handler",
+ "doc": "<p>The method the event invokes</p>\n",
+ "optional": false
+ },
+ {
+ "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
+ },
+ {
+ "type": "Object",
+ "name": "options",
+ "doc": "<p>(optional) An object containing handler configuration.</p>\n",
+ "optional": true
+ }
+ ],
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "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.state.Stateful-method-addListener\" rel=\"Ext.state.Stateful-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
+ },
+ {
+ "type": "Array",
+ "name": "events",
+ "doc": "<p>Array of event names to relay.</p>\n",
+ "optional": false
+ },
+ {
+ "type": "Object",
+ "name": "prefix",
+ "doc": "\n",
+ "optional": false
+ }
+ ],
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "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"
+ },
+ "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
+ },
+ {
+ "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.state.Stateful-method-addListener\" rel=\"Ext.state.Stateful-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
+ "optional": false
+ },
+ {
+ "type": "Object",
+ "name": "scope",
+ "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
+ "optional": true
+ }
+ ],
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "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.state.Stateful--mon\" rel=\"Ext.state.Stateful--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
+ },
+ {
+ "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
+ },
+ {
+ "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"
+ },
+ "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.state.Stateful--mon\" rel=\"Ext.state.Stateful--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.state.Stateful-method-suspendEvents\" rel=\"Ext.state.Stateful-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"
+ },
+ "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": "suspendEvents",
+ "member": "Ext.util.Observable",
+ "doc": "<p>Suspend the firing of all events. (see <a href=\"#/api/Ext.state.Stateful-method-resumeEvents\" rel=\"Ext.state.Stateful-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.state.Stateful-method-resumeEvents\" rel=\"Ext.state.Stateful-method-resumeEvents\" class=\"docClass\">resumeEvents</a> call instead of discarding all suspended events;</p>\n",
+ "optional": false
+ }
+ ],
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "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.state.Stateful-method-resumeEvents\" rel=\"Ext.state.Stateful-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.state.Stateful-method-removeListener\" rel=\"Ext.state.Stateful-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
+ },
+ {
+ "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.state.Stateful-method-addListener\" rel=\"Ext.state.Stateful-method-addListener\" class=\"docClass\">addListener</a> call.</b></p>\n",
+ "optional": false
+ },
+ {
+ "type": "Object",
+ "name": "scope",
+ "doc": "<p>(optional) The scope originally specified for the handler.</p>\n",
+ "optional": true
+ }
+ ],
+ "return": {
+ "type": "void",
+ "doc": "\n"
+ },
+ "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.state.Stateful-method-removeListener\" rel=\"Ext.state.Stateful-method-removeListener\" class=\"docClass\">removeListener</a>.)</p>\n"
+ }
+ ],
+ "property": [
+
+ ],
+ "event": [
+ {
+ "tagname": "event",
+ "name": "beforestaterestore",
+ "member": "Ext.state.Stateful",
+ "doc": "<p>Fires before the state of the object is restored. Return false from an event handler to stop the restore.</p>\n",
+ "params": [
+ {
+ "type": "Ext.state.Stateful",
+ "name": "this",
+ "doc": "\n",
+ "optional": false
+ },
+ {
+ "type": "Object",
+ "name": "state",
+ "doc": "<p>The hash of state values returned from the StateProvider. If this\nevent is not vetoed, then the state object is passed to <b><tt>applyState</tt></b>. By default,\nthat simply copies property values into this object. The method maybe overriden to\nprovide custom state restoration.</p>\n",
+ "optional": false
+ }
+ ],
+ "private": false,
+ "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js",
+ "linenr": 101,
+ "html_filename": "Stateful.html",
+ "href": "Stateful.html#Ext-state-Stateful-event-beforestaterestore",
+ "shortDoc": "<p>Fires before the state of the object is restored. Return false from an event handler to stop the restore.</p>\n"
+ },
+ {
+ "tagname": "event",
+ "name": "beforestatesave",
+ "member": "Ext.state.Stateful",
+ "doc": "<p>Fires before the state of the object is saved to the configured state provider. Return false to stop the save.</p>\n",
+ "params": [
+ {
+ "type": "Ext.state.Stateful",
+ "name": "this",
+ "doc": "\n",
+ "optional": false
+ },
+ {
+ "type": "Object",
+ "name": "state",
+ "doc": "<p>The hash of state values. This is determined by calling\n<b><tt>getState()</tt></b> on the object. This method must be provided by the\ndeveloper to return whetever representation of state is required, by default, <a href=\"#/api/Ext.state.Stateful\" rel=\"Ext.state.Stateful\" class=\"docClass\">Ext.state.Stateful</a>\nhas a null implementation.</p>\n",
+ "optional": false
+ }
+ ],
+ "private": false,
+ "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js",
+ "linenr": 122,
+ "html_filename": "Stateful.html",
+ "href": "Stateful.html#Ext-state-Stateful-event-beforestatesave",
+ "shortDoc": "<p>Fires before the state of the object is saved to the configured state provider. Return false to stop the save.</p>\n"
+ },
+ {
+ "tagname": "event",
+ "name": "staterestore",
+ "member": "Ext.state.Stateful",
+ "doc": "<p>Fires after the state of the object is restored.</p>\n",
+ "params": [
+ {
+ "type": "Ext.state.Stateful",
+ "name": "this",
+ "doc": "\n",
+ "optional": false
+ },
+ {
+ "type": "Object",
+ "name": "state",
+ "doc": "<p>The hash of state values returned from the StateProvider. This is passed\nto <b><tt>applyState</tt></b>. By default, that simply copies property values into this\nobject. The method maybe overriden to provide custom state restoration.</p>\n",
+ "optional": false
+ }
+ ],
+ "private": false,
+ "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js",
+ "linenr": 112,
+ "html_filename": "Stateful.html",
+ "href": "Stateful.html#Ext-state-Stateful-event-staterestore",
+ "shortDoc": "<p>Fires after the state of the object is restored.</p>\n"
+ },
+ {
+ "tagname": "event",
+ "name": "statesave",
+ "member": "Ext.state.Stateful",
+ "doc": "<p>Fires after the state of the object is saved to the configured state provider.</p>\n",
+ "params": [
+ {
+ "type": "Ext.state.Stateful",
+ "name": "this",
+ "doc": "\n",
+ "optional": false
+ },
+ {
+ "type": "Object",
+ "name": "state",
+ "doc": "<p>The hash of state values. This is determined by calling\n<b><tt>getState()</tt></b> on the object. This method must be provided by the\ndeveloper to return whetever representation of state is required, by default, <a href=\"#/api/Ext.state.Stateful\" rel=\"Ext.state.Stateful\" class=\"docClass\">Ext.state.Stateful</a>\nhas a null implementation.</p>\n",
+ "optional": false
+ }
+ ],
+ "private": false,
+ "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js",
+ "linenr": 133,
+ "html_filename": "Stateful.html",
+ "href": "Stateful.html#Ext-state-Stateful-event-statesave",
+ "shortDoc": "<p>Fires after the state of the object is saved to the configured state provider.</p>\n"
+ }
+ ],
+ "filename": "/Users/nick/Projects/sencha/SDK/platform/src/state/Stateful.js",
+ "linenr": 1,
+ "html_filename": "Stateful.html",
+ "href": "Stateful.html#Ext-state-Stateful",
+ "cssVar": [
+
+ ],
+ "cssMixin": [
+
+ ],
+ "component": false,
+ "superclasses": [
+
+ ],
+ "subclasses": [
+
+ ],
+ "mixedInto": [
+ "Ext.AbstractComponent"
+ ],
+ "allMixins": [
+ "Ext.util.Observable"
+ ]
+});
\ No newline at end of file
git.ithinksw.org / extjs.git / blobdiff