X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..3789b528d8dd8aad4558e38e22d775bcab1cbd36:/docs/output/Ext.data.TreeStore.js?ds=sidebyside diff --git a/docs/output/Ext.data.TreeStore.js b/docs/output/Ext.data.TreeStore.js new file mode 100644 index 00000000..6945dd39 --- /dev/null +++ b/docs/output/Ext.data.TreeStore.js @@ -0,0 +1,1842 @@ +Ext.data.JsonP.Ext_data_TreeStore({ + "tagname": "class", + "name": "Ext.data.TreeStore", + "doc": "
The TreeStore is a store implementation that is backed by by an Ext.data.Tree.\nIt provides convenience methods for loading nodes, as well as the ability to use\nthe hierarchical tree structure combined with a store. This class is generally used\nin conjunction with Ext.tree.Panel. This class also relays many events from\nthe Tree for convenience.
\n\nIf no Model is specified, an implicit model will be created that implements Ext.data.NodeInterface.\nThe standard Tree fields will also be copied onto the Model for maintaining their state.
\n\nFor the tree to read nested data, the Ext.data.Reader must be configured with a root property,\nso the reader can find nested data for each node. If a root is not specified, it will default to\n'children'.
\n", + "extends": "Ext.data.AbstractStore", + "mixins": [ + + ], + "alternateClassNames": [ + + ], + "xtype": null, + "author": null, + "docauthor": null, + "singleton": false, + "private": false, + "cfg": [ + { + "tagname": "cfg", + "name": "autoLoad", + "member": "Ext.data.AbstractStore", + "type": "Boolean/Object", + "doc": "If data is not specified, and if autoLoad is true or an Object, this store's load method\nis automatically called after creation. If the value of autoLoad is an Object, this Object will be passed to the store's\nload method. Defaults to false.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js", + "linenr": 56, + "html_filename": "AbstractStore.html", + "href": "AbstractStore.html#Ext-data-AbstractStore-cfg-autoLoad", + "shortDoc": "If data is not specified, and if autoLoad is true or an Object, this store's load method\nis automatically called afte..." + }, + { + "tagname": "cfg", + "name": "autoSync", + "member": "Ext.data.AbstractStore", + "type": "Boolean", + "doc": "True to automatically sync the Store with its Proxy after every edit to one of its Records.\nDefaults to false.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js", + "linenr": 63, + "html_filename": "AbstractStore.html", + "href": "AbstractStore.html#Ext-data-AbstractStore-cfg-autoSync" + }, + { + "tagname": "cfg", + "name": "clearOnLoad", + "member": "Ext.data.TreeStore", + "type": "Boolean", + "doc": "(optional) Default to true. Remove previously existing\nchild nodes before loading.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/TreeStore.js", + "linenr": 25, + "html_filename": "TreeStore.html", + "href": "TreeStore.html#Ext-data-TreeStore-cfg-clearOnLoad" + }, + { + "tagname": "cfg", + "name": "defaultRootId", + "member": "Ext.data.TreeStore", + "type": "String", + "doc": "The default root id. Defaults to 'root'
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/TreeStore.js", + "linenr": 37, + "html_filename": "TreeStore.html", + "href": "TreeStore.html#Ext-data-TreeStore-cfg-defaultRootId" + }, + { + "tagname": "cfg", + "name": "defaultRootProperty", + "member": "Ext.data.TreeStore", + "type": "String", + "doc": "The root property to specify on the reader if one is not explicitly defined.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/TreeStore.js", + "linenr": 43, + "html_filename": "TreeStore.html", + "href": "TreeStore.html#Ext-data-TreeStore-cfg-defaultRootProperty" + }, + { + "tagname": "cfg", + "name": "fields", + "member": "Ext.data.AbstractStore", + "type": "Array", + "doc": "This may be used in place of specifying a model configuration. The fields should be a\nset of Ext.data.Field configuration objects. The store will automatically create a Ext.data.Model\nwith these fields. In general this configuration option should be avoided, it exists for the purposes of\nbackwards compatibility. For anything more complicated, such as specifying a particular id property or\nassocations, a Ext.data.Model should be defined and specified for the model config.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js", + "linenr": 126, + "html_filename": "AbstractStore.html", + "href": "AbstractStore.html#Ext-data-AbstractStore-cfg-fields", + "shortDoc": "This may be used in place of specifying a model configuration. The fields should be a\nset of Ext.data.Field configura..." + }, + { + "tagname": "cfg", + "name": "folderSort", + "member": "Ext.data.TreeStore", + "type": "Boolean", + "doc": "Set to true to automatically prepend a leaf sorter (defaults to undefined)
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/TreeStore.js", + "linenr": 49, + "html_filename": "TreeStore.html", + "href": "TreeStore.html#Ext-data-TreeStore-cfg-folderSort" + }, + { + "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});\n
\n\n\n\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": "nodeParam",
+ "member": "Ext.data.TreeStore",
+ "type": "String",
+ "doc": "The name of the parameter sent to the server which contains\nthe identifier of the node. Defaults to 'node'.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/TreeStore.js", + "linenr": 31, + "html_filename": "TreeStore.html", + "href": "TreeStore.html#Ext-data-TreeStore-cfg-nodeParam" + }, + { + "tagname": "cfg", + "name": "proxy", + "member": "Ext.data.AbstractStore", + "type": "String/Ext.data.proxy.Proxy/Object", + "doc": "The Proxy to use for this Store. This can be either a string, a config\nobject or a Proxy instance - see setProxy for details.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js", + "linenr": 51, + "html_filename": "AbstractStore.html", + "href": "AbstractStore.html#Ext-data-AbstractStore-cfg-proxy", + "shortDoc": "The Proxy to use for this Store. This can be either a string, a config\nobject or a Proxy instance - see setProxy for ..." + }, + { + "tagname": "cfg", + "name": "storeId", + "member": "Ext.data.AbstractStore", + "type": "String", + "doc": "Optional unique identifier for this store. If present, this Store will be registered with\nthe Ext.data.StoreManager, making it easy to reuse elsewhere. Defaults to undefined.
\n", + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js", + "linenr": 121, + "html_filename": "AbstractStore.html", + "href": "AbstractStore.html#Ext-data-AbstractStore-cfg-storeId", + "shortDoc": "Optional unique identifier for this store. If present, this Store will be registered with\nthe Ext.data.StoreManager, ..." + } + ], + "method": [ + { + "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');\n
\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": "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": "Function", + "name": "handler", + "doc": "The method the event invokes.
\n", + "optional": false + }, + { + "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.
(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});\n
\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});
\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\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": "
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 + }, + { + "type": "Object/String", + "name": "ename", + "doc": "The event name, or an object containing event name properties.
\n", + "optional": false + }, + { + "type": "Function", + "name": "fn", + "doc": "Optional. If the ename
parameter was an event name, this\nis the handler function.
Optional. If the ename
parameter was an event name, this\nis the scope (this
reference) in which the handler function is executed.
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 + }, + { + "type": "Function", + "name": "fn", + "doc": "The function to call when an event is fired.
\n", + "optional": false + }, + { + "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": [ + + ], + "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": "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": [ + + ], + "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": "Removes all managed listeners for this object.
\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});\n
\n\n",
+ "params": [
+ {
+ "type": "String/Array",
+ "name": "events",
+ "doc": "The event name to bubble, or an Array of event names.
\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": "Fires 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 + }, + { + "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" + }, + "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": "getNewRecords", + "member": "Ext.data.AbstractStore", + "doc": "Returns all Model instances that are either currently a phantom (e.g. have no id), or have an ID but have not\nyet been saved on this Store (this happens when adding a non-phantom record from another Store into this one)
\n", + "params": [ + + ], + "return": { + "type": "Array", + "doc": "The Model instances
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js", + "linenr": 452, + "html_filename": "AbstractStore.html", + "href": "AbstractStore.html#Ext-data-AbstractStore-method-getNewRecords", + "shortDoc": "Returns all Model instances that are either currently a phantom (e.g. have no id), or have an ID but have not\nyet bee..." + }, + { + "tagname": "method", + "name": "getNodeById", + "member": "Ext.data.TreeStore", + "doc": "Returns the record node by id
\n", + "params": [ + { + "type": "Object", + "name": "id", + "doc": "\n", + "optional": false + } + ], + "return": { + "type": "Ext.data.NodeInterface", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/TreeStore.js", + "linenr": 389, + "html_filename": "TreeStore.html", + "href": "TreeStore.html#Ext-data-TreeStore-method-getNodeById", + "shortDoc": "Returns the record node by id
\n" + }, + { + "tagname": "method", + "name": "getProxy", + "member": "Ext.data.AbstractStore", + "doc": "Returns the proxy currently attached to this proxy instance
\n", + "params": [ + + ], + "return": { + "type": "Ext.data.proxy.Proxy", + "doc": "The Proxy instance
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js", + "linenr": 307, + "html_filename": "AbstractStore.html", + "href": "AbstractStore.html#Ext-data-AbstractStore-method-getProxy", + "shortDoc": "Returns the proxy currently attached to this proxy instance
\n" + }, + { + "tagname": "method", + "name": "getRemovedRecords", + "member": "Ext.data.AbstractStore", + "doc": "Returns any records that have been removed from the store but not yet destroyed on the proxy.
\n", + "params": [ + + ], + "return": { + "type": "Array", + "doc": "The removed Model instances
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js", + "linenr": 478, + "html_filename": "AbstractStore.html", + "href": "AbstractStore.html#Ext-data-AbstractStore-method-getRemovedRecords", + "shortDoc": "Returns any records that have been removed from the store but not yet destroyed on the proxy.
\n" + }, + { + "tagname": "method", + "name": "getRootNode", + "member": "Ext.data.TreeStore", + "doc": "Returns the root node for this tree.
\n", + "params": [ + + ], + "return": { + "type": "Ext.data.NodeInterface", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/TreeStore.js", + "linenr": 381, + "html_filename": "TreeStore.html", + "href": "TreeStore.html#Ext-data-TreeStore-method-getRootNode", + "shortDoc": "Returns the root node for this tree.
\n" + }, + { + "tagname": "method", + "name": "getUpdatedRecords", + "member": "Ext.data.AbstractStore", + "doc": "Returns all Model instances that have been updated in the Store but not yet synchronized with the Proxy
\n", + "params": [ + + ], + "return": { + "type": "Array", + "doc": "The updated Model instances
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js", + "linenr": 461, + "html_filename": "AbstractStore.html", + "href": "AbstractStore.html#Ext-data-AbstractStore-method-getUpdatedRecords", + "shortDoc": "Returns all Model instances that have been updated in the Store but not yet synchronized with the Proxy
\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": [ + { + "type": "String", + "name": "eventName", + "doc": "The 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" + }, + "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": "initSortable", + "member": "Ext.util.Sortable", + "doc": "Performs initialization of this mixin. Component classes using this mixin should call this method\nduring their own initialization.
\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Sortable.js", + "linenr": 37, + "html_filename": "Sortable.html", + "href": "Sortable.html#Ext-util-Sortable-method-initSortable", + "shortDoc": "Performs initialization of this mixin. Component classes using this mixin should call this method\nduring their own in..." + }, + { + "tagname": "method", + "name": "isLoading", + "member": "Ext.data.AbstractStore", + "doc": "Returns true if the Store is currently performing a load operation
\n", + "params": [ + + ], + "return": { + "type": "Boolean", + "doc": "True if the Store is currently loading
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js", + "linenr": 717, + "html_filename": "AbstractStore.html", + "href": "AbstractStore.html#Ext-data-AbstractStore-method-isLoading", + "shortDoc": "Returns true if the Store is currently performing a load operation
\n" + }, + { + "tagname": "method", + "name": "load", + "member": "Ext.data.TreeStore", + "doc": "Loads the Store using its configured proxy.
\n", + "params": [ + { + "type": "Object", + "name": "options", + "doc": "Optional config object. This is passed into the Operation\nobject that is created and then sent to the proxy's Ext.data.proxy.Proxy.read function.\nThe options can also contain a node, which indicates which node is to be loaded. If not specified, it will\ndefault to the root node.
\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/TreeStore.js", + "linenr": 397, + "html_filename": "TreeStore.html", + "href": "TreeStore.html#Ext-data-TreeStore-method-load", + "shortDoc": "Loads the Store using its configured proxy.
\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});\n
\n",
+ "params": [
+ {
+ "type": "Function",
+ "name": "c",
+ "doc": "The class constructor to make observable.
\n", + "optional": false + }, + { + "type": "Object", + "name": "listeners", + "doc": "An object containing a series of listeners to add. See addListener.
\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": "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 + }, + { + "type": "Function", + "name": "handler", + "doc": "The method the event invokes
\n", + "optional": false + }, + { + "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.
(optional) An object containing handler configuration.
\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": "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 + }, + { + "type": "Array", + "name": "events", + "doc": "Array of event names to relay.
\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": "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" + }, + "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": "removeAll", + "member": "Ext.data.AbstractStore", + "doc": "Removes all records from the store. This method does a \"fast remove\",\nindividual remove events are not called. The clear event is\nfired upon completion.
\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js", + "linenr": 707, + "html_filename": "AbstractStore.html", + "href": "AbstractStore.html#Ext-data-AbstractStore-method-removeAll", + "shortDoc": "Removes all records from the store. This method does a \"fast remove\",\nindividual remove events are not called. The cl..." + }, + { + "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 + }, + { + "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 + }, + { + "type": "Object", + "name": "scope", + "doc": "(optional) The scope originally specified for the handler.
\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": "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 + }, + { + "type": "Object|String", + "name": "ename", + "doc": "The event name, or an object containing event name properties.
\n", + "optional": false + }, + { + "type": "Function", + "name": "fn", + "doc": "Optional. If the ename
parameter was an event name, this\nis the handler function.
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.
Sets the Store's Proxy by string, config object or Proxy instance
\n", + "params": [ + { + "type": "String|Object|Ext.data.proxy.Proxy", + "name": "proxy", + "doc": "The new Proxy, which can be either a type string, a configuration object\nor an Ext.data.proxy.Proxy instance
\n", + "optional": false + } + ], + "return": { + "type": "Ext.data.proxy.Proxy", + "doc": "The attached Proxy object
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js", + "linenr": 278, + "html_filename": "AbstractStore.html", + "href": "AbstractStore.html#Ext-data-AbstractStore-method-setProxy", + "shortDoc": "Sets the Store's Proxy by string, config object or Proxy instance
\n" + }, + { + "tagname": "method", + "name": "setRootNode", + "member": "Ext.data.TreeStore", + "doc": "Sets the root node for this store
\n", + "params": [ + { + "type": "Ext.data.Model/Ext.data.NodeInterface", + "name": "root", + "doc": "\n", + "optional": false + } + ], + "return": { + "type": "Ext.data.NodeInterface", + "doc": "The new root
\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/TreeStore.js", + "linenr": 344, + "html_filename": "TreeStore.html", + "href": "TreeStore.html#Ext-data-TreeStore-method-setRootNode", + "shortDoc": "Sets the root node for this store
\n" + }, + { + "tagname": "method", + "name": "sort", + "member": "Ext.util.Sortable", + "doc": "Sorts the data in the Store by one or more of its properties. Example usage:
\n\n\n//sort by a single field\nmyStore.sort('myField', 'DESC');\n\n//sorting by multiple fields\nmyStore.sort([\n {\n property : 'age',\n direction: 'ASC'\n },\n {\n property : 'name',\n direction: 'DESC'\n }\n]);\n
\n\n\nInternally, Store converts the passed arguments into an array of Ext.util.Sorter instances, and delegates the actual\nsorting to its internal Ext.util.MixedCollection.
\n\n\nWhen passing a single string argument to sort, Store maintains a ASC/DESC toggler per field, so this code:
\n\n\nstore.sort('myField');\nstore.sort('myField');\n
\n\n\nIs equivalent to this code, because Store handles the toggling automatically:
\n\n\nstore.sort('myField', 'ASC');\nstore.sort('myField', 'DESC');\n
\n\n",
+ "params": [
+ {
+ "type": "String|Array",
+ "name": "sorters",
+ "doc": "Either a string name of one of the fields in this Store's configured Model,\nor an Array of sorter configurations.
\n", + "optional": false + }, + { + "type": "String", + "name": "direction", + "doc": "The overall direction to sort the data by. Defaults to \"ASC\".
\n", + "optional": false + }, + { + "type": "Object", + "name": "where", + "doc": "\n", + "optional": false + }, + { + "type": "Object", + "name": "doSort", + "doc": "\n", + "optional": false + } + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Sortable.js", + "linenr": 59, + "html_filename": "Sortable.html", + "href": "Sortable.html#Ext-util-Sortable-method-sort", + "shortDoc": "Sorts the data in the Store by one or more of its properties. Example usage:\n\n\n//sort by a single field\nmyStore.sort(..." + }, + { + "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" + }, + "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": "sync", + "member": "Ext.data.AbstractStore", + "doc": "Synchronizes the Store with its Proxy. This asks the Proxy to batch together any new, updated\nand deleted records in the store, updating the Store's internal representation of the records\nas each operation completes.
\n", + "params": [ + + ], + "return": { + "type": "void", + "doc": "\n" + }, + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js", + "linenr": 548, + "html_filename": "AbstractStore.html", + "href": "AbstractStore.html#Ext-data-AbstractStore-method-sync", + "shortDoc": "Synchronizes the Store with its Proxy. This asks the Proxy to batch together any new, updated\nand deleted records in ..." + }, + { + "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 + }, + { + "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 + }, + { + "type": "Object", + "name": "scope", + "doc": "(optional) The scope originally specified for the handler.
\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": "Removes an event handler (shorthand for removeListener.)
\n" + } + ], + "property": [ + { + "tagname": "property", + "name": "batchUpdateMode", + "member": "Ext.data.AbstractStore", + "type": "String", + "doc": "Sets the updating behavior based on batch synchronization. 'operation' (the default) will update the Store's\ninternal representation of the data after each operation of the batch has completed, 'complete' will wait until\nthe entire batch has been completed before updating the Store's data. 'complete' is a good choice for local\nstorage proxies, 'operation' is better for remote proxies, where there is a comparatively high latency.
\n", + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js", + "linenr": 69, + "html_filename": "AbstractStore.html", + "href": "AbstractStore.html#Ext-data-AbstractStore-property-batchUpdateMode", + "shortDoc": "Sets the updating behavior based on batch synchronization. 'operation' (the default) will update the Store's\ninternal..." + }, + { + "tagname": "property", + "name": "defaultProxyType", + "member": "Ext.data.AbstractStore", + "type": "String", + "doc": "The string type of the Proxy to create if none is specified. This defaults to creating a memory proxy.
\n", + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js", + "linenr": 104, + "html_filename": "AbstractStore.html", + "href": "AbstractStore.html#Ext-data-AbstractStore-property-defaultProxyType" + }, + { + "tagname": "property", + "name": "defaultSortDirection", + "member": "Ext.util.Sortable", + "type": "String", + "doc": "The default sort direction to use if one is not specified (defaults to \"ASC\")
\n", + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Sortable.js", + "linenr": 20, + "html_filename": "Sortable.html", + "href": "Sortable.html#Ext-util-Sortable-property-defaultSortDirection" + }, + { + "tagname": "property", + "name": "fields", + "member": "Ext.data.TreeStore", + "type": "Object", + "doc": "If we have no fields declare for the store, add some defaults.\nThese will be ignored if a model is explicitly specified.
\n", + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/TreeStore.js", + "linenr": 62, + "html_filename": "TreeStore.html", + "href": "TreeStore.html#Ext-data-TreeStore-property-fields", + "shortDoc": "If we have no fields declare for the store, add some defaults.\nThese will be ignored if a model is explicitly specifi..." + }, + { + "tagname": "property", + "name": "filterOnLoad", + "member": "Ext.data.AbstractStore", + "type": "Boolean", + "doc": "If true, any filters attached to this Store will be run after loading data, before the datachanged event is fired.\nDefaults to true, ignored if remoteFilter is true
\n", + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js", + "linenr": 79, + "html_filename": "AbstractStore.html", + "href": "AbstractStore.html#Ext-data-AbstractStore-property-filterOnLoad", + "shortDoc": "If true, any filters attached to this Store will be run after loading data, before the datachanged event is fired.\nDe..." + }, + { + "tagname": "property", + "name": "filters", + "member": "Ext.data.AbstractStore", + "type": "Ext.util.MixedCollection", + "doc": "The collection of Filters currently applied to this Store
\n", + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js", + "linenr": 268, + "html_filename": "AbstractStore.html", + "href": "AbstractStore.html#Ext-data-AbstractStore-property-filters" + }, + { + "tagname": "property", + "name": "isDestroyed", + "member": "Ext.data.AbstractStore", + "type": "Boolean", + "doc": "True if the Store has already been destroyed via destroyStore. If this is true, the reference to Store should be deleted\nas it will not function correctly any more.
\n", + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js", + "linenr": 111, + "html_filename": "AbstractStore.html", + "href": "AbstractStore.html#Ext-data-AbstractStore-property-isDestroyed", + "shortDoc": "True if the Store has already been destroyed via destroyStore. If this is true, the reference to Store should be dele..." + }, + { + "tagname": "property", + "name": "isSortable", + "member": "Ext.util.Sortable", + "type": "Boolean", + "doc": "Flag denoting that this object is sortable. Always true.
\n", + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Sortable.js", + "linenr": 13, + "html_filename": "Sortable.html", + "href": "Sortable.html#Ext-util-Sortable-property-isSortable" + }, + { + "tagname": "property", + "name": "sortOnLoad", + "member": "Ext.data.AbstractStore", + "type": "Boolean", + "doc": "If true, any sorters attached to this Store will be run after loading data, before the datachanged event is fired.\nDefaults to true, igored if remoteSort is true
\n", + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js", + "linenr": 87, + "html_filename": "AbstractStore.html", + "href": "AbstractStore.html#Ext-data-AbstractStore-property-sortOnLoad", + "shortDoc": "If true, any sorters attached to this Store will be run after loading data, before the datachanged event is fired.\nDe..." + }, + { + "tagname": "property", + "name": "sortRoot", + "member": "Ext.util.Sortable", + "type": "String", + "doc": "The property in each item that contains the data to sort. (defaults to null)
\n", + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Sortable.js", + "linenr": 31, + "html_filename": "Sortable.html", + "href": "Sortable.html#Ext-util-Sortable-property-sortRoot" + }, + { + "tagname": "property", + "name": "sorters", + "member": "Ext.util.Sortable", + "type": "Ext.util.MixedCollection", + "doc": "The collection of Sorters currently applied to this Store
\n", + "private": false, + "static": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/util/Sortable.js", + "linenr": 45, + "html_filename": "Sortable.html", + "href": "Sortable.html#Ext-util-Sortable-property-sorters" + } + ], + "event": [ + { + "tagname": "event", + "name": "add", + "member": "Ext.data.AbstractStore", + "doc": "Fired when a Model instance has been added to this Store
\n", + "params": [ + { + "type": "Ext.data.Store", + "name": "store", + "doc": "The store
\n", + "optional": false + }, + { + "type": "Array", + "name": "records", + "doc": "The Model instances that were added
\n", + "optional": false + }, + { + "type": "Number", + "name": "index", + "doc": "The index at which the instances were inserted
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js", + "linenr": 143, + "html_filename": "AbstractStore.html", + "href": "AbstractStore.html#Ext-data-AbstractStore-event-add", + "shortDoc": "Fired when a Model instance has been added to this Store
\n" + }, + { + "tagname": "event", + "name": "append", + "member": "Ext.data.TreeStore", + "doc": "Fires when a new child node is appended to a node in this store's tree.
\n", + "params": [ + { + "type": "Tree", + "name": "tree", + "doc": "The owner tree
\n", + "optional": false + }, + { + "type": "Node", + "name": "parent", + "doc": "The parent node
\n", + "optional": false + }, + { + "type": "Node", + "name": "node", + "doc": "The newly appended node
\n", + "optional": false + }, + { + "type": "Number", + "name": "index", + "doc": "The index of the newly appended node
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/TreeStore.js", + "linenr": 94, + "html_filename": "TreeStore.html", + "href": "TreeStore.html#Ext-data-TreeStore-event-append", + "shortDoc": "Fires when a new child node is appended to a node in this store's tree.
\n" + }, + { + "tagname": "event", + "name": "beforeappend", + "member": "Ext.data.TreeStore", + "doc": "Fires before a new child is appended to a node in this store's tree, return false to cancel the append.
\n", + "params": [ + { + "type": "Tree", + "name": "tree", + "doc": "The owner tree
\n", + "optional": false + }, + { + "type": "Node", + "name": "parent", + "doc": "The parent node
\n", + "optional": false + }, + { + "type": "Node", + "name": "node", + "doc": "The child node to be appended
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/TreeStore.js", + "linenr": 134, + "html_filename": "TreeStore.html", + "href": "TreeStore.html#Ext-data-TreeStore-event-beforeappend", + "shortDoc": "Fires before a new child is appended to a node in this store's tree, return false to cancel the append.
\n" + }, + { + "tagname": "event", + "name": "beforecollapse", + "member": "Ext.data.TreeStore", + "doc": "Fires before this node is collapsed.
\n", + "params": [ + { + "type": "Node", + "name": "this", + "doc": "The collapsing node
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/TreeStore.js", + "linenr": 194, + "html_filename": "TreeStore.html", + "href": "TreeStore.html#Ext-data-TreeStore-event-beforecollapse", + "shortDoc": "Fires before this node is collapsed.
\n" + }, + { + "tagname": "event", + "name": "beforeexpand", + "member": "Ext.data.TreeStore", + "doc": "Fires before this node is expanded.
\n", + "params": [ + { + "type": "Node", + "name": "this", + "doc": "The expanding node
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/TreeStore.js", + "linenr": 187, + "html_filename": "TreeStore.html", + "href": "TreeStore.html#Ext-data-TreeStore-event-beforeexpand", + "shortDoc": "Fires before this node is expanded.
\n" + }, + { + "tagname": "event", + "name": "beforeinsert", + "member": "Ext.data.TreeStore", + "doc": "Fires before a new child is inserted in a node in this store's tree, return false to cancel the insert.
\n", + "params": [ + { + "type": "Tree", + "name": "tree", + "doc": "The owner tree
\n", + "optional": false + }, + { + "type": "Node", + "name": "parent", + "doc": "The parent node
\n", + "optional": false + }, + { + "type": "Node", + "name": "node", + "doc": "The child node to be inserted
\n", + "optional": false + }, + { + "type": "Node", + "name": "refNode", + "doc": "The child node the node is being inserted before
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/TreeStore.js", + "linenr": 163, + "html_filename": "TreeStore.html", + "href": "TreeStore.html#Ext-data-TreeStore-event-beforeinsert", + "shortDoc": "Fires before a new child is inserted in a node in this store's tree, return false to cancel the insert.
\n" + }, + { + "tagname": "event", + "name": "beforeload", + "member": "Ext.data.AbstractStore", + "doc": "Event description
\n", + "params": [ + { + "type": "Ext.data.Store", + "name": "store", + "doc": "This Store
\n", + "optional": false + }, + { + "type": "Ext.data.Operation", + "name": "operation", + "doc": "The Ext.data.Operation object that will be passed to the Proxy to load the Store
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js", + "linenr": 183, + "html_filename": "AbstractStore.html", + "href": "AbstractStore.html#Ext-data-AbstractStore-event-beforeload", + "shortDoc": "Event description
\n" + }, + { + "tagname": "event", + "name": "beforemove", + "member": "Ext.data.TreeStore", + "doc": "Fires before a node is moved to a new location in the store's tree. Return false to cancel the move.
\n", + "params": [ + { + "type": "Tree", + "name": "tree", + "doc": "The owner tree
\n", + "optional": false + }, + { + "type": "Node", + "name": "node", + "doc": "The node being moved
\n", + "optional": false + }, + { + "type": "Node", + "name": "oldParent", + "doc": "The parent of the node
\n", + "optional": false + }, + { + "type": "Node", + "name": "newParent", + "doc": "The new parent the node is moving to
\n", + "optional": false + }, + { + "type": "Number", + "name": "index", + "doc": "The index it is being moved to
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/TreeStore.js", + "linenr": 152, + "html_filename": "TreeStore.html", + "href": "TreeStore.html#Ext-data-TreeStore-event-beforemove", + "shortDoc": "Fires before a node is moved to a new location in the store's tree. Return false to cancel the move.
\n" + }, + { + "tagname": "event", + "name": "beforeremove", + "member": "Ext.data.TreeStore", + "doc": "Fires before a child is removed from a node in this store's tree, return false to cancel the remove.
\n", + "params": [ + { + "type": "Tree", + "name": "tree", + "doc": "The owner tree
\n", + "optional": false + }, + { + "type": "Node", + "name": "parent", + "doc": "The parent node
\n", + "optional": false + }, + { + "type": "Node", + "name": "node", + "doc": "The child node to be removed
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/TreeStore.js", + "linenr": 143, + "html_filename": "TreeStore.html", + "href": "TreeStore.html#Ext-data-TreeStore-event-beforeremove", + "shortDoc": "Fires before a child is removed from a node in this store's tree, return false to cancel the remove.
\n" + }, + { + "tagname": "event", + "name": "beforesync", + "member": "Ext.data.AbstractStore", + "doc": "Called before a call to sync is executed. Return false from any listener to cancel the synv
\n", + "params": [ + { + "type": "Object", + "name": "options", + "doc": "Hash of all records to be synchronized, broken down into create, update and destroy
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js", + "linenr": 200, + "html_filename": "AbstractStore.html", + "href": "AbstractStore.html#Ext-data-AbstractStore-event-beforesync", + "shortDoc": "Called before a call to sync is executed. Return false from any listener to cancel the synv
\n" + }, + { + "tagname": "event", + "name": "clear", + "member": "Ext.data.AbstractStore", + "doc": "Fired after the removeAll method is called.
\n", + "params": [ + { + "type": "Ext.data.Store", + "name": "this", + "doc": "\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js", + "linenr": 206, + "html_filename": "AbstractStore.html", + "href": "AbstractStore.html#Ext-data-AbstractStore-event-clear", + "shortDoc": "Fired after the removeAll method is called.
\n" + }, + { + "tagname": "event", + "name": "collapse", + "member": "Ext.data.TreeStore", + "doc": "Fires when this node is collapsed.
\n", + "params": [ + { + "type": "Node", + "name": "this", + "doc": "The collapsing node
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/TreeStore.js", + "linenr": 180, + "html_filename": "TreeStore.html", + "href": "TreeStore.html#Ext-data-TreeStore-event-collapse", + "shortDoc": "Fires when this node is collapsed.
\n" + }, + { + "tagname": "event", + "name": "datachanged", + "member": "Ext.data.AbstractStore", + "doc": "Fires whenever the records in the Store have changed in some way - this could include adding or removing records,\nor updating the data in existing records
\n", + "params": [ + { + "type": "Ext.data.Store", + "name": "this", + "doc": "The data store
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js", + "linenr": 175, + "html_filename": "AbstractStore.html", + "href": "AbstractStore.html#Ext-data-AbstractStore-event-datachanged", + "shortDoc": "Fires whenever the records in the Store have changed in some way - this could include adding or removing records,\nor ..." + }, + { + "tagname": "event", + "name": "expand", + "member": "Ext.data.TreeStore", + "doc": "Fires when this node is expanded.
\n", + "params": [ + { + "type": "Node", + "name": "this", + "doc": "The expanding node
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/TreeStore.js", + "linenr": 173, + "html_filename": "TreeStore.html", + "href": "TreeStore.html#Ext-data-TreeStore-event-expand", + "shortDoc": "Fires when this node is expanded.
\n" + }, + { + "tagname": "event", + "name": "insert", + "member": "Ext.data.TreeStore", + "doc": "Fires when a new child node is inserted in a node in this store's tree.
\n", + "params": [ + { + "type": "Tree", + "name": "tree", + "doc": "The owner tree
\n", + "optional": false + }, + { + "type": "Node", + "name": "parent", + "doc": "The parent node
\n", + "optional": false + }, + { + "type": "Node", + "name": "node", + "doc": "The child node inserted
\n", + "optional": false + }, + { + "type": "Node", + "name": "refNode", + "doc": "The child node the node was inserted before
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/TreeStore.js", + "linenr": 124, + "html_filename": "TreeStore.html", + "href": "TreeStore.html#Ext-data-TreeStore-event-insert", + "shortDoc": "Fires when a new child node is inserted in a node in this store's tree.
\n" + }, + { + "tagname": "event", + "name": "load", + "member": "Ext.data.AbstractStore", + "doc": "Fires whenever the store reads data from a remote data source.
\n", + "params": [ + { + "type": "Ext.data.Store", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "Array", + "name": "records", + "doc": "An array of records
\n", + "optional": false + }, + { + "type": "Boolean", + "name": "successful", + "doc": "True if the operation was successful.
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js", + "linenr": 191, + "html_filename": "AbstractStore.html", + "href": "AbstractStore.html#Ext-data-AbstractStore-event-load", + "shortDoc": "Fires whenever the store reads data from a remote data source.
\n" + }, + { + "tagname": "event", + "name": "move", + "member": "Ext.data.TreeStore", + "doc": "Fires when a node is moved to a new location in the store's tree
\n", + "params": [ + { + "type": "Tree", + "name": "tree", + "doc": "The owner tree
\n", + "optional": false + }, + { + "type": "Node", + "name": "node", + "doc": "The node moved
\n", + "optional": false + }, + { + "type": "Node", + "name": "oldParent", + "doc": "The old parent of this node
\n", + "optional": false + }, + { + "type": "Node", + "name": "newParent", + "doc": "The new parent of this node
\n", + "optional": false + }, + { + "type": "Number", + "name": "index", + "doc": "The index it was moved to
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/TreeStore.js", + "linenr": 113, + "html_filename": "TreeStore.html", + "href": "TreeStore.html#Ext-data-TreeStore-event-move", + "shortDoc": "Fires when a node is moved to a new location in the store's tree
\n" + }, + { + "tagname": "event", + "name": "remove", + "member": "Ext.data.TreeStore", + "doc": "Fires when a child node is removed from a node in this store's tree.
\n", + "params": [ + { + "type": "Tree", + "name": "tree", + "doc": "The owner tree
\n", + "optional": false + }, + { + "type": "Node", + "name": "parent", + "doc": "The parent node
\n", + "optional": false + }, + { + "type": "Node", + "name": "node", + "doc": "The child node removed
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/TreeStore.js", + "linenr": 104, + "html_filename": "TreeStore.html", + "href": "TreeStore.html#Ext-data-TreeStore-event-remove", + "shortDoc": "Fires when a child node is removed from a node in this store's tree.
\n" + }, + { + "tagname": "event", + "name": "rootchange", + "member": "Ext.data.TreeStore", + "doc": "Fires when the root node on this TreeStore is changed.
\n", + "params": [ + { + "type": "Ext.data.TreeStore", + "name": "store", + "doc": "This TreeStore
\n", + "optional": false + }, + { + "type": "Node", + "name": "The", + "doc": "new root node.
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/TreeStore.js", + "linenr": 217, + "html_filename": "TreeStore.html", + "href": "TreeStore.html#Ext-data-TreeStore-event-rootchange", + "shortDoc": "Fires when the root node on this TreeStore is changed.
\n" + }, + { + "tagname": "event", + "name": "sort", + "member": "Ext.data.TreeStore", + "doc": "Fires when this TreeStore is sorted.
\n", + "params": [ + { + "type": "Node", + "name": "node", + "doc": "The node that is sorted.
\n", + "optional": false + } + ], + "private": false, + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/TreeStore.js", + "linenr": 201, + "html_filename": "TreeStore.html", + "href": "TreeStore.html#Ext-data-TreeStore-event-sort", + "shortDoc": "Fires when this TreeStore is sorted.
\n" + }, + { + "tagname": "event", + "name": "update", + "member": "Ext.data.AbstractStore", + "doc": "Fires when a Record has been updated
\n", + "params": [ + { + "type": "Store", + "name": "this", + "doc": "\n", + "optional": false + }, + { + "type": "Ext.data.Model", + "name": "record", + "doc": "The Model instance that was updated
\n", + "optional": false + }, + { + "type": "String", + "name": "operation", + "doc": "The update operation being performed. Value may be one of:
\n\n Ext.data.Model.EDIT\n Ext.data.Model.REJECT\n Ext.data.Model.COMMIT\n
\n\n",
+ "optional": false
+ }
+ ],
+ "private": false,
+ "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/AbstractStore.js",
+ "linenr": 161,
+ "html_filename": "AbstractStore.html",
+ "href": "AbstractStore.html#Ext-data-AbstractStore-event-update",
+ "shortDoc": "Fires when a Record has been updated
\n" + } + ], + "filename": "/Users/nick/Projects/sencha/SDK/platform/src/data/TreeStore.js", + "linenr": 1, + "html_filename": "TreeStore.html", + "href": "TreeStore.html#Ext-data-TreeStore", + "cssVar": [ + + ], + "cssMixin": [ + + ], + "component": false, + "superclasses": [ + "Ext.data.AbstractStore" + ], + "subclasses": [ + + ], + "mixedInto": [ + + ], + "allMixins": [ + "Ext.util.Observable", + "Ext.util.Sortable" + ] +}); \ No newline at end of file