X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/6746dc89c47ed01b165cc1152533605f97eb8e8d..HEAD:/docs/output/Ext.data.TreeStore.js?ds=inline diff --git a/docs/output/Ext.data.TreeStore.js b/docs/output/Ext.data.TreeStore.js index d8de757c..24ca65cb 100644 --- a/docs/output/Ext.data.TreeStore.js +++ b/docs/output/Ext.data.TreeStore.js @@ -1,2664 +1 @@ -Ext.data.JsonP.Ext_data_TreeStore({ - "allMixins": [ - "Ext.util.Observable", - "Ext.util.Sortable" - ], - "deprecated": null, - "docauthor": null, - "members": { - "cfg": [ - { - "type": "Boolean/Object", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "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...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js", - "private": false, - "name": "autoLoad", - "owner": "Ext.data.AbstractStore", - "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", - "linenr": 54, - "html_filename": "AbstractStore.html" - }, - { - "type": "Boolean", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "AbstractStore.html#Ext-data-AbstractStore-cfg-autoSync", - "shortDoc": "True to automatically sync the Store with its Proxy after every edit to one of its Records. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js", - "private": false, - "name": "autoSync", - "owner": "Ext.data.AbstractStore", - "doc": "True to automatically sync the Store with its Proxy after every edit to one of its Records.\nDefaults to false.
\n", - "linenr": 61, - "html_filename": "AbstractStore.html" - }, - { - "type": "Boolean", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "TreeStore.html#Ext-data-TreeStore-cfg-clearOnLoad", - "shortDoc": "Remove previously existing child nodes before loading. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/TreeStore.js", - "private": false, - "name": "clearOnLoad", - "owner": "Ext.data.TreeStore", - "doc": "Remove previously existing child nodes before loading. Default to true.
\n", - "linenr": 42, - "html_filename": "TreeStore.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "TreeStore.html#Ext-data-TreeStore-cfg-defaultRootId", - "shortDoc": "The default root id. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/TreeStore.js", - "private": false, - "name": "defaultRootId", - "owner": "Ext.data.TreeStore", - "doc": "The default root id. Defaults to 'root'
\n", - "linenr": 55, - "html_filename": "TreeStore.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "TreeStore.html#Ext-data-TreeStore-cfg-defaultRootProperty", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/TreeStore.js", - "private": false, - "name": "defaultRootProperty", - "owner": "Ext.data.TreeStore", - "doc": "The root property to specify on the reader if one is not explicitly defined.
\n", - "linenr": 61, - "html_filename": "TreeStore.html" - }, - { - "type": "Array", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "AbstractStore.html#Ext-data-AbstractStore-cfg-fields", - "shortDoc": "This may be used in place of specifying a model configuration. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js", - "private": false, - "name": "fields", - "owner": "Ext.data.AbstractStore", - "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", - "linenr": 124, - "html_filename": "AbstractStore.html" - }, - { - "type": "Boolean", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "TreeStore.html#Ext-data-TreeStore-cfg-folderSort", - "shortDoc": "Set to true to automatically prepend a leaf sorter. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/TreeStore.js", - "private": false, - "name": "folderSort", - "owner": "Ext.data.TreeStore", - "doc": "Set to true to automatically prepend a leaf sorter. Defaults to undefined
.
A config object containing one or more event handlers to be added to this object during initialization. This\nshould be a valid listeners config object as specified in the addListener example for attaching multiple\nhandlers at once.
\n\nDOM events from ExtJS Components
\n\nWhile some ExtJs Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this is usually\nonly done when extra value can be added. For example the DataView's itemclick
event passing the node clicked on. To access DOM events directly from a\nchild element of a Component, we need to specify the element
option to identify the Component property to add a\nDOM listener to:
new Ext.panel.Panel({\n width: 400,\n height: 200,\n dockedItems: [{\n xtype: 'toolbar'\n }],\n listeners: {\n click: {\n element: 'el', //bind to the underlying el property on the panel\n fn: function(){ console.log('click el'); }\n },\n dblclick: {\n element: 'body', //bind to the underlying body property on the panel\n fn: function(){ console.log('dblclick body'); }\n }\n }\n});\n
\n",
- "linenr": 102,
- "html_filename": "Observable.html"
- },
- {
- "type": "String",
- "deprecated": null,
- "alias": null,
- "protected": false,
- "tagname": "cfg",
- "href": "TreeStore.html#Ext-data-TreeStore-cfg-nodeParam",
- "shortDoc": "The name of the parameter sent to the server which contains the identifier of the node. ...",
- "static": false,
- "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/TreeStore.js",
- "private": false,
- "name": "nodeParam",
- "owner": "Ext.data.TreeStore",
- "doc": "The name of the parameter sent to the server which contains the identifier of the node.\nDefaults to 'node'.
\n", - "linenr": 48, - "html_filename": "TreeStore.html" - }, - { - "type": "String/Ext.data.proxy.Proxy/Object", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "AbstractStore.html#Ext-data-AbstractStore-cfg-proxy", - "shortDoc": "The Proxy to use for this Store. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js", - "private": false, - "name": "proxy", - "owner": "Ext.data.AbstractStore", - "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", - "linenr": 49, - "html_filename": "AbstractStore.html" - }, - { - "type": "Ext.data.Model/Ext.data.NodeInterface/Object", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "cfg", - "href": "TreeStore.html#Ext-data-TreeStore-cfg-root", - "shortDoc": "The root node for this store. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/TreeStore.js", - "private": false, - "name": "root", - "owner": "Ext.data.TreeStore", - "doc": "The root node for this store. For example:
\n\nroot: {\n expanded: true, \n text: \"My Root\",\n children: [\n { text: \"Child 1\", leaf: true },\n { text: \"Child 2\", expanded: true, children: [\n { text: \"GrandChild\", leaf: true }\n ] }\n ]\n}\n
\n\nSetting the root
config option is the same as calling setRootNode.
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", - "linenr": 119, - "html_filename": "AbstractStore.html" - } - ], - "method": [ - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-addEvents", - "shortDoc": "Adds the specified events to the list of events which this Observable may fire. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "Object/String", - "optional": false, - "doc": "Either an object with event names as properties with a value of true
or the first\nevent name string if multiple event names are being passed as separate parameters. Usage:
this.addEvents({\n storeloaded: true,\n storecleared: true\n});\n
\n",
- "name": "o"
- },
- {
- "type": "String...",
- "optional": false,
- "doc": "Optional additional event names if multiple event names are being passed as separate\nparameters. Usage:
\n\nthis.addEvents('storeloaded', 'storecleared');\n
\n",
- "name": "more"
- }
- ],
- "name": "addEvents",
- "owner": "Ext.util.Observable",
- "doc": "Adds the specified events to the list of events which this Observable may fire.
\n", - "linenr": 494, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-addListener", - "shortDoc": "Appends an event handler to this object. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "The name of the event to listen for. May also be an object who's property names are\nevent names.
\n", - "name": "eventName" - }, - { - "type": "Function", - "optional": false, - "doc": "The method the event invokes. Will be called with arguments given to\nfireEvent plus the options
parameter described below.
(optional) The scope (this
reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.
(optional) An object containing handler configuration.
\n\nNote: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.
\n\nThis object may contain any of the following properties:
\n\nscope : Object
\n\nThe scope (this
reference) in which the handler function is executed. If omitted, defaults to the object\nwhich fired the event.
delay : Number
\n\nThe number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
\n\nTrue to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
\n\nCauses the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is not invoked, but the new\nhandler is scheduled in its place.
target : Observable
\n\nOnly call the handler if the event was fired on the target Observable, not if the event was bubbled up from a\nchild Observable.
element : String
\n\nThis option is only valid for listeners bound to Components. The name of a Component\nproperty which references an element to add a listener to.
\n\nThis option is useful during Component construction to add DOM event listeners to elements of\nComponents which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:
\n\nnew Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n
Combining Options
\n\nUsing the options argument, it is possible to combine different types of listeners:
\n\nA delayed, one-time listener.
\n\nmyPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\n
\n\nAttaching multiple handlers in 1 call
\n\nThe method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:
\n\nmyGridPanel.on({\n cellClick: this.onCellClick,\n mouseover: this.onMouseOver,\n mouseout: this.onMouseOut,\n scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n
\n\nOne can also specify options for each event handler separately:
\n\nmyGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n
\n",
- "name": "options"
- }
- ],
- "name": "addListener",
- "owner": "Ext.util.Observable",
- "doc": "Appends an event handler to this object.
\n", - "linenr": 278, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-addManagedListener", - "shortDoc": "Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "Observable/Element", - "optional": false, - "doc": "The item to which to add a listener/listeners.
\n", - "name": "item" - }, - { - "type": "Object/String", - "optional": false, - "doc": "The event name, or an object containing event name properties.
\n", - "name": "ename" - }, - { - "type": "Function", - "optional": true, - "doc": "(optional) If the ename
parameter was an event name, this is the handler function.
(optional) If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
(optional) If the ename
parameter was an event name, this is the\naddListener options.
Adds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed.
\n", - "linenr": 156, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Base3.html#Ext-Base-method-addStatics", - "shortDoc": "Add / override static properties of this class. ...", - "static": true, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "members" - } - ], - "name": "addStatics", - "owner": "Ext.Base", - "doc": "Add / override static properties of this class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.addStatics({\n someProperty: 'someValue', // My.cool.Class.someProperty = 'someValue'\n method1: function() { ... }, // My.cool.Class.method1 = function() { ... };\n method2: function() { ... } // My.cool.Class.method2 = function() { ... };\n});\n
\n",
- "linenr": 388,
- "return": {
- "type": "Ext.Base",
- "doc": "this
\n" - }, - "html_filename": "Base3.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Base3.html#Ext-Base-method-callOverridden", - "shortDoc": "Call the original method that was previously overridden with Ext.Base.override\n\nExt.define('My.Cat', {\n constructo...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "params": [ - { - "type": "Array/Arguments", - "optional": false, - "doc": "The arguments, either an array or the arguments
object
Call the original method that was previously overridden with Ext.Base.override
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\n
\n",
- "linenr": 269,
- "return": {
- "type": "Mixed",
- "doc": "Returns the result after calling the overridden method
\n" - }, - "html_filename": "Base3.html" - }, - { - "deprecated": null, - "alias": null, - "protected": true, - "tagname": "method", - "href": "Base3.html#Ext-Base-method-callParent", - "shortDoc": "Call the parent's overridden method. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "params": [ - { - "type": "Array/Arguments", - "optional": false, - "doc": "The arguments, either an array or the arguments
object\nfrom the current method, for example: this.callParent(arguments)
Call the parent's overridden method. For example:
\n\nExt.define('My.own.A', {\n constructor: function(test) {\n alert(test);\n }\n});\n\nExt.define('My.own.B', {\n extend: 'My.own.A',\n\n constructor: function(test) {\n alert(test);\n\n this.callParent([test + 1]);\n }\n});\n\nExt.define('My.own.C', {\n extend: 'My.own.B',\n\n constructor: function() {\n alert(\"Going to call parent's overriden constructor...\");\n\n this.callParent(arguments);\n }\n});\n\nvar a = new My.own.A(1); // alerts '1'\nvar b = new My.own.B(1); // alerts '1', then alerts '2'\nvar c = new My.own.C(2); // alerts \"Going to call parent's overriden constructor...\"\n // alerts '2', then alerts '3'\n
\n",
- "linenr": 124,
- "return": {
- "type": "Mixed",
- "doc": "Returns the result from the superclass' method
\n" - }, - "html_filename": "Base3.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-capture", - "shortDoc": "Starts capture on the specified Observable. ...", - "static": true, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "Observable", - "optional": false, - "doc": "The Observable to capture events from.
\n", - "name": "o" - }, - { - "type": "Function", - "optional": false, - "doc": "The function to call when an event is fired.
\n", - "name": "fn" - }, - { - "type": "Object", - "optional": true, - "doc": "(optional) The scope (this
reference) in which the function is executed. Defaults to\nthe Observable firing the event.
Starts capture on the specified Observable. All events will be passed to the supplied function with the event\nname + standard signature of the event before the event is fired. If the supplied function returns false,\nthe event will not fire.
\n", - "linenr": 54, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-clearListeners", - "shortDoc": "Removes all listeners for this object including the managed listeners ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - - ], - "name": "clearListeners", - "owner": "Ext.util.Observable", - "doc": "Removes all listeners for this object including the managed listeners
\n", - "linenr": 425, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-clearManagedListeners", - "shortDoc": "Removes all managed listeners for this object. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - - ], - "name": "clearManagedListeners", - "owner": "Ext.util.Observable", - "doc": "Removes all managed listeners for this object.
\n", - "linenr": 454, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Base3.html#Ext-Base-method-create", - "shortDoc": "Create a new instance of this Class. ...", - "static": true, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "params": [ - - ], - "name": "create", - "owner": "Ext.Base", - "doc": "Create a new instance of this Class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.create({\n someConfig: true\n});\n
\n\nAll parameters are passed to the constructor of the class.
\n", - "linenr": 329, - "return": { - "type": "Object", - "doc": "the created instance.
\n" - }, - "html_filename": "Base3.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Base3.html#Ext-Base-method-createAlias", - "shortDoc": "Create aliases for existing prototype methods. ...", - "static": true, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "params": [ - { - "type": "String/Object", - "optional": false, - "doc": "The new method name, or an object to set multiple aliases. See\nflexSetter
\n", - "name": "alias" - }, - { - "type": "String/Object", - "optional": false, - "doc": "The original method name
\n", - "name": "origin" - } - ], - "name": "createAlias", - "owner": "Ext.Base", - "doc": "Create aliases for existing prototype methods. Example:
\n\nExt.define('My.cool.Class', {\n method1: function() { ... },\n method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n method3: 'method1',\n method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -> test.method1()\n
\n",
- "linenr": 648,
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "html_filename": "Base3.html"
- },
- {
- "deprecated": null,
- "alias": null,
- "protected": false,
- "tagname": "method",
- "href": "Observable.html#Ext-util-Observable-method-enableBubble",
- "shortDoc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if\npresent. ...",
- "static": false,
- "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
- "private": false,
- "params": [
- {
- "type": "String/[String]",
- "optional": false,
- "doc": "The event name to bubble, or an Array of event names.
\n", - "name": "events" - } - ], - "name": "enableBubble", - "owner": "Ext.util.Observable", - "doc": "Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget()
if\npresent. There is no implementation in the Observable base class.
This is commonly used by Ext.Components to bubble events to owner Containers.\nSee Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the\nComponent's immediate owner. But if a known target is required, this can be overridden to access the\nrequired target more quickly.
\n\nExample:
\n\nExt.override(Ext.form.field.Base, {\n // Add functionality to Field's initComponent to enable the change event to bubble\n initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n this.enableBubble('change');\n }),\n\n // We know that we want Field's events to bubble directly to the FormPanel.\n getBubbleTarget : function() {\n if (!this.formPanel) {\n this.formPanel = this.findParentByType('form');\n }\n return this.formPanel;\n }\n});\n\nvar myForm = new Ext.formPanel({\n title: 'User Details',\n items: [{\n ...\n }],\n listeners: {\n change: function() {\n // Title goes red if form has been modified.\n myForm.header.setStyle('color', 'red');\n }\n }\n});\n
\n",
- "linenr": 609,
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "html_filename": "Observable.html"
- },
- {
- "deprecated": null,
- "alias": null,
- "protected": false,
- "tagname": "method",
- "href": "Observable.html#Ext-util-Observable-method-fireEvent",
- "shortDoc": "Fires the specified event with the passed parameters (minus the event name, plus the options object passed\nto addList...",
- "static": false,
- "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
- "private": false,
- "params": [
- {
- "type": "String",
- "optional": false,
- "doc": "The name of the event to fire.
\n", - "name": "eventName" - }, - { - "type": "Object...", - "optional": false, - "doc": "Variable number of parameters are passed to handlers.
\n", - "name": "args" - } - ], - "name": "fireEvent", - "owner": "Ext.util.Observable", - "doc": "Fires the specified event with the passed parameters (minus the event name, plus the options
object passed\nto addListener).
An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by\ncalling enableBubble.
\n", - "linenr": 233, - "return": { - "type": "Boolean", - "doc": "returns false if any of the handlers return false otherwise it returns true.
\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Base3.html#Ext-Base-method-getName", - "shortDoc": "Get the current class' name in string format. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "params": [ - - ], - "name": "getName", - "owner": "Ext.Base", - "doc": "Get the current class' name in string format.
\n\nExt.define('My.cool.Class', {\n constructor: function() {\n alert(this.self.getName()); // alerts 'My.cool.Class'\n }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n
\n",
- "linenr": 631,
- "return": {
- "type": "String",
- "doc": "className
\n" - }, - "html_filename": "Base3.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractStore.html#Ext-data-AbstractStore-method-getNewRecords", - "shortDoc": "Returns all Model instances that are either currently a phantom (e.g. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js", - "private": false, - "params": [ - - ], - "name": "getNewRecords", - "owner": "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", - "linenr": 450, - "return": { - "type": "Array", - "doc": "The Model instances
\n" - }, - "html_filename": "AbstractStore.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "TreeStore.html#Ext-data-TreeStore-method-getNodeById", - "shortDoc": "Returns the record node by id ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/TreeStore.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "id" - } - ], - "name": "getNodeById", - "owner": "Ext.data.TreeStore", - "doc": "Returns the record node by id
\n", - "linenr": 409, - "return": { - "type": "Ext.data.NodeInterface", - "doc": "\n" - }, - "html_filename": "TreeStore.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractStore.html#Ext-data-AbstractStore-method-getProxy", - "shortDoc": "Returns the proxy currently attached to this proxy instance ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js", - "private": false, - "params": [ - - ], - "name": "getProxy", - "owner": "Ext.data.AbstractStore", - "doc": "Returns the proxy currently attached to this proxy instance
\n", - "linenr": 305, - "return": { - "type": "Ext.data.proxy.Proxy", - "doc": "The Proxy instance
\n" - }, - "html_filename": "AbstractStore.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "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. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js", - "private": false, - "params": [ - - ], - "name": "getRemovedRecords", - "owner": "Ext.data.AbstractStore", - "doc": "Returns any records that have been removed from the store but not yet destroyed on the proxy.
\n", - "linenr": 476, - "return": { - "type": "Array", - "doc": "The removed Model instances
\n" - }, - "html_filename": "AbstractStore.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "TreeStore.html#Ext-data-TreeStore-method-getRootNode", - "shortDoc": "Returns the root node for this tree. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/TreeStore.js", - "private": false, - "params": [ - - ], - "name": "getRootNode", - "owner": "Ext.data.TreeStore", - "doc": "Returns the root node for this tree.
\n", - "linenr": 401, - "return": { - "type": "Ext.data.NodeInterface", - "doc": "\n" - }, - "html_filename": "TreeStore.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "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 ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js", - "private": false, - "params": [ - - ], - "name": "getUpdatedRecords", - "owner": "Ext.data.AbstractStore", - "doc": "Returns all Model instances that have been updated in the Store but not yet synchronized with the Proxy
\n", - "linenr": 459, - "return": { - "type": "Array", - "doc": "The updated Model instances
\n" - }, - "html_filename": "AbstractStore.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-hasListener", - "shortDoc": "Checks to see if this object has any listeners for a specified event ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "The name of the event to check for
\n", - "name": "eventName" - } - ], - "name": "hasListener", - "owner": "Ext.util.Observable", - "doc": "Checks to see if this object has any listeners for a specified event
\n", - "linenr": 530, - "return": { - "type": "Boolean", - "doc": "True if the event is being listened for, else false
\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Base3.html#Ext-Base-method-implement", - "shortDoc": "Add methods / properties to the prototype of this class. ...", - "static": true, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "members" - } - ], - "name": "implement", - "owner": "Ext.Base", - "doc": "Add methods / properties to the prototype of this class.
\n\nExt.define('My.awesome.Cat', {\n constructor: function() {\n ...\n }\n});\n\n My.awesome.Cat.implement({\n meow: function() {\n alert('Meowww...');\n }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n
\n",
- "linenr": 415,
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "html_filename": "Base3.html"
- },
- {
- "deprecated": null,
- "alias": null,
- "protected": true,
- "tagname": "method",
- "href": "Base3.html#Ext-Base-method-initConfig",
- "shortDoc": "Initialize configuration for this class. ...",
- "static": false,
- "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
- "private": false,
- "params": [
- {
- "type": "Object",
- "optional": false,
- "doc": "\n",
- "name": "config"
- }
- ],
- "name": "initConfig",
- "owner": "Ext.Base",
- "doc": "Initialize configuration for this class. a typical example:
\n\nExt.define('My.awesome.Class', {\n // The default config\n config: {\n name: 'Awesome',\n isAwesome: true\n },\n\n constructor: function(config) {\n this.initConfig(config);\n\n return this;\n }\n});\n\nvar awesome = new My.awesome.Class({\n name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n
\n",
- "linenr": 63,
- "return": {
- "type": "Object",
- "doc": "mixins The mixin prototypes as key - value pairs
\n" - }, - "html_filename": "Base3.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Sortable.html#Ext-util-Sortable-method-initSortable", - "shortDoc": "Performs initialization of this mixin. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Sortable.js", - "private": false, - "params": [ - - ], - "name": "initSortable", - "owner": "Ext.util.Sortable", - "doc": "Performs initialization of this mixin. Component classes using this mixin should call this method\nduring their own initialization.
\n", - "linenr": 36, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Sortable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractStore.html#Ext-data-AbstractStore-method-isLoading", - "shortDoc": "Returns true if the Store is currently performing a load operation ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js", - "private": false, - "params": [ - - ], - "name": "isLoading", - "owner": "Ext.data.AbstractStore", - "doc": "Returns true if the Store is currently performing a load operation
\n", - "linenr": 715, - "return": { - "type": "Boolean", - "doc": "True if the Store is currently loading
\n" - }, - "html_filename": "AbstractStore.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "TreeStore.html#Ext-data-TreeStore-method-load", - "shortDoc": "Loads the Store using its configured proxy. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/TreeStore.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "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", - "name": "options" - } - ], - "name": "load", - "owner": "Ext.data.TreeStore", - "doc": "Loads the Store using its configured proxy.
\n", - "linenr": 417, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "TreeStore.html" - }, - { - "deprecated": null, - "alias": { - "tagname": "alias", - "cls": "Ext.util.Observable", - "doc": null, - "owner": "addManagedListener" - }, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-mon", - "shortDoc": "Shorthand for addManagedListener. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "Observable/Element", - "optional": false, - "doc": "The item to which to add a listener/listeners.
\n", - "name": "item" - }, - { - "type": "Object/String", - "optional": false, - "doc": "The event name, or an object containing event name properties.
\n", - "name": "ename" - }, - { - "type": "Function", - "optional": true, - "doc": "(optional) If the ename
parameter was an event name, this is the handler function.
(optional) If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
(optional) If the ename
parameter was an event name, this is the\naddListener options.
Shorthand for addManagedListener.
\n\nAdds listeners to any Observable object (or Element) which are automatically removed when this Component is\ndestroyed.
\n", - "linenr": 681, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": { - "tagname": "alias", - "cls": "Ext.util.Observable", - "doc": null, - "owner": "removeManagedListener" - }, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-mun", - "shortDoc": "Shorthand for removeManagedListener. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "Observable|Element", - "optional": false, - "doc": "The item from which to remove a listener/listeners.
\n", - "name": "item" - }, - { - "type": "Object|String", - "optional": false, - "doc": "The event name, or an object containing event name properties.
\n", - "name": "ename" - }, - { - "type": "Function", - "optional": false, - "doc": "Optional. If the ename
parameter was an event name, this is the handler function.
Optional. If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
Shorthand for removeManagedListener.
\n\nRemoves listeners that were added by the mon method.
\n", - "linenr": 687, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-observe", - "shortDoc": "Sets observability on the passed class constructor. ...", - "static": true, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "Function", - "optional": false, - "doc": "The class constructor to make observable.
\n", - "name": "c" - }, - { - "type": "Object", - "optional": false, - "doc": "An object containing a series of listeners to add. See addListener.
\n", - "name": "listeners" - } - ], - "name": "observe", - "owner": "Ext.util.Observable", - "doc": "Sets observability on the passed class constructor.
\n\nThis makes any event fired on any instance of the passed class also fire a single event through\nthe class allowing for central handling of events on many instances at once.
\n\nUsage:
\n\nExt.util.Observable.observe(Ext.data.Connection);\nExt.data.Connection.on('beforerequest', function(con, options) {\n console.log('Ajax request made to ' + options.url);\n});\n
\n",
- "linenr": 69,
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "html_filename": "Observable.html"
- },
- {
- "deprecated": null,
- "alias": {
- "tagname": "alias",
- "cls": "Ext.util.Observable",
- "doc": null,
- "owner": "addListener"
- },
- "protected": false,
- "tagname": "method",
- "href": "Observable.html#Ext-util-Observable-method-on",
- "shortDoc": "Shorthand for addListener. ...",
- "static": false,
- "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
- "private": false,
- "params": [
- {
- "type": "String",
- "optional": false,
- "doc": "The name of the event to listen for. May also be an object who's property names are\nevent names.
\n", - "name": "eventName" - }, - { - "type": "Function", - "optional": false, - "doc": "The method the event invokes. Will be called with arguments given to\nfireEvent plus the options
parameter described below.
(optional) The scope (this
reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.
(optional) An object containing handler configuration.
\n\nNote: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.
\n\nThis object may contain any of the following properties:
\n\nscope : Object
\n\nThe scope (this
reference) in which the handler function is executed. If omitted, defaults to the object\nwhich fired the event.
delay : Number
\n\nThe number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
\n\nTrue to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
\n\nCauses the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is not invoked, but the new\nhandler is scheduled in its place.
target : Observable
\n\nOnly call the handler if the event was fired on the target Observable, not if the event was bubbled up from a\nchild Observable.
element : String
\n\nThis option is only valid for listeners bound to Components. The name of a Component\nproperty which references an element to add a listener to.
\n\nThis option is useful during Component construction to add DOM event listeners to elements of\nComponents which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:
\n\nnew Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n
Combining Options
\n\nUsing the options argument, it is possible to combine different types of listeners:
\n\nA delayed, one-time listener.
\n\nmyPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\n
\n\nAttaching multiple handlers in 1 call
\n\nThe method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:
\n\nmyGridPanel.on({\n cellClick: this.onCellClick,\n mouseover: this.onMouseOver,\n mouseout: this.onMouseOut,\n scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n
\n\nOne can also specify options for each event handler separately:
\n\nmyGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n
\n",
- "name": "options"
- }
- ],
- "name": "on",
- "owner": "Ext.util.Observable",
- "doc": "Shorthand for addListener.
\n\nAppends an event handler to this object.
\n", - "linenr": 669, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Base3.html#Ext-Base-method-override", - "shortDoc": "Override prototype members of this class. ...", - "static": true, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "members" - } - ], - "name": "override", - "owner": "Ext.Base", - "doc": "Override prototype members of this class. Overridden methods can be invoked via\nExt.Base.callOverridden
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\n
\n",
- "linenr": 518,
- "return": {
- "type": "Ext.Base",
- "doc": "this
\n" - }, - "html_filename": "Base3.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-relayEvents", - "shortDoc": "Relays selected events from the specified Observable as if the events were fired by this. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "The Observable whose events this object is to relay.
\n", - "name": "origin" - }, - { - "type": "[String]", - "optional": false, - "doc": "Array of event names to relay.
\n", - "name": "events" - }, - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "prefix" - } - ], - "name": "relayEvents", - "owner": "Ext.util.Observable", - "doc": "Relays selected events from the specified Observable as if the events were fired by this
.
The Observable to release
\n", - "name": "o" - } - ], - "name": "releaseCapture", - "owner": "Ext.util.Observable", - "doc": "Removes all added captures from the Observable.
\n", - "linenr": 44, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractStore.html#Ext-data-AbstractStore-method-removeAll", - "shortDoc": "Removes all records from the store. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js", - "private": false, - "params": [ - - ], - "name": "removeAll", - "owner": "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", - "linenr": 705, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractStore.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-removeListener", - "shortDoc": "Removes an event handler. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "The type of event the handler was associated with.
\n", - "name": "eventName" - }, - { - "type": "Function", - "optional": false, - "doc": "The handler to remove. This must be a reference to the function passed into the\naddListener call.
\n", - "name": "handler" - }, - { - "type": "Object", - "optional": true, - "doc": "(optional) The scope originally specified for the handler.
\n", - "name": "scope" - } - ], - "name": "removeListener", - "owner": "Ext.util.Observable", - "doc": "Removes an event handler.
\n", - "linenr": 392, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-removeManagedListener", - "shortDoc": "Removes listeners that were added by the mon method. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "Observable|Element", - "optional": false, - "doc": "The item from which to remove a listener/listeners.
\n", - "name": "item" - }, - { - "type": "Object|String", - "optional": false, - "doc": "The event name, or an object containing event name properties.
\n", - "name": "ename" - }, - { - "type": "Function", - "optional": false, - "doc": "Optional. If the ename
parameter was an event name, this is the handler function.
Optional. If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
Removes listeners that were added by the mon method.
\n", - "linenr": 197, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-resumeEvents", - "shortDoc": "Resumes firing events (see suspendEvents). ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - - ], - "name": "resumeEvents", - "owner": "Ext.util.Observable", - "doc": "Resumes firing events (see suspendEvents).
\n\nIf events were suspended using the **queueSuspended**
parameter, then all events fired\nduring event suspension will be sent to any listeners now.
The new Proxy, which can be either a type string, a configuration object\nor an Ext.data.proxy.Proxy instance
\n", - "name": "proxy" - } - ], - "name": "setProxy", - "owner": "Ext.data.AbstractStore", - "doc": "Sets the Store's Proxy by string, config object or Proxy instance
\n", - "linenr": 276, - "return": { - "type": "Ext.data.proxy.Proxy", - "doc": "The attached Proxy object
\n" - }, - "html_filename": "AbstractStore.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "TreeStore.html#Ext-data-TreeStore-method-setRootNode", - "shortDoc": "Sets the root node for this store. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/TreeStore.js", - "private": false, - "params": [ - { - "type": "Ext.data.Model/Ext.data.NodeInterface/Object", - "optional": false, - "doc": "\n", - "name": "root" - } - ], - "name": "setRootNode", - "owner": "Ext.data.TreeStore", - "doc": "Sets the root node for this store. See also the root config option.
\n", - "linenr": 364, - "return": { - "type": "Ext.data.NodeInterface", - "doc": "The new root
\n" - }, - "html_filename": "TreeStore.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "Sortable.html#Ext-util-Sortable-method-sort", - "shortDoc": "Sorts the data in the Store by one or more of its properties. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Sortable.js", - "private": false, - "params": [ - { - "type": "String|Array", - "optional": false, - "doc": "Either a string name of one of the fields in this Store's configured Model,\nor an Array of sorter configurations.
\n", - "name": "sorters" - }, - { - "type": "String", - "optional": false, - "doc": "The overall direction to sort the data by. Defaults to \"ASC\".
\n", - "name": "direction" - }, - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "where" - }, - { - "type": "Object", - "optional": false, - "doc": "\n", - "name": "doSort" - } - ], - "name": "sort", - "owner": "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",
- "linenr": 58,
- "return": {
- "type": "void",
- "doc": "\n"
- },
- "html_filename": "Sortable.html"
- },
- {
- "deprecated": null,
- "alias": null,
- "protected": true,
- "tagname": "method",
- "href": "Base3.html#Ext-Base-method-statics",
- "shortDoc": "Get the reference to the class from which this object was instantiated. ...",
- "static": false,
- "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js",
- "private": false,
- "params": [
-
- ],
- "name": "statics",
- "owner": "Ext.Base",
- "doc": "Get the reference to the class from which this object was instantiated. Note that unlike Ext.Base.self,\nthis.statics()
is scope-independent and it always returns the class from which it was called, regardless of what\nthis
points to during run-time
Ext.define('My.Cat', {\n statics: {\n totalCreated: 0,\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n var statics = this.statics();\n\n alert(statics.speciesName); // always equals to 'Cat' no matter what 'this' refers to\n // equivalent to: My.Cat.speciesName\n\n alert(this.self.speciesName); // dependent on 'this'\n\n statics.totalCreated++;\n\n return this;\n },\n\n clone: function() {\n var cloned = new this.self; // dependent on 'this'\n\n cloned.groupName = this.statics().speciesName; // equivalent to: My.Cat.speciesName\n\n return cloned;\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n },\n\n constructor: function() {\n this.callParent();\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\nalert(clone.groupName); // alerts 'Cat'\n\nalert(My.Cat.totalCreated); // alerts 3\n
\n",
- "linenr": 199,
- "return": {
- "type": "Class",
- "doc": "\n"
- },
- "html_filename": "Base3.html"
- },
- {
- "deprecated": null,
- "alias": null,
- "protected": false,
- "tagname": "method",
- "href": "Observable.html#Ext-util-Observable-method-suspendEvents",
- "shortDoc": "Suspends the firing of all events. ...",
- "static": false,
- "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js",
- "private": false,
- "params": [
- {
- "type": "Boolean",
- "optional": false,
- "doc": "Pass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events.
\n", - "name": "queueSuspended" - } - ], - "name": "suspendEvents", - "owner": "Ext.util.Observable", - "doc": "Suspends the firing of all events. (see resumeEvents)
\n", - "linenr": 541, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "method", - "href": "AbstractStore.html#Ext-data-AbstractStore-method-sync", - "shortDoc": "Synchronizes the Store with its Proxy. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js", - "private": false, - "params": [ - - ], - "name": "sync", - "owner": "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", - "linenr": 546, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "AbstractStore.html" - }, - { - "deprecated": null, - "alias": { - "tagname": "alias", - "cls": "Ext.util.Observable", - "doc": null, - "owner": "removeListener" - }, - "protected": false, - "tagname": "method", - "href": "Observable.html#Ext-util-Observable-method-un", - "shortDoc": "Shorthand for removeListener. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Observable.js", - "private": false, - "params": [ - { - "type": "String", - "optional": false, - "doc": "The type of event the handler was associated with.
\n", - "name": "eventName" - }, - { - "type": "Function", - "optional": false, - "doc": "The handler to remove. This must be a reference to the function passed into the\naddListener call.
\n", - "name": "handler" - }, - { - "type": "Object", - "optional": true, - "doc": "(optional) The scope originally specified for the handler.
\n", - "name": "scope" - } - ], - "name": "un", - "owner": "Ext.util.Observable", - "doc": "Shorthand for removeListener.
\n\nRemoves an event handler.
\n", - "linenr": 675, - "return": { - "type": "void", - "doc": "\n" - }, - "html_filename": "Observable.html" - } - ], - "property": [ - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "Sortable.html#Ext-util-Sortable-property-", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Sortable.js", - "private": false, - "name": "", - "owner": "Ext.util.Sortable", - "doc": "The property in each item that contains the data to sort.
\n", - "linenr": 31, - "html_filename": "Sortable.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "AbstractStore.html#Ext-data-AbstractStore-property-batchUpdateMode", - "shortDoc": "Sets the updating behavior based on batch synchronization. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js", - "private": false, - "name": "batchUpdateMode", - "owner": "Ext.data.AbstractStore", - "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", - "linenr": 67, - "html_filename": "AbstractStore.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "AbstractStore.html#Ext-data-AbstractStore-property-defaultProxyType", - "shortDoc": "The string type of the Proxy to create if none is specified. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js", - "private": false, - "name": "defaultProxyType", - "owner": "Ext.data.AbstractStore", - "doc": "The string type of the Proxy to create if none is specified. This defaults to creating a memory proxy.
\n", - "linenr": 102, - "html_filename": "AbstractStore.html" - }, - { - "type": "String", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "Sortable.html#Ext-util-Sortable-property-defaultSortDirection", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Sortable.js", - "private": false, - "name": "defaultSortDirection", - "owner": "Ext.util.Sortable", - "doc": "The default sort direction to use if one is not specified (defaults to \"ASC\")
\n", - "linenr": 20, - "html_filename": "Sortable.html" - }, - { - "type": "Object", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "TreeStore.html#Ext-data-TreeStore-property-fields", - "shortDoc": "If we have no fields declare for the store, add some defaults. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/TreeStore.js", - "private": false, - "name": "fields", - "owner": "Ext.data.TreeStore", - "doc": "If we have no fields declare for the store, add some defaults.\nThese will be ignored if a model is explicitly specified.
\n", - "linenr": 80, - "html_filename": "TreeStore.html" - }, - { - "type": "Boolean", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "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. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js", - "private": false, - "name": "filterOnLoad", - "owner": "Ext.data.AbstractStore", - "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", - "linenr": 77, - "html_filename": "AbstractStore.html" - }, - { - "type": "Ext.util.MixedCollection", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "AbstractStore.html#Ext-data-AbstractStore-property-filters", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js", - "private": false, - "name": "filters", - "owner": "Ext.data.AbstractStore", - "doc": "The collection of Filters currently applied to this Store
\n", - "linenr": 266, - "html_filename": "AbstractStore.html" - }, - { - "type": "Boolean", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "AbstractStore.html#Ext-data-AbstractStore-property-isDestroyed", - "shortDoc": "True if the Store has already been destroyed via destroyStore. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js", - "private": false, - "name": "isDestroyed", - "owner": "Ext.data.AbstractStore", - "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", - "linenr": 109, - "html_filename": "AbstractStore.html" - }, - { - "type": "Boolean", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "Sortable.html#Ext-util-Sortable-property-isSortable", - "shortDoc": "Flag denoting that this object is sortable. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Sortable.js", - "private": false, - "name": "isSortable", - "owner": "Ext.util.Sortable", - "doc": "Flag denoting that this object is sortable. Always true.
\n", - "linenr": 13, - "html_filename": "Sortable.html" - }, - { - "type": "Class", - "deprecated": null, - "alias": null, - "protected": true, - "tagname": "property", - "href": "Base3.html#Ext-Base-property-self", - "shortDoc": "Get the reference to the current class from which this object was instantiated. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/core/src/class/Base.js", - "private": false, - "name": "self", - "owner": "Ext.Base", - "doc": "Get the reference to the current class from which this object was instantiated. Unlike Ext.Base.statics,\nthis.self
is scope-dependent and it's meant to be used for dynamic inheritance. See Ext.Base.statics\nfor a detailed comparison
Ext.define('My.Cat', {\n statics: {\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n alert(this.self.speciesName); / dependent on 'this'\n\n return this;\n },\n\n clone: function() {\n return new this.self();\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\n
\n",
- "linenr": 18,
- "html_filename": "Base3.html"
- },
- {
- "type": "Boolean",
- "deprecated": null,
- "alias": null,
- "protected": false,
- "tagname": "property",
- "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. ...",
- "static": false,
- "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js",
- "private": false,
- "name": "sortOnLoad",
- "owner": "Ext.data.AbstractStore",
- "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", - "linenr": 85, - "html_filename": "AbstractStore.html" - }, - { - "type": "Ext.util.MixedCollection", - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "property", - "href": "Sortable.html#Ext-util-Sortable-property-sorters", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/util/Sortable.js", - "private": false, - "name": "sorters", - "owner": "Ext.util.Sortable", - "doc": "The collection of Sorters currently applied to this Store
\n", - "linenr": 44, - "html_filename": "Sortable.html" - } - ], - "cssVar": [ - - ], - "cssMixin": [ - - ], - "event": [ - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "AbstractStore.html#Ext-data-AbstractStore-event-add", - "shortDoc": "Fired when a Model instance has been added to this Store ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js", - "private": false, - "params": [ - { - "type": "Ext.data.Store", - "optional": false, - "doc": "The store
\n", - "name": "store" - }, - { - "type": "Array", - "optional": false, - "doc": "The Model instances that were added
\n", - "name": "records" - }, - { - "type": "Number", - "optional": false, - "doc": "The index at which the instances were inserted
\n", - "name": "index" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "add", - "owner": "Ext.data.AbstractStore", - "doc": "Fired when a Model instance has been added to this Store
\n", - "linenr": 141, - "html_filename": "AbstractStore.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "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. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/TreeStore.js", - "private": false, - "params": [ - { - "type": "Tree", - "optional": false, - "doc": "The owner tree
\n", - "name": "tree" - }, - { - "type": "Node", - "optional": false, - "doc": "The parent node
\n", - "name": "parent" - }, - { - "type": "Node", - "optional": false, - "doc": "The newly appended node
\n", - "name": "node" - }, - { - "type": "Number", - "optional": false, - "doc": "The index of the newly appended node
\n", - "name": "index" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "append", - "owner": "Ext.data.TreeStore", - "doc": "Fires when a new child node is appended to a node in this store's tree.
\n", - "linenr": 95, - "html_filename": "TreeStore.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "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. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/TreeStore.js", - "private": false, - "params": [ - { - "type": "Tree", - "optional": false, - "doc": "The owner tree
\n", - "name": "tree" - }, - { - "type": "Node", - "optional": false, - "doc": "The parent node
\n", - "name": "parent" - }, - { - "type": "Node", - "optional": false, - "doc": "The child node to be appended
\n", - "name": "node" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "beforeappend", - "owner": "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", - "linenr": 135, - "html_filename": "TreeStore.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "TreeStore.html#Ext-data-TreeStore-event-beforecollapse", - "shortDoc": "Fires before this node is collapsed. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/TreeStore.js", - "private": false, - "params": [ - { - "type": "Node", - "optional": false, - "doc": "The collapsing node
\n", - "name": "this" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "beforecollapse", - "owner": "Ext.data.TreeStore", - "doc": "Fires before this node is collapsed.
\n", - "linenr": 195, - "html_filename": "TreeStore.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "TreeStore.html#Ext-data-TreeStore-event-beforeexpand", - "shortDoc": "Fires before this node is expanded. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/TreeStore.js", - "private": false, - "params": [ - { - "type": "Node", - "optional": false, - "doc": "The expanding node
\n", - "name": "this" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "beforeexpand", - "owner": "Ext.data.TreeStore", - "doc": "Fires before this node is expanded.
\n", - "linenr": 188, - "html_filename": "TreeStore.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "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. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/TreeStore.js", - "private": false, - "params": [ - { - "type": "Tree", - "optional": false, - "doc": "The owner tree
\n", - "name": "tree" - }, - { - "type": "Node", - "optional": false, - "doc": "The parent node
\n", - "name": "parent" - }, - { - "type": "Node", - "optional": false, - "doc": "The child node to be inserted
\n", - "name": "node" - }, - { - "type": "Node", - "optional": false, - "doc": "The child node the node is being inserted before
\n", - "name": "refNode" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "beforeinsert", - "owner": "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", - "linenr": 164, - "html_filename": "TreeStore.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "AbstractStore.html#Ext-data-AbstractStore-event-beforeload", - "shortDoc": "Event description ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js", - "private": false, - "params": [ - { - "type": "Ext.data.Store", - "optional": false, - "doc": "This Store
\n", - "name": "store" - }, - { - "type": "Ext.data.Operation", - "optional": false, - "doc": "The Ext.data.Operation object that will be passed to the Proxy to load the Store
\n", - "name": "operation" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "beforeload", - "owner": "Ext.data.AbstractStore", - "doc": "Event description
\n", - "linenr": 181, - "html_filename": "AbstractStore.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "TreeStore.html#Ext-data-TreeStore-event-beforemove", - "shortDoc": "Fires before a node is moved to a new location in the store's tree. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/TreeStore.js", - "private": false, - "params": [ - { - "type": "Tree", - "optional": false, - "doc": "The owner tree
\n", - "name": "tree" - }, - { - "type": "Node", - "optional": false, - "doc": "The node being moved
\n", - "name": "node" - }, - { - "type": "Node", - "optional": false, - "doc": "The parent of the node
\n", - "name": "oldParent" - }, - { - "type": "Node", - "optional": false, - "doc": "The new parent the node is moving to
\n", - "name": "newParent" - }, - { - "type": "Number", - "optional": false, - "doc": "The index it is being moved to
\n", - "name": "index" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "beforemove", - "owner": "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", - "linenr": 153, - "html_filename": "TreeStore.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "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. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/TreeStore.js", - "private": false, - "params": [ - { - "type": "Tree", - "optional": false, - "doc": "The owner tree
\n", - "name": "tree" - }, - { - "type": "Node", - "optional": false, - "doc": "The parent node
\n", - "name": "parent" - }, - { - "type": "Node", - "optional": false, - "doc": "The child node to be removed
\n", - "name": "node" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "beforeremove", - "owner": "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", - "linenr": 144, - "html_filename": "TreeStore.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "AbstractStore.html#Ext-data-AbstractStore-event-beforesync", - "shortDoc": "Called before a call to sync is executed. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js", - "private": false, - "params": [ - { - "type": "Object", - "optional": false, - "doc": "Hash of all records to be synchronized, broken down into create, update and destroy
\n", - "name": "options" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "beforesync", - "owner": "Ext.data.AbstractStore", - "doc": "Called before a call to sync is executed. Return false from any listener to cancel the synv
\n", - "linenr": 198, - "html_filename": "AbstractStore.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "AbstractStore.html#Ext-data-AbstractStore-event-clear", - "shortDoc": "Fired after the removeAll method is called. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js", - "private": false, - "params": [ - { - "type": "Ext.data.Store", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "clear", - "owner": "Ext.data.AbstractStore", - "doc": "Fired after the removeAll method is called.
\n", - "linenr": 204, - "html_filename": "AbstractStore.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "TreeStore.html#Ext-data-TreeStore-event-collapse", - "shortDoc": "Fires when this node is collapsed. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/TreeStore.js", - "private": false, - "params": [ - { - "type": "Node", - "optional": false, - "doc": "The collapsing node
\n", - "name": "this" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "collapse", - "owner": "Ext.data.TreeStore", - "doc": "Fires when this node is collapsed.
\n", - "linenr": 181, - "html_filename": "TreeStore.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "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 ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js", - "private": false, - "params": [ - { - "type": "Ext.data.Store", - "optional": false, - "doc": "The data store
\n", - "name": "this" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "datachanged", - "owner": "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", - "linenr": 173, - "html_filename": "AbstractStore.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "TreeStore.html#Ext-data-TreeStore-event-expand", - "shortDoc": "Fires when this node is expanded. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/TreeStore.js", - "private": false, - "params": [ - { - "type": "Node", - "optional": false, - "doc": "The expanding node
\n", - "name": "this" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "expand", - "owner": "Ext.data.TreeStore", - "doc": "Fires when this node is expanded.
\n", - "linenr": 174, - "html_filename": "TreeStore.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "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. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/TreeStore.js", - "private": false, - "params": [ - { - "type": "Tree", - "optional": false, - "doc": "The owner tree
\n", - "name": "tree" - }, - { - "type": "Node", - "optional": false, - "doc": "The parent node
\n", - "name": "parent" - }, - { - "type": "Node", - "optional": false, - "doc": "The child node inserted
\n", - "name": "node" - }, - { - "type": "Node", - "optional": false, - "doc": "The child node the node was inserted before
\n", - "name": "refNode" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "insert", - "owner": "Ext.data.TreeStore", - "doc": "Fires when a new child node is inserted in a node in this store's tree.
\n", - "linenr": 125, - "html_filename": "TreeStore.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "AbstractStore.html#Ext-data-AbstractStore-event-load", - "shortDoc": "Fires whenever the store reads data from a remote data source. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js", - "private": false, - "params": [ - { - "type": "Ext.data.Store", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Array", - "optional": false, - "doc": "An array of records
\n", - "name": "records" - }, - { - "type": "Boolean", - "optional": false, - "doc": "True if the operation was successful.
\n", - "name": "successful" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "load", - "owner": "Ext.data.AbstractStore", - "doc": "Fires whenever the store reads data from a remote data source.
\n", - "linenr": 189, - "html_filename": "AbstractStore.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "TreeStore.html#Ext-data-TreeStore-event-move", - "shortDoc": "Fires when a node is moved to a new location in the store's tree ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/TreeStore.js", - "private": false, - "params": [ - { - "type": "Tree", - "optional": false, - "doc": "The owner tree
\n", - "name": "tree" - }, - { - "type": "Node", - "optional": false, - "doc": "The node moved
\n", - "name": "node" - }, - { - "type": "Node", - "optional": false, - "doc": "The old parent of this node
\n", - "name": "oldParent" - }, - { - "type": "Node", - "optional": false, - "doc": "The new parent of this node
\n", - "name": "newParent" - }, - { - "type": "Number", - "optional": false, - "doc": "The index it was moved to
\n", - "name": "index" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "move", - "owner": "Ext.data.TreeStore", - "doc": "Fires when a node is moved to a new location in the store's tree
\n", - "linenr": 114, - "html_filename": "TreeStore.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "TreeStore.html#Ext-data-TreeStore-event-remove", - "shortDoc": "Fires when a child node is removed from a node in this store's tree. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/TreeStore.js", - "private": false, - "params": [ - { - "type": "Tree", - "optional": false, - "doc": "The owner tree
\n", - "name": "tree" - }, - { - "type": "Node", - "optional": false, - "doc": "The parent node
\n", - "name": "parent" - }, - { - "type": "Node", - "optional": false, - "doc": "The child node removed
\n", - "name": "node" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "remove", - "owner": "Ext.data.TreeStore", - "doc": "Fires when a child node is removed from a node in this store's tree.
\n", - "linenr": 105, - "html_filename": "TreeStore.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "TreeStore.html#Ext-data-TreeStore-event-rootchange", - "shortDoc": "Fires when the root node on this TreeStore is changed. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/TreeStore.js", - "private": false, - "params": [ - { - "type": "Ext.data.TreeStore", - "optional": false, - "doc": "This TreeStore
\n", - "name": "store" - }, - { - "type": "Node", - "optional": false, - "doc": "new root node.
\n", - "name": "The" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "rootchange", - "owner": "Ext.data.TreeStore", - "doc": "Fires when the root node on this TreeStore is changed.
\n", - "linenr": 237, - "html_filename": "TreeStore.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "TreeStore.html#Ext-data-TreeStore-event-sort", - "shortDoc": "Fires when this TreeStore is sorted. ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/TreeStore.js", - "private": false, - "params": [ - { - "type": "Node", - "optional": false, - "doc": "The node that is sorted.
\n", - "name": "node" - }, - { - "type": "Object", - "tagname": "param", - "name": "options", - "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "sort", - "owner": "Ext.data.TreeStore", - "doc": "Fires when this TreeStore is sorted.
\n", - "linenr": 202, - "html_filename": "TreeStore.html" - }, - { - "deprecated": null, - "alias": null, - "protected": false, - "tagname": "event", - "href": "AbstractStore.html#Ext-data-AbstractStore-event-update", - "shortDoc": "Fires when a Record has been updated ...", - "static": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/AbstractStore.js", - "private": false, - "params": [ - { - "type": "Store", - "optional": false, - "doc": "\n", - "name": "this" - }, - { - "type": "Ext.data.Model", - "optional": false, - "doc": "The Model instance that was updated
\n", - "name": "record" - }, - { - "type": "String", - "optional": false, - "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",
- "name": "operation"
- },
- {
- "type": "Object",
- "tagname": "param",
- "name": "options",
- "doc": "The options object passed to Ext.util.Observable.addListener.
\n" - } - ], - "name": "update", - "owner": "Ext.data.AbstractStore", - "doc": "Fires when a Record has been updated
\n", - "linenr": 159, - "html_filename": "AbstractStore.html" - } - ] - }, - "singleton": false, - "alias": null, - "superclasses": [ - "Ext.Base", - "Ext.data.AbstractStore" - ], - "protected": false, - "tagname": "class", - "mixins": [ - - ], - "href": "TreeStore.html#Ext-data-TreeStore", - "subclasses": [ - - ], - "static": false, - "author": null, - "component": false, - "filename": "/mnt/ebs/nightly/git/SDK/platform/src/data/TreeStore.js", - "private": false, - "alternateClassNames": [ - - ], - "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.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", - "mixedInto": [ - - ], - "linenr": 1, - "xtypes": [ - - ], - "html_filename": "TreeStore.html", - "extends": "Ext.data.AbstractStore" -}); \ No newline at end of file +Ext.data.JsonP.Ext_data_TreeStore({"tagname":"class","html":"Hierarchy
Ext.BaseExt.data.AbstractStoreExt.data.TreeStoreMixins
Requires
Files
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. These fields are listed\nin the Ext.data.NodeInterface documentation.
\n\nFor the tree to read nested data, the Ext.data.reader.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'.
\nIf data is not specified, and if autoLoad is true or an Object, this store's load method is automatically called\nafter creation. If the value of autoLoad is an Object, this Object will be passed to the store's load method.\nDefaults to false.
\nDefaults to: false
True to automatically sync the Store with its Proxy after every edit to one of its Records. Defaults to false.
\nDefaults to: false
Remove previously existing child nodes before loading. Default to true.
\nDefaults to: true
The root property to specify on the reader if one is not explicitly defined.
\nDefaults to: "children"
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\nconfig.
\nSet to true to automatically prepend a leaf sorter. Defaults to undefined
.
Defaults to: false
A config object containing one or more event handlers to be added to this object during initialization. This\nshould be a valid listeners config object as specified in the addListener example for attaching multiple\nhandlers at once.
\n\nDOM events from Ext JS Components
\n\nWhile some Ext JS Component classes export selected DOM events (e.g. \"click\", \"mouseover\" etc), this is usually\nonly done when extra value can be added. For example the DataView's itemclick
event passing the node clicked on. To access DOM events directly from a\nchild element of a Component, we need to specify the element
option to identify the Component property to add a\nDOM listener to:
new Ext.panel.Panel({\n width: 400,\n height: 200,\n dockedItems: [{\n xtype: 'toolbar'\n }],\n listeners: {\n click: {\n element: 'el', //bind to the underlying el property on the panel\n fn: function(){ console.log('click el'); }\n },\n dblclick: {\n element: 'body', //bind to the underlying body property on the panel\n fn: function(){ console.log('dblclick body'); }\n }\n }\n});\n
\nName of the Model associated with this store.\nThe string is used as an argument for Ext.ModelManager.getModel.
\nThe name of the parameter sent to the server which contains the identifier of the node.\nDefaults to 'node'.
\nDefaults to: "node"
The Proxy to use for this Store. This can be either a string, a config object or a Proxy instance -\nsee setProxy for details.
\nThe root node for this store. For example:
\n\nroot: {\n expanded: true,\n text: \"My Root\",\n children: [\n { text: \"Child 1\", leaf: true },\n { text: \"Child 2\", expanded: true, children: [\n { text: \"GrandChild\", leaf: true }\n ] }\n ]\n}\n
\n\nSetting the root
config option is the same as calling setRootNode.
Unique identifier for this store. If present, this Store will be registered with the Ext.data.StoreManager,\nmaking it easy to reuse elsewhere. Defaults to undefined.
\nSets 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.
\nThe string type of the Proxy to create if none is specified. This defaults to creating a\nmemory proxy.
\nThe default sort direction to use if one is not specified.
\nThe default sort direction to use if one is not specified.
\nIf we have no fields declare for the store, add some defaults.\nThese will be ignored if a model is explicitly specified.
\nIf 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
\nTrue if the Store has already been destroyed. If this is true, the reference to Store should be deleted\nas it will not function correctly any more.
\nFlag denoting that this object is sortable. Always true.
\nGet the reference to the current class from which this object was instantiated. Unlike statics,\nthis.self
is scope-dependent and it's meant to be used for dynamic inheritance. See statics\nfor a detailed comparison
Ext.define('My.Cat', {\n statics: {\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n alert(this.self.speciesName); / dependent on 'this'\n\n return this;\n },\n\n clone: function() {\n return new this.self();\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat'\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\n
\nIf 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
\nThe property in each item that contains the data to sort.
\nThe property in each item that contains the data to sort.
\nAdds the specified events to the list of events which this Observable may fire.
\nEither an object with event names as properties with a value of true
or the first\nevent name string if multiple event names are being passed as separate parameters. Usage:
this.addEvents({\n storeloaded: true,\n storecleared: true\n});\n
\nAdditional event names if multiple event names are being passed as separate\nparameters. Usage:
\n\nthis.addEvents('storeloaded', 'storecleared');\n
\nAppends an event handler to this object.
\nThe name of the event to listen for. May also be an object who's property names are\nevent names.
\n\nThe method the event invokes. Will be called with arguments given to\nfireEvent plus the options
parameter described below.
The scope (this
reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.
An object containing handler configuration.
\n\n\n\n\nNote: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.
\n\n\n\n\nThis object may contain any of the following properties:
\n\n\n\n\nscope : Object
\n\nThe scope (this
reference) in which the handler function is executed. If omitted, defaults to the object\nwhich fired the event.
delay : Number
\n\nThe number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
\n\nTrue to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
\n\nCauses the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is not invoked, but the new\nhandler is scheduled in its place.
target : Observable
\n\nOnly call the handler if the event was fired on the target Observable, not if the event was bubbled up from a\nchild Observable.
element : String
\n\nThis option is only valid for listeners bound to Components. The name of a Component\nproperty which references an element to add a listener to.
\n\nThis option is useful during Component construction to add DOM event listeners to elements of\nComponents which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:
\n\nnew Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n
Combining Options
\n\n\n\n\nUsing the options argument, it is possible to combine different types of listeners:
\n\n\n\n\nA delayed, one-time listener.
\n\n\n\n\nmyPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\n
\n\n\n\n\nAttaching multiple handlers in 1 call
\n\n\n\n\nThe method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:
\n\n\n\n\nmyGridPanel.on({\n cellClick: this.onCellClick,\n mouseover: this.onMouseOver,\n mouseout: this.onMouseOut,\n scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n
\n\n\n\n\nOne can also specify options for each event handler separately:
\n\n\n\n\nmyGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n
\n\nAdds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestroyed.
\nThe item to which to add a listener/listeners.
\n\nThe event name, or an object containing event name properties.
\n\nIf the ename
parameter was an event name, this is the handler function.
If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
If the ename
parameter was an event name, this is the\naddListener options.
Call the original method that was previously overridden with override
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\n
\nThe arguments, either an array or the arguments
object
Returns the result after calling the overridden method
\nCall the parent's overridden method. For example:
\n\nExt.define('My.own.A', {\n constructor: function(test) {\n alert(test);\n }\n});\n\nExt.define('My.own.B', {\n extend: 'My.own.A',\n\n constructor: function(test) {\n alert(test);\n\n this.callParent([test + 1]);\n }\n});\n\nExt.define('My.own.C', {\n extend: 'My.own.B',\n\n constructor: function() {\n alert(\"Going to call parent's overriden constructor...\");\n\n this.callParent(arguments);\n }\n});\n\nvar a = new My.own.A(1); // alerts '1'\nvar b = new My.own.B(1); // alerts '1', then alerts '2'\nvar c = new My.own.C(2); // alerts \"Going to call parent's overriden constructor...\"\n // alerts '2', then alerts '3'\n
\nThe arguments, either an array or the arguments
object\nfrom the current method, for example: this.callParent(arguments)
Returns the result from the superclass' method
\nRemoves all listeners for this object including the managed listeners
\nEnables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget()
if\npresent. There is no implementation in the Observable base class.
This is commonly used by Ext.Components to bubble events to owner Containers.\nSee Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the\nComponent's immediate owner. But if a known target is required, this can be overridden to access the\nrequired target more quickly.
\n\nExample:
\n\nExt.override(Ext.form.field.Base, {\n // Add functionality to Field's initComponent to enable the change event to bubble\n initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {\n this.enableBubble('change');\n }),\n\n // We know that we want Field's events to bubble directly to the FormPanel.\n getBubbleTarget : function() {\n if (!this.formPanel) {\n this.formPanel = this.findParentByType('form');\n }\n return this.formPanel;\n }\n});\n\nvar myForm = new Ext.formPanel({\n title: 'User Details',\n items: [{\n ...\n }],\n listeners: {\n change: function() {\n // Title goes red if form has been modified.\n myForm.header.setStyle('color', 'red');\n }\n }\n});\n
\nFires the specified event with the passed parameters (minus the event name, plus the options
object passed\nto addListener).
An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by\ncalling enableBubble.
\nThe name of the event to fire.
\nVariable number of parameters are passed to handlers.
\nreturns false if any of the handlers return false otherwise it returns true.
\nReturns 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)
\nThe Model instances
\nReturns the proxy currently attached to this proxy instance
\nThe Proxy instance
\nReturns any records that have been removed from the store but not yet destroyed on the proxy.
\nThe removed Model instances
\nReturns all Model instances that have been updated in the Store but not yet synchronized with the Proxy
\nThe updated Model instances
\nInitialize configuration for this class. a typical example:
\n\nExt.define('My.awesome.Class', {\n // The default config\n config: {\n name: 'Awesome',\n isAwesome: true\n },\n\n constructor: function(config) {\n this.initConfig(config);\n\n return this;\n }\n});\n\nvar awesome = new My.awesome.Class({\n name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n
\nmixins The mixin prototypes as key - value pairs
\nPerforms initialization of this mixin. Component classes using this mixin should call this method during their\nown initialization.
\nReturns true if the Store is currently performing a load operation
\nTrue if the Store is currently loading
\nLoads the Store using its configured proxy.
\nconfig 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.
\nShorthand for addManagedListener.
\n\nAdds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestroyed.
\nThe item to which to add a listener/listeners.
\n\nThe event name, or an object containing event name properties.
\n\nIf the ename
parameter was an event name, this is the handler function.
If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
If the ename
parameter was an event name, this is the\naddListener options.
Shorthand for removeManagedListener.
\n\nRemoves listeners that were added by the mon method.
\nThe item from which to remove a listener/listeners.
\n\nThe event name, or an object containing event name properties.
\n\nIf the ename
parameter was an event name, this is the handler function.
If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
Shorthand for addListener.
\n\nAppends an event handler to this object.
\nThe name of the event to listen for. May also be an object who's property names are\nevent names.
\n\nThe method the event invokes. Will be called with arguments given to\nfireEvent plus the options
parameter described below.
The scope (this
reference) in which the handler function is executed. If\nomitted, defaults to the object which fired the event.
An object containing handler configuration.
\n\n\n\n\nNote: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.
\n\n\n\n\nThis object may contain any of the following properties:
\n\n\n\n\nscope : Object
\n\nThe scope (this
reference) in which the handler function is executed. If omitted, defaults to the object\nwhich fired the event.
delay : Number
\n\nThe number of milliseconds to delay the invocation of the handler after the event fires.
single : Boolean
\n\nTrue to add a handler to handle just the next firing of the event, and then remove itself.
buffer : Number
\n\nCauses the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of\nmilliseconds. If the event fires again within that time, the original handler is not invoked, but the new\nhandler is scheduled in its place.
target : Observable
\n\nOnly call the handler if the event was fired on the target Observable, not if the event was bubbled up from a\nchild Observable.
element : String
\n\nThis option is only valid for listeners bound to Components. The name of a Component\nproperty which references an element to add a listener to.
\n\nThis option is useful during Component construction to add DOM event listeners to elements of\nComponents which will exist only after the Component is rendered.\nFor example, to add a click listener to a Panel's body:
\n\nnew Ext.panel.Panel({\n title: 'The title',\n listeners: {\n click: this.handlePanelClick,\n element: 'body'\n }\n});\n
Combining Options
\n\n\n\n\nUsing the options argument, it is possible to combine different types of listeners:
\n\n\n\n\nA delayed, one-time listener.
\n\n\n\n\nmyPanel.on('hide', this.handleClick, this, {\n single: true,\n delay: 100\n});\n
\n\n\n\n\nAttaching multiple handlers in 1 call
\n\n\n\n\nThe method also allows for a single argument to be passed which is a config object containing properties which\nspecify multiple events. For example:
\n\n\n\n\nmyGridPanel.on({\n cellClick: this.onCellClick,\n mouseover: this.onMouseOver,\n mouseout: this.onMouseOut,\n scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n
\n\n\n\n\nOne can also specify options for each event handler separately:
\n\n\n\n\nmyGridPanel.on({\n cellClick: {fn: this.onCellClick, scope: this, single: true},\n mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n
\n\nRemoves all records from the store. This method does a \"fast remove\",\nindividual remove events are not called. The clear event is\nfired upon completion.
\nRemoves an event handler.
\nThe type of event the handler was associated with.
\n\nThe handler to remove. This must be a reference to the function passed into the\naddListener call.
\n\nThe scope originally specified for the handler. It must be the same as the\nscope argument specified in the original call to addListener or the listener will not be removed.
\n\nRemoves listeners that were added by the mon method.
\nThe item from which to remove a listener/listeners.
\n\nThe event name, or an object containing event name properties.
\n\nIf the ename
parameter was an event name, this is the handler function.
If the ename
parameter was an event name, this is the scope (this
reference)\nin which the handler function is executed.
Resumes firing events (see suspendEvents).
\n\nIf events were suspended using the queueSuspended
parameter, then all events fired\nduring event suspension will be sent to any listeners now.
Sets the Store's Proxy by string, config object or Proxy instance
\nThe new Proxy, which can be either a type string, a configuration object\nor an Ext.data.proxy.Proxy instance
\nThe attached Proxy object
\nSets the root node for this store. See also the root config option.
\nThe new root
\nSorts the data in the Store by one or more of its properties. Example usage:
\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\nInternally, Store converts the passed arguments into an array of Ext.util.Sorter instances, and delegates\nthe actual sorting to its internal Ext.util.MixedCollection.
\n\nWhen passing a single string argument to sort, Store maintains a ASC/DESC toggler per field, so this code:
\n\nstore.sort('myField');\nstore.sort('myField');\n
\n\nIs equivalent to this code, because Store handles the toggling automatically:
\n\nstore.sort('myField', 'ASC');\nstore.sort('myField', 'DESC');\n
\nEither a string name of one of the fields in this Store's configured\nModel, or an array of sorter configurations.
\nThe overall direction to sort the data by. Defaults to \"ASC\".
\nGet the reference to the class from which this object was instantiated. Note that unlike self,\nthis.statics()
is scope-independent and it always returns the class from which it was called, regardless of what\nthis
points to during run-time
Ext.define('My.Cat', {\n statics: {\n totalCreated: 0,\n speciesName: 'Cat' // My.Cat.speciesName = 'Cat'\n },\n\n constructor: function() {\n var statics = this.statics();\n\n alert(statics.speciesName); // always equals to 'Cat' no matter what 'this' refers to\n // equivalent to: My.Cat.speciesName\n\n alert(this.self.speciesName); // dependent on 'this'\n\n statics.totalCreated++;\n\n return this;\n },\n\n clone: function() {\n var cloned = new this.self; // dependent on 'this'\n\n cloned.groupName = this.statics().speciesName; // equivalent to: My.Cat.speciesName\n\n return cloned;\n }\n});\n\n\nExt.define('My.SnowLeopard', {\n extend: 'My.Cat',\n\n statics: {\n speciesName: 'Snow Leopard' // My.SnowLeopard.speciesName = 'Snow Leopard'\n },\n\n constructor: function() {\n this.callParent();\n }\n});\n\nvar cat = new My.Cat(); // alerts 'Cat', then alerts 'Cat'\n\nvar snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'\n\nvar clone = snowLeopard.clone();\nalert(Ext.getClassName(clone)); // alerts 'My.SnowLeopard'\nalert(clone.groupName); // alerts 'Cat'\n\nalert(My.Cat.totalCreated); // alerts 3\n
\nSuspends the firing of all events. (see resumeEvents)
\nPass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events.
\nSynchronizes 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.
\nShorthand for removeListener.
\n\nRemoves an event handler.
\nThe type of event the handler was associated with.
\n\nThe handler to remove. This must be a reference to the function passed into the\naddListener call.
\n\nThe scope originally specified for the handler. It must be the same as the\nscope argument specified in the original call to addListener or the listener will not be removed.
\n\nAdd / override static properties of this class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.addStatics({\n someProperty: 'someValue', // My.cool.Class.someProperty = 'someValue'\n method1: function() { ... }, // My.cool.Class.method1 = function() { ... };\n method2: function() { ... } // My.cool.Class.method2 = function() { ... };\n});\n
\nthis
\nBorrow another class' members to the prototype of this class.
\n\nExt.define('Bank', {\n money: '$$$',\n printMoney: function() {\n alert('$$$$$$$');\n }\n});\n\nExt.define('Thief', {\n ...\n});\n\nThief.borrow(Bank, ['money', 'printMoney']);\n\nvar steve = new Thief();\n\nalert(steve.money); // alerts '$$$'\nsteve.printMoney(); // alerts '$$$$$$$'\n
\nThe class to borrow members from
\nThe names of the members to borrow
\nthis
\nCreate a new instance of this Class.
\n\nExt.define('My.cool.Class', {\n ...\n});\n\nMy.cool.Class.create({\n someConfig: true\n});\n
\n\nAll parameters are passed to the constructor of the class.
\nthe created instance.
\nCreate aliases for existing prototype methods. Example:
\n\nExt.define('My.cool.Class', {\n method1: function() { ... },\n method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n method3: 'method1',\n method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -> test.method1()\n
\nThe new method name, or an object to set multiple aliases. See\nflexSetter
\nThe original method name
\nGet the current class' name in string format.
\n\nExt.define('My.cool.Class', {\n constructor: function() {\n alert(this.self.getName()); // alerts 'My.cool.Class'\n }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n
\nclassName
\nAdd methods / properties to the prototype of this class.
\n\nExt.define('My.awesome.Cat', {\n constructor: function() {\n ...\n }\n});\n\n My.awesome.Cat.implement({\n meow: function() {\n alert('Meowww...');\n }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n
\nOverride prototype members of this class. Overridden methods can be invoked via\ncallOverridden
\n\nExt.define('My.Cat', {\n constructor: function() {\n alert(\"I'm a cat!\");\n\n return this;\n }\n});\n\nMy.Cat.override({\n constructor: function() {\n alert(\"I'm going to be a cat!\");\n\n var instance = this.callOverridden();\n\n alert(\"Meeeeoooowwww\");\n\n return instance;\n }\n});\n\nvar kitty = new My.Cat(); // alerts \"I'm going to be a cat!\"\n // alerts \"I'm a cat!\"\n // alerts \"Meeeeoooowwww\"\n
\nthis
\nFired when a Model instance has been added to this Store
\nThe store
\nThe Model instances that were added
\nThe index at which the instances were inserted
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires when a new child node is appended
\nThis node
\nThe newly appended node
\nThe index of the newly appended node
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires before a new child is appended, return false to cancel the append.
\nThis node
\nThe child node to be appended
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires before this node is collapsed.
\nThe collapsing node
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires before this node is expanded.
\nThe expanding node
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires before a new child is inserted, return false to cancel the insert.
\nThis node
\nThe child node to be inserted
\nThe child node the node is being inserted before
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires before a request is made for a new data object. If the beforeload handler returns false the load\naction will be canceled.
\nThis Store
\nThe Ext.data.Operation object that will be passed to the Proxy to\nload the Store
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires before this node is moved to a new location in the tree. Return false to cancel the move.
\nThis node
\nThe parent of this node
\nThe new parent this node is moving to
\nThe index it is being moved to
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires before a child is removed, return false to cancel the remove.
\nThis node
\nThe child node to be removed
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFired before a call to sync is executed. Return false from any listener to cancel the synv
\nHash of all records to be synchronized, broken down into create, update and destroy
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFired after the removeAll method is called.
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires when this node is collapsed.
\nThe collapsing node
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires whenever the records in the Store have changed in some way - this could include adding or removing\nrecords, or updating the data in existing records
\nThe data store
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires when this node is expanded.
\nThe expanding node
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires when a new child node is inserted.
\nThis node
\nThe child node inserted
\nThe child node the node was inserted before
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires whenever the store reads data from a remote data source.
\nThe node that was loaded.
\nAn array of records.
\nTrue if the operation was successful.
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires when this node is moved to a new location in the tree
\nThis node
\nThe old parent of this node
\nThe new parent of this node
\nThe index it was moved to
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires when a child node is removed
\nThis node
\nThe removed node
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires whenever the root node is changed in the tree.
\nThe new root
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires when this TreeStore is sorted.
\nThe node that is sorted.
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires when a Model instance has been updated
\nThe Model instance that was updated
\nThe update operation being performed. Value may be one of:
\n\nExt.data.Model.EDIT\nExt.data.Model.REJECT\nExt.data.Model.COMMIT\n
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\nFires whenever a successful write has been made via the configured Proxy
\nThis Store
\nThe Operation object that was used in\nthe write
\nThe options object passed to Ext.util.Observable.addListener.
\n\n\n\n