Using Models

autoLoad : Boolean/Object

If data is not specified, and if autoLoad is true or an Object, this store's load method is automatically called\nafte...

If 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.

Available since: 2.3.0

autoSync : Boolean

True to automatically sync the Store with its Proxy after every edit to one of its Records. ...

True to automatically sync the Store with its Proxy after every edit to one of its Records. Defaults to false.

Defaults to: false

batchUpdateMode : String

Sets the updating behavior based on batch synchronization. ...

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.

Defaults to: 'operation'

Ext.data.TreeStore
view source

clearOnLoad : Boolean

Remove previously existing child nodes before loading. ...

Remove previously existing child nodes before loading.

Defaults to: true

Ext.data.TreeStore
view source

clearRemovedOnLoad : Boolean

If true, when a node is reloaded, any records in the removed record collection that were previously descendants of th...

If true, when a node is reloaded, any records in the removed record collection that were previously descendants of the node being reloaded will be cleared from the removed collection.\nOnly applicable if clearOnLoad is true.

Defaults to: true

Ext.data.TreeStore
view source

defaultRootId : String

The default root id. ...

The default root id.

Defaults to: "root"

Ext.data.TreeStore
view source

defaultRootProperty : String

The root property to specify on the reader if one is not explicitly defined. ...

The root property to specify on the reader if one is not explicitly defined.

Defaults to: "children"

Ext.data.TreeStore
view source

defaultRootText : String

The default root text (if not specified)/ ...

The default root text (if not specified)/

Defaults to: "Root"

defaultSortDirection : String

The default sort direction to use if one is not specified. ...

The default sort direction to use if one is not specified.

Defaults to: "ASC"

fields : Object[]

This may be used in place of specifying a model configuration. ...

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 only be used for simple stores like\na two-field store of ComboBox. For anything more complicated, such as specifying a particular id property or\nassociations, a Ext.data.Model should be defined and specified for the model\nconfig.

Available since: 2.3.0

filterOnLoad : Boolean

If true, any filters attached to this Store will be run after loading data, before the datachanged event is fired. ...

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

Defaults to: true

filters : Object[]/Function[]

Array of Filters for this store. ...

Array of Filters for this store. Can also be passed array of\nfunctions which will be used as the filterFn config\nfor filters:

\n\n

filters: [\n    function(item) {\n        return item.weight > 0;\n    }\n]\n

\n\n

To filter after the grid is loaded use the filterBy function.

Ext.data.TreeStore
view source

folderSort : Boolean

Set to true to automatically prepend a leaf sorter. ...

Set to true to automatically prepend a leaf sorter.

Defaults to: false

listeners : Object

A config object containing one or more event handlers to be added to this object during initialization. ...

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\n

DOM events from Ext JS Components

\n\n

While 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:

\n\n

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

model : String

Name of the Model associated with this store. ...

Name of the Model associated with this store.\nThe string is used as an argument for Ext.ModelManager.getModel.

Ext.data.TreeStore
view source

nodeParam : String

The name of the parameter sent to the server which contains the identifier of the node. ...

The name of the parameter sent to the server which contains the identifier of the node.

Defaults to: "node"

proxy : String/Ext.data.proxy.Proxy/Object

The Proxy to use for this Store. ...

The Proxy to use for this Store. This can be either a string, a config object or a Proxy instance -\nsee setProxy for details.

Available since: 1.1.0

remoteFilter : Boolean

True to defer any filtering operation to the server. ...

True to defer any filtering operation to the server. If false, filtering is done locally on the client.

Defaults to: false

root : Ext.data.Model/Ext.data.NodeInterface/Object

remoteSort : Boolean

True to defer any sorting operation to the server. ...

True to defer any sorting operation to the server. If false, sorting is done locally on the client.

Defaults to: false

Ext.data.TreeStore
view source

The root node for this store. ...

The root node for this store. For example:

\n\n

root: {\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\n

Setting the root config option is the same as calling setRootNode.

sortOnLoad : Boolean

If true, any sorters attached to this Store will be run after loading data, before the datachanged event is fired. ...

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

Defaults to: true

sortRoot : String

The property in each item that contains the data to sort.

sorters : Ext.util.Sorter[]/Object[]

The initial set of Sorters

statefulFilters : Boolean

Configure as true to have the filters saved when a client grid saves its state. ...

Configure as true to have the filters saved when a client grid saves its state.

Defaults to: false

storeId : String

Unique identifier for this store. ...

Unique identifier for this store. If present, this Store will be registered with the Ext.data.StoreManager,\nmaking it easy to reuse elsewhere.

\n\n

Note that when store is instatiated by Controller, the storeId will be overridden by the name of the store.

Properties

Defined By

Instance Properties

$className : Stringprivate

...

Defaults to: 'Ext.Base'

configMap : Objectprivate

...

Defaults to: {}

defaultProxyType : String

The string type of the Proxy to create if none is specified. ...

The string type of the Proxy to create if none is specified. This defaults to creating a\nmemory proxy.

Defaults to: 'memory'

eventsSuspended : Numberprivate

Initial suspended call count. ...

Initial suspended call count. Incremented when suspendEvents is called, decremented when resumeEvents is called.

Defaults to: 0

Ext.data.TreeStore
view source

fields : Object

If we have no fields declare for the store, add some defaults. ...

If we have no fields declare for the store, add some defaults.\nThese will be ignored if a model is explicitly specified.

Ext.data.TreeStore
view source

fillCount : Numberprivate

...

Defaults to: 0

filters : Ext.util.MixedCollection

The collection of Filters currently applied to this Store

hasListeners : Objectreadonly

This object holds a key for any event that has a listener. ...

This object holds a key for any event that has a listener. The listener may be set\ndirectly on the instance, or on its class or a super class (via observe) or\non the MVC EventBus. The values of this object are truthy\n(a non-zero number) and falsy (0 or undefined). They do not represent an exact count\nof listeners. The value for an event is truthy if the event must be fired and is\nfalsy if there is no need to fire the event.

\n\n

The intended use of this property is to avoid the expense of fireEvent calls when\nthere are no listeners. This can be particularly helpful when one would otherwise\nhave to call fireEvent hundreds or thousands of times. It is used like this:

\n\n

 if (this.hasListeners.foo) {\n     this.fireEvent('foo', this, arg1);\n }\n

implicitModel : Booleanprivate

True if a model was created implicitly for this Store. ...

True if a model was created implicitly for this Store. This happens if a fields array is passed to the Store's\nconstructor instead of a model constructor or name.

Defaults to: false

initConfigList : Arrayprivate

...

Defaults to: []

initConfigMap : Objectprivate

...

Defaults to: {}

isDestroyed : Boolean

True if the Store has already been destroyed. ...

True 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.

Defaults to: false

Available since: 3.4.0

isInstance : Booleanprivate

...

Defaults to: true

isObservable : Boolean

true in this class to identify an object as an instantiated Observable, or subclass thereof. ...

true in this class to identify an object as an instantiated Observable, or subclass thereof.

Defaults to: true

isSortable : Boolean

true in this class to identify an object as an instantiated Sortable, or subclass thereof. ...

true in this class to identify an object as an instantiated Sortable, or subclass thereof.

Defaults to: true

isStore : Boolean

true in this class to identify an object as an instantiated Store, or subclass thereof. ...

true in this class to identify an object as an instantiated Store, or subclass thereof.

Defaults to: true

modelDefaults : Objectprivate

A set of default values to be applied to every model instance added via insert or created\nvia createModel. ...

A set of default values to be applied to every model instance added via insert or created\nvia createModel. This is used internally by associations to set foreign keys and\nother fields. See the Association classes source code for examples. This should not need to be used by application developers.

removed : Ext.data.Model[]protected

Temporary cache in which removed model instances are kept until successfully synchronised with a Proxy,\nat which poin...

Temporary cache in which removed model instances are kept until successfully synchronised with a Proxy,\nat which point this is cleared.

Ext.data.TreeStore
view source

rootProperty : Stringprivate

Keep a copy of the default so we know if it's been changed in a subclass/config ...

Keep a copy of the default so we know if it's been changed in a subclass/config

Defaults to: 'children'

self : Ext.Classprotected

Get the reference to the current class from which this object was instantiated. ...

Get 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

\n\n

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\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

sorters : Ext.util.MixedCollection

The collection of Sorters currently applied to this Store

Defined By

Static Properties

$onExtended : Arrayprivatestatic

...

Defaults to: []

Methods

Defined By

Instance Methods

Ext.data.TreeStore
view source

newExt.data.TreeStore( config ) : Ext.data.TreeStore

...

Parameters

config : Object
\n

Returns

Ext.data.TreeStore
\n

Overrides: Ext.data.AbstractStore.constructor

addEvents( eventNames )

Adds the specified events to the list of events which this Observable may fire. ...

Adds the specified events to the list of events which this Observable may fire.

Parameters

eventNames : Object/String...
Either an object with event names as properties with\na value of true. For example:
\n\n
```
this.addEvents({\n    storeloaded: true,\n    storecleared: true\n});\n
```
\n\n
Or any number of event names as separate parameters. For example:
\n\n
```
this.addEvents('storeloaded', 'storecleared');\n
```
\n

addListener( eventName, [fn], [scope], [options] ) : Object

Appends an event handler to this object. ...

Appends an event handler to this object. For example:

\n\n

myGridPanel.on(\"mouseover\", this.onMouseOver, this);\n

\n\n

The method also allows for a single argument to be passed which is a config object\ncontaining properties which specify multiple events. For example:

\n\n

myGridPanel.on({\n    cellClick: this.onCellClick,\n    mouseover: this.onMouseOver,\n    mouseout: this.onMouseOut,\n    scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n

\n\n

One can also specify options for each event handler separately:

\n\n

myGridPanel.on({\n    cellClick: {fn: this.onCellClick, scope: this, single: true},\n    mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n

\n\n

Names of methods in a specified scope may also be used. Note that\nscope MUST be specified to use this option:

\n\n

myGridPanel.on({\n    cellClick: {fn: 'onCellClick', scope: this, single: true},\n    mouseover: {fn: 'onMouseOver', scope: panel}\n});\n

Parameters

eventName : String/Object
The name of the event to listen for.\nMay also be an object who's property names are event names.
\n\n
fn : Function (optional)
The method the event invokes, or if scope is specified, the name* of the method within\nthe specified scope. Will be called with arguments\ngiven to fireEvent plus the options parameter described below.
\n\n
scope : Object (optional)
The scope (this reference) in which the handler function is\nexecuted. If omitted, defaults to the object which fired the event.
\n\n
options : Object (optional)
An object containing handler configuration.
\n\n\n\n\n
Note: Unlike in ExtJS 3.x, the options object will also be passed as the last\nargument to every event handler.
\n\n\n\n\n
This object may contain any of the following properties:
\n\n
- scope : Object
  The scope (this reference) in which the handler function is executed. If omitted,\n defaults to the object which fired the event.
  \n\n
- delay : Number
  The number of milliseconds to delay the invocation of the handler after the event fires.
  \n\n
- single : Boolean
  True to add a handler to handle just the next firing of the event, and then remove itself.
  \n\n
- buffer : Number
  Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed\n by the specified number of milliseconds. If the event fires again within that time,\n the original handler is not invoked, but the new handler is scheduled in its place.
  \n\n
- target : Ext.util.Observable
  Only call the handler if the event was fired on the target Observable, not if the event\n was bubbled up from a child Observable.
  \n\n
- element : String
  This option is only valid for listeners bound to Components.\n The name of a Component property which references an element to add a listener to.
  \n\n\n\n\n
  This option is useful during Component construction to add DOM event listeners to elements of\n Components which will exist only after the Component is rendered.\n For example, to add a click listener to a Panel's body:
  \n\n\n\n\n
```
  new Ext.panel.Panel({\n      title: 'The title',\n      listeners: {\n          click: this.handlePanelClick,\n          element: 'body'\n      }\n  });\n
```
  \n\n
- destroyable : Boolean (optional)
  When specified as true, the function returns A Destroyable object. An object which implements the destroy method which removes all listeners added in this call.
  \n\n
  Defaults to: false
- priority : Number (optional)
  An optional numeric priority that determines the order in which event handlers\n are run. Event handlers with no priority will be run as if they had a priority\n of 0. Handlers with a higher priority will be prioritized to run sooner than\n those with a lower priority. Negative numbers can be used to set a priority\n lower than the default. Internally, the framework uses a range of 1000 or\n greater, and -1000 or lesser for handers that are intended to run before or\n after all others, so it is recommended to stay within the range of -999 to 999\n when setting the priority of event handlers in application-level code.
  \n\n\n\n\n
  Combining Options
  \n\n\n\n\n
  Using the options argument, it is possible to combine different types of listeners:
  \n\n\n\n\n
  A delayed, one-time listener.
  \n\n\n\n\n
```
myPanel.on('hide', this.handleClick, this, {\n    single: true,\n    delay: 100\n});\n
```
  \n\n

Returns

Only when the destroyable option is specified.

\n\n\n\n\n

A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

\n\n\n\n\n

this.btnListeners =  = myButton.on({\n    destroyable: true\n    mouseover:   function() { console.log('mouseover'); },\n    mouseout:    function() { console.log('mouseout'); },\n    click:       function() { console.log('click'); }\n});\n

\n\n\n\n\n

And when those listeners need to be removed:

\n\n\n\n\n

Ext.destroy(this.btnListeners);\n

\n\n\n\n\n

this.btnListeners.destroy();\n

\n\n

addManagedListener( item, ename, [fn], [scope], [options] ) : Object

Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestr...

Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestroyed.

Parameters

item : Ext.util.Observable/Ext.Element
The item to which to add a listener/listeners.
\n\n
ename : Object/String
The event name, or an object containing event name properties.
\n\n
fn : Function (optional)
If the ename parameter was an event name, this is the handler function.
\n\n
scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
\n\n
options : Object (optional)
If the ename parameter was an event name, this is the\naddListener options.
\n\n

Returns

Only when the destroyable option is specified.

\n\n\n\n\n

A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

\n\n\n\n\n

this.btnListeners =  = myButton.mon({\n    destroyable: true\n    mouseover:   function() { console.log('mouseover'); },\n    mouseout:    function() { console.log('mouseout'); },\n    click:       function() { console.log('click'); }\n});\n

\n\n\n\n\n

And when those listeners need to be removed:

\n\n\n\n\n

Ext.destroy(this.btnListeners);\n

\n\n\n\n\n

this.btnListeners.destroy();\n

\n\n

afterCommit( record )private

A model instance should call this method on the Store it has been joined to. ...

A model instance should call this method on the Store it has been joined to.

Available since: 3.4.0

Parameters

record : Ext.data.Model
The model instance that was edited
\n

afterEdit( record, modifiedFieldNames )private

A model instance should call this method on the Store it has been joined to. ...

A model instance should call this method on the Store it has been joined to.

Available since: 3.4.0

Parameters

record : Ext.data.Model
The model instance that was edited
\n
modifiedFieldNames : String[]
Array of field names changed during edit.
\n

afterReject( record )private

A model instance should call this method on the Store it has been joined to.. ...

A model instance should call this method on the Store it has been joined to..

Available since: 3.4.0

Parameters

record : Ext.data.Model
The model instance that was edited
\n

applyState( state )private

Restores state to the passed state ...

Restores state to the passed state

Parameters

state : Object
\n

callOverridden( args ) : Objectdeprecatedprotected

Call the original method that was previously overridden with override\n\nExt.define('My.Cat', {\n constructor: functi...

Call the original method that was previously overridden with override

\n\n

Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callOverridden();\n\n        alert(\"Meeeeoooowwww\");\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

This method has been deprecated

as of 4.1. Use callParent instead.

\n\n

Parameters

args : Array/Arguments
The arguments, either an array or the arguments object\nfrom the current method, for example: this.callOverridden(arguments)
\n

Returns

Object
Returns the result of calling the overridden method
\n

callParent( args ) : Objectprotected

Call the \"parent\" method of the current method. ...

Call the \"parent\" method of the current method. That is the method previously\noverridden by derivation or by an override (see Ext.define).

\n\n

 Ext.define('My.Base', {\n     constructor: function (x) {\n         this.x = x;\n     },\n\n     statics: {\n         method: function (x) {\n             return x;\n         }\n     }\n });\n\n Ext.define('My.Derived', {\n     extend: 'My.Base',\n\n     constructor: function () {\n         this.callParent([21]);\n     }\n });\n\n var obj = new My.Derived();\n\n alert(obj.x);  // alerts 21\n

\n\n

This can be used with an override as follows:

\n\n

 Ext.define('My.DerivedOverride', {\n     override: 'My.Derived',\n\n     constructor: function (x) {\n         this.callParent([x*2]); // calls original My.Derived constructor\n     }\n });\n\n var obj = new My.Derived();\n\n alert(obj.x);  // now alerts 42\n

\n\n

This also works with static methods.

\n\n

 Ext.define('My.Derived2', {\n     extend: 'My.Base',\n\n     statics: {\n         method: function (x) {\n             return this.callParent([x*2]); // calls My.Base.method\n         }\n     }\n });\n\n alert(My.Base.method(10);     // alerts 10\n alert(My.Derived2.method(10); // alerts 20\n

\n\n

Lastly, it also works with overridden static methods.

\n\n

 Ext.define('My.Derived2Override', {\n     override: 'My.Derived2',\n\n     statics: {\n         method: function (x) {\n             return this.callParent([x*2]); // calls My.Derived2.method\n         }\n     }\n });\n\n alert(My.Derived2.method(10); // now alerts 40\n

\n\n

To override a method and replace it and also call the superclass method, use\ncallSuper. This is often done to patch a method to fix a bug.

Parameters

args : Array/Arguments
The arguments, either an array or the arguments object\nfrom the current method, for example: this.callParent(arguments)
\n

Returns

Object
Returns the result of calling the parent method
\n

callSuper( args ) : Objectprotected

This method is used by an override to call the superclass method but bypass any\noverridden method. ...

This method is used by an override to call the superclass method but bypass any\noverridden method. This is often done to \"patch\" a method that contains a bug\nbut for whatever reason cannot be fixed directly.

\n\n

Consider:

\n\n

 Ext.define('Ext.some.Class', {\n     method: function () {\n         console.log('Good');\n     }\n });\n\n Ext.define('Ext.some.DerivedClass', {\n     method: function () {\n         console.log('Bad');\n\n         // ... logic but with a bug ...\n\n         this.callParent();\n     }\n });\n

\n\n

To patch the bug in DerivedClass.method, the typical solution is to create an\noverride:

\n\n

 Ext.define('App.paches.DerivedClass', {\n     override: 'Ext.some.DerivedClass',\n\n     method: function () {\n         console.log('Fixed');\n\n         // ... logic but with bug fixed ...\n\n         this.callSuper();\n     }\n });\n

\n\n

The patch method cannot use callParent to call the superclass method since\nthat would call the overridden method containing the bug. In other words, the\nabove patch would only produce \"Fixed\" then \"Good\" in the console log, whereas,\nusing callParent would produce \"Fixed\" then \"Bad\" then \"Good\".

Parameters

args : Array/Arguments
The arguments, either an array or the arguments object\nfrom the current method, for example: this.callSuper(arguments)
\n

Returns

Object
Returns the result of calling the superclass method
\n

captureArgs( o, fn, scope )private

...

Parameters

o : Object
\n
fn : Object
\n
scope : Object
\n

Ext.data.TreeStore
view source

cleanRecords( node, records )private

...

Parameters

node : Object
\n
records : Object
\n

clearData( )private

to be implemented by subclasses ...

to be implemented by subclasses

clearFilter( supressEvent )private

...

Parameters

supressEvent : Object
\n

clearListeners( )

Removes all listeners for this object including the managed listeners ...

Removes all listeners for this object including the managed listeners

clearManagedListeners( )

Removes all managed listeners for this object. ...

Removes all managed listeners for this object.

Ext.data.TreeStore
view source

clearRemoved( node )private

Removes all records that used to be descendants of the passed node from the removed array ...

Removes all records that used to be descendants of the passed node from the removed array

Parameters

node : Ext.data.NodeInterface
\n

configClass( )private

...

continueFireEvent( eventName, args, bubbles )private

Continue to fire event. ...

Continue to fire event.

Parameters

eventName : String
\n
args : Array
\n
bubbles : Boolean
\n

create( data, options )private

saves any phantom records ...

saves any phantom records

Parameters

data : Object
\n
options : Object
\n

createRelayer( newName, [beginEnd] ) : Functionprivate

Creates an event handling function which refires the event from this object as the passed event name. ...

Creates an event handling function which refires the event from this object as the passed event name.

Parameters

newName : String
The name under which to refire the passed parameters.
\n
beginEnd : Array (optional)
The caller can specify on which indices to slice.
\n

Returns

Function
\n

decodeFilters( filters ) : Ext.util.Filter[]private

Normalizes an array of filter objects, ensuring that they are all Ext.util.Filter instances ...

Normalizes an array of filter objects, ensuring that they are all Ext.util.Filter instances

Parameters

filters : Object[]
The filters array
\n

Returns

Ext.util.Filter[]
Array of Ext.util.Filter objects
\n

decodeSorters( sorters ) : Ext.util.Sorter[]private

Normalizes an array of sorter objects, ensuring that they are all Ext.util.Sorter instances ...

Normalizes an array of sorter objects, ensuring that they are all Ext.util.Sorter instances

Parameters

sorters : Object[]
The sorters array
\n

Returns

Ext.util.Sorter[]
Array of Ext.util.Sorter objects
\n

destroy( )private

tells the attached proxy to destroy the given records ...

tells the attached proxy to destroy the given records

Available since: 3.4.0

Overrides: Ext.Base.destroy

destroyStore( )private

private ...

private

Ext.data.TreeStore
view source

doSort( sorterFn )private

inherit docs ...

inherit docs

Parameters

sorterFn : Object
\n

Overrides: Ext.data.AbstractStore.doSort

emptyComparator( )private

...

enableBubble( eventNames )

Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if\npresent. ...

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.

\n\n

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\n

Example:

\n\n

Ext.define('Ext.overrides.form.field.Base', {\n    override: 'Ext.form.field.Base',\n\n    //  Add functionality to Field's initComponent to enable the change event to bubble\n    initComponent: function () {\n        this.callParent();\n        this.enableBubble('change');\n    }\n});\n\nvar myForm = Ext.create('Ext.form.Panel', {\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

Parameters

eventNames : String/String[]
The event name to bubble, or an Array of event names.
\n

Ext.data.TreeStore
view source

fillNode( node, newNodes )private

Fills a node with a series of child records. ...

Fills a node with a series of child records.

Parameters

node : Ext.data.NodeInterface
The node to fill
\n
newNodes : Ext.data.Model[]
The records to add
\n

filter( filters, value )private

...

Parameters

filters : Object
\n
value : Object
\n

filterBy( fn, scope )private

...

Parameters

fn : Object
\n
scope : Object
\n

filterNew( item )private

Filter function for new records. ...

Filter function for new records.

Parameters

item : Object
\n

filterUpdated( item )private

Filter function for updated records. ...

Filter function for updated records.

Parameters

item : Object
\n

fireEvent( eventName, args ) : Boolean

Fires the specified event with the passed parameters (minus the event name, plus the options object passed\nto addList...

Fires the specified event with the passed parameters (minus the event name, plus the options object passed\nto addListener).

\n\n

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by\ncalling enableBubble.

Parameters

eventName : String
The name of the event to fire.
\n
args : Object...
Variable number of parameters are passed to handlers.
\n

Returns

Boolean
returns false if any of the handlers return false otherwise it returns true.
\n

fireEventArgs( eventName, args ) : Boolean

Fires the specified event with the passed parameter list. ...

Fires the specified event with the passed parameter list.

\n\n

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by\ncalling enableBubble.

Parameters

eventName : String
The name of the event to fire.
\n
args : Object[]
An array of parameters which are passed to handlers.
\n

Returns

Boolean
returns false if any of the handlers return false otherwise it returns true.
\n

generateComparator( )

Returns a comparator function which compares two items and returns -1, 0, or 1 depending\non the currently defined set...

Returns a comparator function which compares two items and returns -1, 0, or 1 depending\non the currently defined set of sorters.

\n\n

If there are no sorters defined, it returns a function which returns 0 meaning\nthat no sorting will occur.

getBatchListeners( ) : Objectprivate

Returns an object which is passed in as the listeners argument to proxy.batch inside this.sync. ...

Returns an object which is passed in as the listeners argument to proxy.batch inside this.sync.\nThis is broken out into a separate function to allow for customisation of the listeners

Returns

Object
The listeners object
\n

getBubbleParent( ) : Ext.util.Observableprivate

Gets the bubbling parent for an Observable ...

Gets the bubbling parent for an Observable

Returns

Ext.util.Observable
The bubble parent. null is returned if no bubble target exists
\n

Ext.data.TreeStore
view source

getById( id )private

inherit docs ...

inherit docs

Parameters

id : Object
\n

Overrides: Ext.data.AbstractStore.getById

getConfig( name )private

...

Parameters

name : Object
\n

getCount( )private

to be implemented by subclasses ...

to be implemented by subclasses

getFirstSorter( ) : Ext.util.Sorterprotected

Gets the first sorter from the sorters collection, excluding\nany groupers that may be in place ...

Gets the first sorter from the sorters collection, excluding\nany groupers that may be in place

Returns

Ext.util.Sorter
The sorter, null if none exist
\n

getInitialConfig( [name] ) : Object/Mixed

Returns the initial configuration passed to constructor when instantiating\nthis class. ...

Returns the initial configuration passed to constructor when instantiating\nthis class.

Parameters

name : String (optional)
Name of the config option to return.
\n

Returns

Object/Mixed
The full config object or a single config value\nwhen name parameter specified.
\n

getModifiedRecords( ) : Ext.data.Model[]

Gets all records added or updated since the last commit. ...

Gets all records added or updated since the last commit. Note that the order of records\nreturned is not deterministic and does not indicate the order in which records were modified. Note also that\nremoved records are not included (use getRemovedRecords for that).

Returns

Ext.data.Model[]
The added and updated Model instances
\n

Ext.data.TreeStore
view source

getNewRecords( ) : Ext.data.Model[]

inherit docs\n\nReturns all Model instances that are either currently a phantom (e.g. ...

inherit docs

\n\n

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)

Returns

Ext.data.Model[]
The Model instances
\n

Overrides: Ext.data.AbstractStore.getNewRecords

Ext.data.TreeStore
view source

getNodeById( id ) : Ext.data.NodeInterface

Returns the record node by id ...

Returns the record node by id

Parameters

id : Object
\n

Returns

Ext.data.NodeInterface
\n

getProxy( ) : Ext.data.proxy.Proxy

Returns the proxy currently attached to this proxy instance ...

Returns the proxy currently attached to this proxy instance

Returns

Ext.data.proxy.Proxy
The Proxy instance
\n

getRemovedRecords( ) : Ext.data.Model[]

Returns any records that have been removed from the store but not yet destroyed on the proxy. ...

Returns any records that have been removed from the store but not yet destroyed on the proxy.

Returns

Ext.data.Model[]
The removed Model instances
\n

Ext.data.TreeStore
view source

getRootNode( ) : Ext.data.NodeInterface

Returns the root node for this tree. ...

Returns the root node for this tree.

Returns

Ext.data.NodeInterface
\n

getSorters( )private

...

getState( )private

Returns the grouping, sorting and filtered state of this Store. ...

Returns the grouping, sorting and filtered state of this Store.

Ext.data.TreeStore
view source

getUpdatedRecords( ) : Ext.data.Model[]

inherit docs\n\nReturns all Model instances that have been updated in the Store but not yet synchronized with the Proxy ...

inherit docs

\n\n

Returns all Model instances that have been updated in the Store but not yet synchronized with the Proxy

Returns

Ext.data.Model[]
The updated Model instances
\n

Overrides: Ext.data.AbstractStore.getUpdatedRecords

hasConfig( config )private

...

Parameters

config : Object
\n

hasListener( eventName ) : Boolean

Checks to see if this object has any listeners for a specified event, or whether the event bubbles. ...

Checks to see if this object has any listeners for a specified event, or whether the event bubbles. The answer\nindicates whether the event needs firing or not.

Parameters

eventName : String
The name of the event to check for
\n

Returns

Boolean
true if the event is being listened for or bubbles, else false
\n

initConfig( config ) : Ext.Basechainableprotected

Initialize configuration for this class. ...

Initialize configuration for this class. a typical example:

\n\n

Ext.define('My.awesome.Class', {\n    // The default config\n    config: {\n        name: 'Awesome',\n        isAwesome: true\n    },\n\n    constructor: function(config) {\n        this.initConfig(config);\n    }\n});\n\nvar awesome = new My.awesome.Class({\n    name: 'Super Awesome'\n});\n\nalert(awesome.getName()); // 'Super Awesome'\n

Parameters

config : Object
\n

Returns

Ext.Base
this
\n

initSortable( )

Performs initialization of this mixin. ...

Performs initialization of this mixin. Component classes using this mixin should call this method during their\nown initialization.

isFiltered( )private

...

isLoading( ) : Boolean

Returns true if the Store is currently performing a load operation ...

Returns true if the Store is currently performing a load operation

Returns

Boolean
True if the Store is currently loading
\n

Ext.data.TreeStore
view source

load( [options] )

Loads the Store using its configured proxy. ...

Loads the Store using its configured proxy.

Parameters

options : Object (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

Overrides: Ext.data.AbstractStore.load

mon( item, ename, [fn], [scope], [options] ) : Object

Shorthand for addManagedListener. ...

Shorthand for addManagedListener.

\n\n

Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is\ndestroyed.

Parameters

item : Ext.util.Observable/Ext.Element
The item to which to add a listener/listeners.
\n\n
ename : Object/String
The event name, or an object containing event name properties.
\n\n
fn : Function (optional)
If the ename parameter was an event name, this is the handler function.
\n\n
scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
\n\n
options : Object (optional)
If the ename parameter was an event name, this is the\naddListener options.
\n\n

Returns

Only when the destroyable option is specified.

\n\n\n\n\n

A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

\n\n\n\n\n

this.btnListeners =  = myButton.mon({\n    destroyable: true\n    mouseover:   function() { console.log('mouseover'); },\n    mouseout:    function() { console.log('mouseout'); },\n    click:       function() { console.log('click'); }\n});\n

\n\n\n\n\n

And when those listeners need to be removed:

\n\n\n\n\n

Ext.destroy(this.btnListeners);\n

\n\n\n\n\n

this.btnListeners.destroy();\n

\n\n

mun( item, ename, [fn], [scope] )

Shorthand for removeManagedListener. ...

Shorthand for removeManagedListener.

\n\n

Removes listeners that were added by the mon method.

Parameters

item : Ext.util.Observable/Ext.Element
The item from which to remove a listener/listeners.
\n\n
ename : Object/String
The event name, or an object containing event name properties.
\n\n
fn : Function (optional)
If the ename parameter was an event name, this is the handler function.
\n\n
scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
\n\n

on( eventName, [fn], [scope], [options] ) : Object

Shorthand for addListener. ...

Shorthand for addListener.

\n\n

Appends an event handler to this object. For example:

\n\n

myGridPanel.on(\"mouseover\", this.onMouseOver, this);\n

\n\n

The method also allows for a single argument to be passed which is a config object\ncontaining properties which specify multiple events. For example:

\n\n

myGridPanel.on({\n    cellClick: this.onCellClick,\n    mouseover: this.onMouseOver,\n    mouseout: this.onMouseOut,\n    scope: this // Important. Ensure \"this\" is correct during handler execution\n});\n

\n\n

One can also specify options for each event handler separately:

\n\n

myGridPanel.on({\n    cellClick: {fn: this.onCellClick, scope: this, single: true},\n    mouseover: {fn: panel.onMouseOver, scope: panel}\n});\n

\n\n

Names of methods in a specified scope may also be used. Note that\nscope MUST be specified to use this option:

\n\n

myGridPanel.on({\n    cellClick: {fn: 'onCellClick', scope: this, single: true},\n    mouseover: {fn: 'onMouseOver', scope: panel}\n});\n

Parameters

eventName : String/Object
The name of the event to listen for.\nMay also be an object who's property names are event names.
\n\n
fn : Function (optional)
The method the event invokes, or if scope is specified, the name* of the method within\nthe specified scope. Will be called with arguments\ngiven to fireEvent plus the options parameter described below.
\n\n
scope : Object (optional)
The scope (this reference) in which the handler function is\nexecuted. If omitted, defaults to the object which fired the event.
\n\n
options : Object (optional)
An object containing handler configuration.
\n\n\n\n\n
Note: Unlike in ExtJS 3.x, the options object will also be passed as the last\nargument to every event handler.
\n\n\n\n\n
This object may contain any of the following properties:
\n\n
- scope : Object
  The scope (this reference) in which the handler function is executed. If omitted,\n defaults to the object which fired the event.
  \n\n
- delay : Number
  The number of milliseconds to delay the invocation of the handler after the event fires.
  \n\n
- single : Boolean
  True to add a handler to handle just the next firing of the event, and then remove itself.
  \n\n
- buffer : Number
  Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed\n by the specified number of milliseconds. If the event fires again within that time,\n the original handler is not invoked, but the new handler is scheduled in its place.
  \n\n
- target : Ext.util.Observable
  Only call the handler if the event was fired on the target Observable, not if the event\n was bubbled up from a child Observable.
  \n\n
- element : String
  This option is only valid for listeners bound to Components.\n The name of a Component property which references an element to add a listener to.
  \n\n\n\n\n
  This option is useful during Component construction to add DOM event listeners to elements of\n Components which will exist only after the Component is rendered.\n For example, to add a click listener to a Panel's body:
  \n\n\n\n\n
```
  new Ext.panel.Panel({\n      title: 'The title',\n      listeners: {\n          click: this.handlePanelClick,\n          element: 'body'\n      }\n  });\n
```
  \n\n
- destroyable : Boolean (optional)
  When specified as true, the function returns A Destroyable object. An object which implements the destroy method which removes all listeners added in this call.
  \n\n
  Defaults to: false
- priority : Number (optional)
  An optional numeric priority that determines the order in which event handlers\n are run. Event handlers with no priority will be run as if they had a priority\n of 0. Handlers with a higher priority will be prioritized to run sooner than\n those with a lower priority. Negative numbers can be used to set a priority\n lower than the default. Internally, the framework uses a range of 1000 or\n greater, and -1000 or lesser for handers that are intended to run before or\n after all others, so it is recommended to stay within the range of -999 to 999\n when setting the priority of event handlers in application-level code.
  \n\n\n\n\n
  Combining Options
  \n\n\n\n\n
  Using the options argument, it is possible to combine different types of listeners:
  \n\n\n\n\n
  A delayed, one-time listener.
  \n\n\n\n\n
```
myPanel.on('hide', this.handleClick, this, {\n    single: true,\n    delay: 100\n});\n
```
  \n\n

Returns

Only when the destroyable option is specified.

\n\n\n\n\n

A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

\n\n\n\n\n

this.btnListeners =  = myButton.on({\n    destroyable: true\n    mouseover:   function() { console.log('mouseover'); },\n    mouseout:    function() { console.log('mouseout'); },\n    click:       function() { console.log('click'); }\n});\n

\n\n\n\n\n

And when those listeners need to be removed:

\n\n\n\n\n

Ext.destroy(this.btnListeners);\n

\n\n\n\n\n

this.btnListeners.destroy();\n

\n\n

onBatchComplete( batch, operation )private

Attached as the 'complete' event listener to a proxy's Batch object. ...

Attached as the 'complete' event listener to a proxy's Batch object. Iterates over the batch operations\nand updates the Store's internal data MixedCollection.

Parameters

batch : Object
\n
operation : Object
\n

onBatchException( batch, operation )private

...

Parameters

batch : Object
\n
operation : Object
\n

onBatchOperationComplete( batch, operation )private

Attached as the 'operationcomplete' event listener to a proxy's Batch object. ...

Attached as the 'operationcomplete' event listener to a proxy's Batch object. By default just calls through\nto onProxyWrite.

Parameters

batch : Object
\n
operation : Object
\n

Ext.data.TreeStore
view source

onBeforeNodeExpand( node, callback, scope, args )private

Fired by the root node. ...

Fired by the root node.

\n\n

Called before a node is expanded.

\n\n

This ensures that the child nodes are available before calling the passed callback.

Parameters

node : Ext.data.NodeInterface
The node being expanded.
\n
callback : Function
The function to run after the expand finishes
\n
scope : Object
The scope in which to run the callback function
\n
args : Array
The extra args to pass to the callback after the new child nodes
\n

Ext.data.TreeStore
view source

onBeforeSort( )private

inherit docs ...

inherit docs

Overrides: Ext.util.Sortable.onBeforeSort

onClassExtended( cls, data, hooks )private

...

Parameters

cls : Object
\n
data : Object
\n
hooks : Object
\n

onConfigUpdate( names, callback, scope )private

...

Parameters

names : Object
\n
callback : Object
\n
scope : Object
\n

onCreateRecords( )private

may be implemented by store subclasses ...

may be implemented by store subclasses

onDestroyRecords( records, operation, success )private

Removes any records when a write is returned from the server. ...

Removes any records when a write is returned from the server.

Parameters

records : Ext.data.Model[]
The array of removed records
\n
operation : Ext.data.Operation
The operation that just completed
\n
success : Boolean
True if the operation was successful
\n

Ext.data.TreeStore
view source

onIdChanged( model, oldId, newId, oldInternalId )private

...

Parameters

model : Object
\n
oldId : Object
\n
newId : Object
\n
oldInternalId : Object
\n

Overrides: Ext.data.AbstractStore.onIdChanged

onMetaChange( proxy, meta )private

private ...

private

Parameters

proxy : Object
\n
meta : Object
\n

Ext.data.TreeStore
view source

onNodeAdded( parent, node )private

...

Parameters

parent : Object
\n
node : Object
\n

Ext.data.TreeStore
view source

onNodeRemove( parent, node, isMove )private

...

Parameters

parent : Object
\n
node : Object
\n
isMove : Object
\n

Ext.data.TreeStore
view source

onNodeSort( )private

...

Ext.data.TreeStore
view source

onProxyLoad( operation )private

inherit docs ...

inherit docs

Parameters

operation : Object
\n

onProxyWrite( operation )private

Callback for any write Operation over the Proxy. ...

Callback for any write Operation over the Proxy. Updates the Store's MixedCollection to reflect\nthe updates provided by the Proxy

Parameters

operation : Object
\n

onUpdate( )private

...

onUpdateRecords( )private

may be implemented by store subclasses ...

may be implemented by store subclasses

prepareClass( T )private

Prepares a given class for observable instances. ...

Prepares a given class for observable instances. This method is called when a\nclass derives from this class or uses this class as a mixin.

Parameters

T : Function
The class constructor to prepare.
\n

read( )private

...

relayEvents( origin, events, [prefix] ) : Object

Relays selected events from the specified Observable as if the events were fired by this. ...

Relays selected events from the specified Observable as if the events were fired by this.

\n\n

For example if you are extending Grid, you might decide to forward some events from store.\nSo you can do this inside your initComponent:

\n\n

this.relayEvents(this.getStore(), ['load']);\n

\n\n

The grid instance will then have an observable 'load' event which will be passed the\nparameters of the store's load event and any function fired with the grid's load event\nwould have access to the grid using the this keyword.

Parameters

origin : Object
The Observable whose events this object is to relay.
\n
events : String[]
Array of event names to relay.
\n
prefix : String (optional)
A common prefix to prepend to the event names. For example:
\n\n
```
this.relayEvents(this.getStore(), ['load', 'clear'], 'store');\n
```
\n\n
Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'.
\n

Returns

Object
A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example:
\n\n
```
this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store');\n
```
\n\n
Can be undone by calling
\n\n
```
Ext.destroy(this.storeRelayers);\n
```
\n\n
or
\n\n
```
this.store.relayers.destroy();\n
```
\n

reload( options )

Reloads the store using the last options passed to the load method. ...

Reloads the store using the last options passed to the load method.

Parameters

options : Object
A config object which contains options which may override the options passed to the previous load call.
\n

Ext.data.TreeStore
view source

removeAll( )

inherit docs\n\nRemoves all records from the store. ...

inherit docs

\n\n

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.

Available since: 1.1.0

Overrides: Ext.data.AbstractStore.removeAll

removeListener( eventName, fn, [scope] )

Removes an event handler. ...

Removes an event handler.

Parameters

eventName : String
The type of event the handler was associated with.
\n\n
fn : Function
The handler to remove. This must be a reference to the function passed into the\naddListener call.
\n\n
scope : Object (optional)
The 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\n

removeManagedListener( item, ename, [fn], [scope] )

Removes listeners that were added by the mon method. ...

Removes listeners that were added by the mon method.

Parameters

item : Ext.util.Observable/Ext.Element
The item from which to remove a listener/listeners.
\n\n
ename : Object/String
The event name, or an object containing event name properties.
\n\n
fn : Function (optional)
If the ename parameter was an event name, this is the handler function.
\n\n
scope : Object (optional)
If the ename parameter was an event name, this is the scope (this reference)\nin which the handler function is executed.
\n\n

removeManagedListenerItem( isClear, managedListener )private

Remove a single managed listener item ...

Remove a single managed listener item

Parameters

isClear : Boolean
True if this is being called during a clear
\n
managedListener : Object
The managed listener item\nSee removeManagedListener for other args
\n

resumeAutoSync( )

Resumes automatically syncing the Store with its Proxy. ...

Resumes automatically syncing the Store with its Proxy. Only applicable if autoSync is true

resumeEvent( eventName )

Resumes firing of the named event(s). ...

Resumes firing of the named event(s).

\n\n

After calling this method to resume events, the events will fire when requested to fire.

\n\n

Note that if the suspendEvent method is called multiple times for a certain event,\nthis converse method will have to be called the same number of times for it to resume firing.

Parameters

eventName : String...
Multiple event names to resume.
\n

resumeEvents( )

Resumes firing events (see suspendEvents). ...

Resumes firing events (see suspendEvents).

\n\n

If events were suspended using the queueSuspended parameter, then all events fired\nduring event suspension will be sent to any listeners now.

save( )deprecated

Saves all pending changes via the configured proxy. ...

Saves all pending changes via the configured proxy. Use sync instead.

This method has been deprecated since 4.0.0

Will be removed in the next major version

\n\n

setConfig( config, applyIfNotSet ) : Ext.Basechainableprivate

...

Parameters

config : Object
\n
applyIfNotSet : Object
\n

Returns

Ext.Base
this
\n

Ext.data.TreeStore
view source

setProxy( proxy ) : Ext.data.proxy.Proxy

inherit docs\n\nSets the Store's Proxy by string, config object or Proxy instance ...

inherit docs

\n\n

Sets the Store's Proxy by string, config object or Proxy instance

Parameters

proxy : String/Object/Ext.data.proxy.Proxy
The new Proxy, which can be either a type string, a configuration object\nor an Ext.data.proxy.Proxy instance
\n

Returns

Ext.data.proxy.Proxy
The attached Proxy object
\n

Overrides: Ext.data.AbstractStore.setProxy

Ext.data.TreeStore
view source

setRootNode( root ) : Ext.data.NodeInterface

Sets the root node for this store. ...

Sets the root node for this store. See also the root config option.

Parameters

root : Ext.data.Model/Ext.data.NodeInterface/Object
\n

Returns

Ext.data.NodeInterface
The new root
\n

sort( [sorters], [direction] ) : Ext.util.Sorter[]

Sorts the data in the Store by one or more of its properties. ...

Sorts 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\n

Internally, 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\n

When passing a single string argument to sort, Store maintains a ASC/DESC toggler per field, so this code:

\n\n

store.sort('myField');\nstore.sort('myField');\n

\n\n

Is equivalent to this code, because Store handles the toggling automatically:

\n\n

store.sort('myField', 'ASC');\nstore.sort('myField', 'DESC');\n

Parameters

sorters : String/Ext.util.Sorter[] (optional)
Either a string name of one of the fields in this Store's configured\nModel, or an array of sorter configurations.
\n
direction : String (optional)
The overall direction to sort the data by.
\n
Defaults to: "ASC"

Returns

Ext.util.Sorter[]
\n

Ext.data.TreeStore
view source

sortByIndex( node1, node2 ) : Numberprivate

Sorter function for sorting records in index order ...

Sorter function for sorting records in index order

Parameters

node1 : Ext.data.NodeInterface
\n
node2 : Ext.data.NodeInterface
\n

Returns

Number
\n

statics( ) : Ext.Classprotected

Get the reference to the class from which this object was instantiated. ...

Get 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

\n\n

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\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

Returns

Ext.Class
\n

suspendAutoSync( )

Suspends automatically syncing the Store with its Proxy. ...

Suspends automatically syncing the Store with its Proxy. Only applicable if autoSync is true

suspendEvent( eventName )

Suspends firing of the named event(s). ...

Suspends firing of the named event(s).

\n\n

After calling this method to suspend events, the events will no longer fire when requested to fire.

\n\n

Note that if this is called multiple times for a certain event, the converse method\nresumeEvent will have to be called the same number of times for it to resume firing.

Parameters

eventName : String...
Multiple event names to suspend.
\n

suspendEvents( queueSuspended )

Suspends the firing of all events. ...

Suspends the firing of all events. (see resumeEvents)

Parameters

queueSuspended : Boolean
Pass as true to queue up suspended events to be fired\nafter the resumeEvents call instead of discarding all suspended events.
\n

sync( [options] ) : Ext.data.Store

Synchronizes the store with its proxy. ...

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.

Parameters

options : Object (optional)
Object containing one or more properties supported by the sync method (these get\npassed along to the underlying proxy's batch method):
\n
- batch : Ext.data.Batch/Object (optional)
  A Ext.data.Batch object (or batch config to apply\nto the created batch). If unspecified a default batch will be auto-created as needed.
  \n
- callback : Function (optional)
  The function to be called upon completion of the sync.\nThe callback is called regardless of success or failure and is passed the following parameters:
  \n
  Parameters
  - batch : Ext.data.Batch
    The batch that was processed,\ncontaining all operations in their current state after processing
    \n
  - options : Object
    The options argument that was originally passed into sync
    \n
- success : Function (optional)
  The function to be called upon successful completion of the sync. The\nsuccess function is called only if no exceptions were reported in any operations. If one or more exceptions\noccurred then the failure function will be called instead. The success function is called\nwith the following parameters:
  \n
  Parameters
  - batch : Ext.data.Batch
    The batch that was processed,\ncontaining all operations in their current state after processing
    \n
  - options : Object
    The options argument that was originally passed into sync
    \n
- failure : Function (optional)
  The function to be called upon unsuccessful completion of the sync. The\nfailure function is called when one or more operations returns an exception during processing (even if some\noperations were also successful). In this case you can check the batch's exceptions array to see exactly which operations had exceptions. The failure function is called with the\nfollowing parameters:
  \n
  Parameters
  - batch : Ext.data.Batch
    The Ext.data.Batch that was processed, containing all\noperations in their current state after processing
    \n
  - options : Object
    The options argument that was originally passed into sync
    \n
- scope : Object (optional)
  The scope in which to execute any callbacks (i.e. the this object inside\nthe callback, success and/or failure functions). Defaults to the store's proxy.
  \n

Returns

Ext.data.Store
this
\n

un( eventName, fn, [scope] )

Shorthand for removeListener. ...

Shorthand for removeListener.

\n\n

Removes an event handler.

Parameters

eventName : String
The type of event the handler was associated with.
\n\n
fn : Function
The handler to remove. This must be a reference to the function passed into the\naddListener call.
\n\n
scope : Object (optional)
The 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\n

update( options )private

...

Parameters

options : Object
\n

Defined By

Static Methods

addConfig( config )privatestatic

...

Parameters

config : Object
\n

addInheritableStatics( members )chainableprivatestatic

...

Parameters

members : Object
\n

addMember( name, member )chainableprivatestatic

...

Parameters

name : Object
\n
member : Object
\n

addMembers( members )chainablestatic

Add methods / properties to the prototype of this class. ...

Add methods / properties to the prototype of this class.

\n\n

Ext.define('My.awesome.Cat', {\n    constructor: function() {\n        ...\n    }\n});\n\n My.awesome.Cat.addMembers({\n     meow: function() {\n        alert('Meowww...');\n     }\n });\n\n var kitty = new My.awesome.Cat;\n kitty.meow();\n

Parameters

members : Object
\n

addStatics( members ) : Ext.Basechainablestatic

Add / override static properties of this class. ...

Add / override static properties of this class.

\n\n

Ext.define('My.cool.Class', {\n    ...\n});\n\nMy.cool.Class.addStatics({\n    someProperty: 'someValue',      // My.cool.Class.someProperty = 'someValue'\n    method1: function() { ... },    // My.cool.Class.method1 = function() { ... };\n    method2: function() { ... }     // My.cool.Class.method2 = function() { ... };\n});\n

Parameters

members : Object
\n

Returns

Ext.Base
this
\n

addXtype( xtype )chainableprivatestatic

...

Parameters

xtype : Object
\n

borrow( fromClass, members ) : Ext.Basechainableprivatestatic

Borrow another class' members to the prototype of this class. ...

Borrow another class' members to the prototype of this class.

\n\n

Ext.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

Parameters

fromClass : Ext.Base
The class to borrow members from
\n
members : Array/String
The names of the members to borrow
\n

Returns

Ext.Base
this
\n

createAlias( alias, origin )static

Create aliases for existing prototype methods. ...

Create aliases for existing prototype methods. Example:

\n\n

Ext.define('My.cool.Class', {\n    method1: function() { ... },\n    method2: function() { ... }\n});\n\nvar test = new My.cool.Class();\n\nMy.cool.Class.createAlias({\n    method3: 'method1',\n    method4: 'method2'\n});\n\ntest.method3(); // test.method1()\n\nMy.cool.Class.createAlias('method5', 'method3');\n\ntest.method5(); // test.method3() -> test.method1()\n

Parameters

alias : String/Object
The new method name, or an object to set multiple aliases. See\nflexSetter
\n
origin : String/Object
The original method name
\n

extend( config )privatestatic

...

Parameters

config : Object
\n

getName( ) : Stringstatic

Get the current class' name in string format. ...

Get the current class' name in string format.

\n\n

Ext.define('My.cool.Class', {\n    constructor: function() {\n        alert(this.self.getName()); // alerts 'My.cool.Class'\n    }\n});\n\nMy.cool.Class.getName(); // 'My.cool.Class'\n

Returns

String
className
\n

implement( )deprecatedstatic

Adds members to class. ...

Adds members to class.

This method has been deprecated since 4.1

Use addMembers instead.

\n\n

mixin( name, mixinClass )privatestatic

Used internally by the mixins pre-processor ...

Used internally by the mixins pre-processor

Parameters

name : Object
\n
mixinClass : Object
\n

onExtended( fn, scope )chainableprivatestatic

...

Parameters

fn : Object
\n
scope : Object
\n

override( members ) : Ext.Basechainabledeprecatedstatic

Override members of this class. ...

Override members of this class. Overridden methods can be invoked via\ncallParent.

\n\n

Ext.define('My.Cat', {\n    constructor: function() {\n        alert(\"I'm a cat!\");\n    }\n});\n\nMy.Cat.override({\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callParent(arguments);\n\n        alert(\"Meeeeoooowwww\");\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\n

As of 4.1, direct use of this method is deprecated. Use Ext.define\ninstead:

\n\n

Ext.define('My.CatOverride', {\n    override: 'My.Cat',\n    constructor: function() {\n        alert(\"I'm going to be a cat!\");\n\n        this.callParent(arguments);\n\n        alert(\"Meeeeoooowwww\");\n    }\n});\n

\n\n

The above accomplishes the same result but can be managed by the Ext.Loader\nwhich can properly order the override and its target class and the build process\ncan determine whether the override is needed based on the required state of the\ntarget class (My.Cat).

This method has been deprecated since 4.1.0

Use Ext.define instead

\n\n

Parameters

members : Object
The properties to add to this class. This should be\nspecified as an object literal containing one or more properties.
\n

Returns

Ext.Base
this class
\n

triggerExtended( )privatestatic

...

Defined By

Events

add( store, records, index, eOpts )

Fired when a Model instance has been added to this Store. ...

Fired when a Model instance has been added to this Store.

Available since: 1.1.0

Parameters

store : Ext.data.Store
The store
\n
records : Ext.data.Model[]
The Model instances that were added
\n
index : Number
The index at which the instances were inserted
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

Ext.data.TreeStore
view source

append( this, node, index, eOpts )

Fires when a new child node is appended ...

Fires when a new child node is appended

Parameters

this : Ext.data.NodeInterface
This node
\n
node : Ext.data.NodeInterface
The newly appended node
\n
index : Number
The index of the newly appended node
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

Ext.data.TreeStore
view source

beforeappend( this, node, eOpts )

Fires before a new child is appended, return false to cancel the append. ...

Fires before a new child is appended, return false to cancel the append.

Parameters

this : Ext.data.NodeInterface
This node
\n
node : Ext.data.NodeInterface
The child node to be appended
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

Ext.data.TreeStore
view source

beforecollapse( this, eOpts )

Fires before this node is collapsed. ...

Fires before this node is collapsed.

Parameters

this : Ext.data.NodeInterface
The collapsing node
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

Ext.data.TreeStore
view source

beforeexpand( this, eOpts )

Fires before this node is expanded. ...

Fires before this node is expanded.

Parameters

this : Ext.data.NodeInterface
The expanding node
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

Ext.data.TreeStore
view source

beforeinsert( this, node, refNode, eOpts )

Fires before a new child is inserted, return false to cancel the insert. ...

Fires before a new child is inserted, return false to cancel the insert.

Parameters

this : Ext.data.NodeInterface
This node
\n
node : Ext.data.NodeInterface
The child node to be inserted
\n
refNode : Ext.data.NodeInterface
The child node the node is being inserted before
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

beforeload( store, operation, eOpts )

Fires before a request is made for a new data object. ...

Fires before a request is made for a new data object. If the beforeload handler returns false the load\naction will be canceled.

Available since: 1.1.0

Parameters

store : Ext.data.Store
This Store
\n
operation : Ext.data.Operation
The Ext.data.Operation object that will be passed to the Proxy to\nload the Store
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

Ext.data.TreeStore
view source

beforemove( this, oldParent, newParent, index, eOpts )

Fires before this node is moved to a new location in the tree. ...

Fires before this node is moved to a new location in the tree. Return false to cancel the move.

Parameters

this : Ext.data.NodeInterface
This node
\n
oldParent : Ext.data.NodeInterface
The parent of this node
\n
newParent : Ext.data.NodeInterface
The new parent this node is moving to
\n
index : Number
The index it is being moved to
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

Ext.data.TreeStore
view source

beforeremove( this, node, isMove, eOpts )

Fires before a child is removed, return false to cancel the remove. ...

Fires before a child is removed, return false to cancel the remove.

Parameters

this : Ext.data.NodeInterface
This node
\n
node : Ext.data.NodeInterface
The child node to be removed
\n
isMove : Boolean
true if the child node is being removed so it can be moved to another position in the tree.\n(a side effect of calling appendChild or\ninsertBefore with a node that already has a parentNode)
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

beforesync( options, eOpts )

Fired before a call to sync is executed. ...

Fired before a call to sync is executed. Return false from any listener to cancel the sync

Parameters

options : Object
Hash of all records to be synchronized, broken down into create, update and destroy
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

bulkremove( store, records, indexes, isMove, eOpts )

Fired at the end of the remove method when all records in the passed array have been removed. ...

Fired at the end of the remove method when all records in the passed array have been removed.

\n\n

If many records may be removed in one go, then it is more efficient to listen for this event\nand perform any processing for a bulk remove than to listen for many remove events.

Parameters

store : Ext.data.Store
The Store object
\n
records : Ext.data.Model[]
The array of records that were removed (In the order they appear in the Store)
\n
indexes : Number[]
The indexes of the records that were removed
\n
isMove : Boolean
true if the child nodes are being removed so they can be moved to another position in this Store.
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

clear( this, eOpts )

Fired after the removeAll method is called. ...

Fired after the removeAll method is called.

Available since: 1.1.0

Parameters

this : Ext.data.Store
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

Ext.data.TreeStore
view source

collapse( this, eOpts )

Fires when this node is collapsed. ...

Fires when this node is collapsed.

Parameters

this : Ext.data.NodeInterface
The collapsing node
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

datachanged( this, eOpts )

Fires whenever the records in the Store have changed in some way - this could include adding or removing\nrecords, or ...

Fires 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

Available since: 1.1.0

Parameters

this : Ext.data.Store
The data store
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

Ext.data.TreeStore
view source

expand( this, eOpts )

Fires when this node is expanded. ...

Fires when this node is expanded.

Parameters

this : Ext.data.NodeInterface
The expanding node
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

Ext.data.TreeStore
view source

insert( this, node, refNode, eOpts )

Fires when a new child node is inserted. ...

Fires when a new child node is inserted.

Parameters

this : Ext.data.NodeInterface
This node
\n
node : Ext.data.NodeInterface
The child node inserted
\n
refNode : Ext.data.NodeInterface
The child node the node was inserted before
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

Ext.data.TreeStore
view source

load( this, node, records, successful, eOpts )

Fires whenever the store reads data from a remote data source. ...

Fires whenever the store reads data from a remote data source.

Parameters

this : Ext.data.TreeStore
\n
node : Ext.data.NodeInterface
The node that was loaded.
\n
records : Ext.data.Model[]
An array of records.
\n
successful : Boolean
True if the operation was successful.
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

Overrides: Ext.data.AbstractStore.load

metachange( this, meta, eOpts )

Fires when this store's underlying reader (available via the proxy) provides new metadata. ...

Fires when this store's underlying reader (available via the proxy) provides new metadata.\nMetadata usually consists of new field definitions, but can include any configuration data\nrequired by an application, and can be processed as needed in the event handler.\nThis event is currently only fired for JsonReaders.

Available since: 1.1.0

Parameters

this : Ext.data.Store
\n
meta : Object
The JSON metadata
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

Ext.data.TreeStore
view source

move( this, oldParent, newParent, index, eOpts )

Fires when this node is moved to a new location in the tree ...

Fires when this node is moved to a new location in the tree

Parameters

this : Ext.data.NodeInterface
This node
\n
oldParent : Ext.data.NodeInterface
The old parent of this node
\n
newParent : Ext.data.NodeInterface
The new parent of this node
\n
index : Number
The index it was moved to
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

refresh( this, eOpts )

Fires when the data cache has changed in a bulk manner (e.g., it has been sorted, filtered, etc.) and a\nwidget that i...

Fires when the data cache has changed in a bulk manner (e.g., it has been sorted, filtered, etc.) and a\nwidget that is using this Store as a Record cache should refresh its view.

Parameters

this : Ext.data.Store
The data store
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

Ext.data.TreeStore
view source

remove( this, node, isMove, eOpts )

Fires when a child node is removed ...

Fires when a child node is removed

Parameters

this : Ext.data.NodeInterface
This node
\n
node : Ext.data.NodeInterface
The removed node
\n
isMove : Boolean
true if the child node is being removed so it can be moved to another position in the tree.\n(a side effect of calling appendChild or\ninsertBefore with a node that already has a parentNode)
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

Overrides: Ext.data.AbstractStore.remove

Ext.data.TreeStore
view source

sort( this, childNodes, eOpts )

Fires when this node's childNodes are sorted. ...

Fires when this node's childNodes are sorted.

Parameters

this : Ext.data.NodeInterface
This node.
\n
childNodes : Ext.data.NodeInterface[]
The childNodes of this node.
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n

update( this, record, operation, eOpts )

Fires when a Model instance has been updated. ...

Fires when a Model instance has been updated.

Available since: 1.1.0

Parameters

this : Ext.data.Store
\n
record : Ext.data.Model
The Model instance that was updated
\n
operation : String
The update operation being performed. Value may be one of:
\n\n
```
Ext.data.Model.EDIT\nExt.data.Model.REJECT\nExt.data.Model.COMMIT\n
```
\n\n
@param {String[]} modifiedFieldNames Array of field names changed during edit.
\n
eOpts : Object
The options object passed to Ext.util.Observable.addListener.
\n\n\n\n