For up to date documentation and features, visit http://docs.sencha.com/ext-js/4-0

## Sencha Documentation

# Ext.data.TreeStore

####

####

    HierarchyExt.data.AbstractStoreExt.data.TreeStoreMixinsExt.util.ObservableExt.util.Sortable

The TreeStore is a store implementation that is backed by by an Ext.data.Tree. It provides convenience methods for loading nodes, as well as the ability to use the hierarchical tree structure combined with a store. This class is generally used in conjunction with Ext.tree.Panel. This class also relays many events from the Tree for convenience.

## Using Models

If no Model is specified, an implicit model will be created that implements Ext.data.NodeInterface. The standard Tree fields will also be copied onto the Model for maintaining their state.

## Reading Nested Data

For the tree to read nested data, the Ext.data.Reader must be configured with a root property, so the reader can find nested data for each node. If a root is not specified, it will default to 'children'.

Defined By

### Config Options

#### Other Configs

Ext.data.AbstractStore
view source
autoLoad : Boolean/Object
If data is not specified, and if autoLoad is true or an Object, this store's load method is automatically called afte...

If data is not specified, and if autoLoad is true or an Object, this store's load method is automatically called after creation. If the value of autoLoad is an Object, this Object will be passed to the store's load method. Defaults to false.

Ext.data.AbstractStore
view source
autoSync : Boolean

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

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

Ext.data.TreeStore
view source
clearOnLoad : Boolean

(optional) Default to true. Remove previously existing child nodes before loading.

(optional) Default to true. Remove previously existing child nodes before loading.

Ext.data.TreeStore
view source
defaultRootId : String

The default root id. Defaults to 'root'

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.

Ext.data.AbstractStore
view source
fields : Array
This may be used in place of specifying a model configuration. The fields should be a set of Ext.data.Field configura...

This may be used in place of specifying a model configuration. The fields should be a set of Ext.data.Field configuration objects. The store will automatically create a Ext.data.Model with these fields. In general this configuration option should be avoided, it exists for the purposes of backwards compatibility. For anything more complicated, such as specifying a particular id property or assocations, a Ext.data.Model should be defined and specified for the model config.

Ext.data.TreeStore
view source
folderSort : Boolean

Set to true to automatically prepend a leaf sorter (defaults to `undefined`)

Set to true to automatically prepend a leaf sorter (defaults to `undefined`)

Ext.util.Observable
view source
listeners : Object
(optional) A config object containing one or more event handlers to be added to this object during initialization. T...

(optional)

A config object containing one or more event handlers to be added to this object during initialization. This should be a valid listeners config object as specified in the addListener example for attaching multiple handlers at once.

DOM events from ExtJs Components

While some ExtJs Component classes export selected DOM events (e.g. "click", "mouseover" etc), this

is usually only done when extra value can be added. For example the DataView's `click` event passing the node clicked on. To access DOM events directly from a child element of a Component, we need to specify the `element` option to identify the Component property to add a DOM listener to:

    new Ext.panel.Panel({
        width: 400,
        height: 200,
        dockedItems: [{
            xtype: 'toolbar'
        }],
        listeners: {
            click: {
                element: 'el', //bind to the underlying el property on the panel
                fn: function(){ console.log('click el'); }
            },
            dblclick: {
                element: 'body', //bind to the underlying body property on the panel
                fn: function(){ console.log('dblclick body'); }
            }
        }
    });

Ext.data.TreeStore
view source
nodeParam : String

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

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

Ext.data.AbstractStore
view source
proxy : String/Ext.data.proxy.Proxy/Object
The Proxy to use for this Store. This can be either a string, a config object or a Proxy instance - see setProxy for ...

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

Ext.data.AbstractStore
view source
storeId : String
Optional unique identifier for this store. If present, this Store will be registered with the Ext.data.StoreManager, ...

Optional unique identifier for this store. If present, this Store will be registered with the Ext.data.StoreManager, making it easy to reuse elsewhere. Defaults to undefined.

Defined By

### Properties

Ext.data.TreeStore
view source
: Object
Loop over each record returned from the server. Assume they are returned in order of how they were sent. If we find a...

Loop over each record returned from the server. Assume they are returned in order of how they were sent. If we find a matching record, replace it with the newly created one.

Ext.data.AbstractStore
view source
batchUpdateMode : String
Sets the updating behavior based on batch synchronization. 'operation' (the default) will update the Store's internal...

Sets the updating behavior based on batch synchronization. 'operation' (the default) will update the Store's internal representation of the data after each operation of the batch has completed, 'complete' will wait until the entire batch has been completed before updating the Store's data. 'complete' is a good choice for local storage proxies, 'operation' is better for remote proxies, where there is a comparatively high latency.

Ext.data.AbstractStore
view source
defaultProxyType : String

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

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

Ext.util.Sortable
view source
defaultSortDirection : String

The default sort direction to use if one is not specified (defaults to "ASC")

The default sort direction to use if one is not specified (defaults to "ASC")

Ext.data.TreeStore
view source
fields : Object
If we have no fields declare for the store, add some defaults. These will be ignored if a model is explicitly specifi...

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

Ext.data.AbstractStore
view source
filterOnLoad : Boolean
If true, any filters attached to this Store will be run after loading data, before the datachanged event is fired. De...

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

Ext.data.AbstractStore
view source
filters : Ext.util.MixedCollection

The collection of Filters currently applied to this Store

The collection of Filters currently applied to this Store

Ext.data.AbstractStore
view source
isDestroyed : Boolean
True if the Store has already been destroyed via destroyStore. If this is true, the reference to Store should be dele...

True if the Store has already been destroyed via destroyStore. If this is true, the reference to Store should be deleted as it will not function correctly any more.

Ext.util.Sortable
view source
isSortable : Boolean

Flag denoting that this object is sortable. Always true.

Flag denoting that this object is sortable. Always true.

Ext.data.AbstractStore
view source
removeAll : Object
Removes all records from the store. This method does a "fast remove", individual remove events are not called. The cl...

Removes all records from the store. This method does a "fast remove", individual remove events are not called. The clear event is fired upon completion.

Ext.data.AbstractStore
view source
sortOnLoad : Boolean
If true, any sorters attached to this Store will be run after loading data, before the datachanged event is fired. De...

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

Ext.util.Sortable
view source
sortRoot : String

The property in each item that contains the data to sort. (defaults to null)

The property in each item that contains the data to sort. (defaults to null)

Ext.util.Sortable
view source
sorters : Ext.util.MixedCollection

The collection of Sorters currently applied to this Store

The collection of Sorters currently applied to this Store

Defined By

### Methods

Ext.util.Observable
view source
addEvents( Object/String o, String ) : void

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

- o : Object/String

  Either an object with event names as properties with a value of `true` or the first event name string if multiple event names are being passed as separate parameters.

- : String

  [additional] Optional additional event names if multiple event names are being passed as separate parameters. Usage:

      this.addEvents('storeloaded', 'storecleared');

### Returns

- void

Ext.util.Observable
view source
addListener( String eventName, Function handler, [Object scope], [Object options]) : void

Appends an event handler to this object.

Appends an event handler to this object.

### Parameters

- eventName : String

  The name of the event to listen for. May also be an object who's property names are event names. See

- handler : Function

  The method the event invokes.

- scope : Object

  (optional) The scope (`this` reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

- options : Object

  (optional) An object containing handler configuration. properties. This may contain any of the following properties:

  - scope : Object
    The scope (`this` reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.
  - delay : Number
    The number of milliseconds to delay the invocation of the handler after the event fires.
  - single : Boolean
    True to add a handler to handle just the next firing of the event, and then remove itself.
  - buffer : Number
    Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.
  - target : Observable
    Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.
  - element : String
    This option is only valid for listeners bound to Components. The name of a Component property which references an element to add a listener to.

    This option is useful during Component construction to add DOM event listeners to elements of Components which will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:

        new Ext.panel.Panel({
            title: 'The title',
            listeners: {
                click: this.handlePanelClick,
                element: 'body'
            }
        });

    When added in this way, the options available are the options applicable to Ext.core.Element.addListener

  Combining Options
  Using the options argument, it is possible to combine different types of listeners:
  A delayed, one-time listener.

      myPanel.on('hide', this.handleClick, this, {
      single: true,
      delay: 100
      });

  Attaching multiple handlers in 1 call
  The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:

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

  .

### Returns

- void

Ext.util.Observable
view source
addManagedListener( Observable/Element item, Object/String ename, Function fn, Object scope, Object opt) : void

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

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

### Parameters

- item : Observable/Element

  The item to which to add a listener/listeners.

- ename : Object/String

  The event name, or an object containing event name properties.

- fn : Function

  Optional. If the `ename` parameter was an event name, this is the handler function.

- scope : Object

  Optional. If the `ename` parameter was an event name, this is the scope (`this` reference) in which the handler function is executed.

- opt : Object

  Optional. If the `ename` parameter was an event name, this is the addListener options.

### Returns

- void

Ext.util.Observable
view source
capture( Observable o, Function fn, [Object scope]) : void
Starts capture on the specified Observable. All events will be passed to the supplied function with the event name + ...

Starts capture on the specified Observable. All events will be passed to the supplied function with the event name + standard signature of the event before the event is fired. If the supplied function returns false, the event will not fire.

### Parameters

- o : Observable

  The Observable to capture events from.

- fn : Function

  The function to call when an event is fired.

- scope : Object

  (optional) The scope (`this` reference) in which the function is executed. Defaults to the Observable firing the event.

### Returns

- void

Ext.util.Observable
view source
clearListeners : void

Removes all listeners for this object including the managed listeners

Removes all listeners for this object including the managed listeners

### Returns

- void

Ext.util.Observable
view source
clearManagedListeners : void

Removes all managed listeners for this object.

Removes all managed listeners for this object.

### Returns

- void

Ext.util.Observable
view source
enableBubble( String/Array events) : void
Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present....

Enables events fired by this Observable to bubble up an owner hierarchy by calling `this.getBubbleTarget()` if present. There is no implementation in the Observable base class.

This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly.

Example:

    Ext.override(Ext.form.field.Base, {
    //  Add functionality to Field's initComponent to enable the change event to bubble
    initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
        this.enableBubble('change');
    }),

    //  We know that we want Field's events to bubble directly to the FormPanel.
    getBubbleTarget : function() {
        if (!this.formPanel) {
            this.formPanel = this.findParentByType('form');
        }
        return this.formPanel;
    }
    });

    var myForm = new Ext.formPanel({
    title: 'User Details',
    items: [{
        ...
    }],
    listeners: {
        change: function() {
            // Title goes red if form has been modified.
            myForm.header.setStyle('color', 'red');
        }
    }
    });

### Parameters

- events : String/Array

  The event name to bubble, or an Array of event names.

### Returns

- void

Ext.util.Observable
view source
fireEvent( String eventName, Object... args) : Boolean
Fires the specified event with the passed parameters (minus the event name). An event may be set to bubble up an Ob...

Fires the specified event with the passed parameters (minus the event name).

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

### Parameters

- eventName : String

  The name of the event to fire.

- args : Object...

  Variable number of parameters are passed to handlers.

### Returns

- Boolean

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

Ext.data.AbstractStore
view source
getNewRecords : Array
Returns all Model instances that are either currently a phantom (e.g. have no id), or have an ID but have not yet bee...

Returns all Model instances that are either currently a phantom (e.g. have no id), or have an ID but have not yet been saved on this Store (this happens when adding a non-phantom record from another Store into this one)

### Returns

- Array

  The Model instances

Ext.data.TreeStore
view source
getNodeById( Object id) : Ext.data.NodeInterface

Returns the record node by id

Returns the record node by id

### Parameters

- id : Object

### Returns

- Ext.data.NodeInterface

Ext.data.AbstractStore
view source
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

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

Ext.util.Sortable
view source
getSortState : Object

Returns an object describing the current sort state of this Store.

Returns an object describing the current sort state of this Store.

### Returns

- Object

  The sort state of the Store. An object with two properties:

  - field : String

    The name of the field by which the Records are sorted.

  - direction : String

    The sort order, 'ASC' or 'DESC' (case-sensitive).

  See `sortInfo` for additional details.

Ext.data.AbstractStore
view source
getUpdatedRecords : Array

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

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

### Returns

- Array

  The updated Model instances

Ext.util.Observable
view source
hasListener( String eventName) : Boolean

Checks to see if this object has any listeners for a specified event

Checks to see if this object has any listeners for a specified event

### Parameters

- eventName : String

  The name of the event to check for

### Returns

- Boolean

  True if the event is being listened for, else false

Ext.util.Sortable
view source
initSortable : void
Performs initialization of this mixin. Component classes using this mixin should call this method during their own in...

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

### Returns

- void

Ext.data.AbstractStore
view source
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

Ext.data.TreeStore
view source
load( Object options) : void

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 object that is created and then sent to the proxy's Ext.data.proxy.Proxy.read function. The options can also contain a node, which indicates which node is to be loaded. If not specified, it will default to the root node.

### Returns

- void

Ext.util.Observable
view source
observe( Function c, Object listeners) : void
Sets observability on the passed class constructor. This makes any event fired on any instance of the passed class a...

Sets observability on the passed class constructor.

This makes any event fired on any instance of the passed class also fire a single event through the class allowing for central handling of events on many instances at once.

Usage:

    Ext.util.Observable.observe(Ext.data.Connection);
    Ext.data.Connection.on('beforerequest', function(con, options) {
        console.log('Ajax request made to ' + options.url);
    });

### Parameters

- c : Function

  The class constructor to make observable.

- listeners : Object

  An object containing a series of listeners to add. See addListener.

### Returns

- void

Ext.util.Observable
view source
on( String eventName, Function handler, [Object scope], [Object options]) : void

Appends an event handler to this object (shorthand for addListener.)

Appends an event handler to this object (shorthand for addListener.)

### Parameters

- eventName : String

  The type of event to listen for

- handler : Function

  The method the event invokes

- scope : Object

  (optional) The scope (`this` reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.

- options : Object

  (optional) An object containing handler configuration.

### Returns

- void

Ext.util.Observable
view source
relayEvents( Object origin, Array events, Object prefix) : void

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

### Parameters

- origin : Object

  The Observable whose events this object is to relay.

- events : Array

  Array of event names to relay.

- prefix : Object

### Returns

- void

Ext.util.Observable
view source
releaseCapture( Observable o) : void

Removes all added captures from the Observable.

Removes all added captures from the Observable.

### Parameters

- o : Observable

  The Observable to release

### Returns

- void

Ext.util.Observable
view source
removeListener( String eventName, Function handler, [Object scope]) : void

Removes an event handler.

Removes an event handler.

### Parameters

- eventName : String

  The type of event the handler was associated with.

- handler : Function

  The handler to remove. This must be a reference to the function passed into the addListener call.

- scope : Object

  (optional) The scope originally specified for the handler.

### Returns

- void

Ext.util.Observable
view source
removeManagedListener( Observable|Element item, Object|String ename, Function fn, Object scope) : void

Removes listeners that were added by the mon method.

Removes listeners that were added by the mon method.

### Parameters

- item : Observable|Element

  The item from which to remove a listener/listeners.

- ename : Object|String

  The event name, or an object containing event name properties.

- fn : Function

  Optional. If the `ename` parameter was an event name, this is the handler function.

- scope : Object

  Optional. If the `ename` parameter was an event name, this is the scope (`this` reference) in which the handler function is executed.

### Returns

- void

Ext.util.Observable
view source
resumeEvents : void
Resume firing events. (see suspendEvents) If events were suspended using the queueSuspended parameter, then all event...

Resume firing events. (see suspendEvents) If events were suspended using the `queueSuspended` parameter, then all events fired during event suspension will be sent to any listeners now.

### Returns

- void

Ext.data.AbstractStore
view source
setProxy( String|Object|Ext.data.proxy.Proxy proxy) : Ext.data.proxy.Proxy

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

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 or an Ext.data.proxy.Proxy instance

### Returns

- Ext.data.proxy.Proxy

  The attached Proxy object

Ext.data.TreeStore
view source
setRootNode( Ext.data.Model/Ext.data.NodeInterface root) : Ext.data.NodeInterface

Sets the root node for this store

Sets the root node for this store

### Parameters

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

### Returns

- Ext.data.NodeInterface

  The new root

Ext.util.Sortable
view source
sort( String|Array sorters, String direction, Object where, Object doSort) : void
Sorts the data in the Store by one or more of its properties. Example usage: //sort by a single field myStore.sort(...

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

    //sort by a single field
    myStore.sort('myField', 'DESC');

    //sorting by multiple fields
    myStore.sort([
        {
            property : 'age',
            direction: 'ASC'
        },
        {
            property : 'name',
            direction: 'DESC'
        }
    ]);

Internally, Store converts the passed arguments into an array of Ext.util.Sorter instances, and delegates the actual sorting to its internal Ext.util.MixedCollection.

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

    store.sort('myField');
    store.sort('myField');

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

    store.sort('myField', 'ASC');
    store.sort('myField', 'DESC');

### Parameters

- sorters : String|Array

  Either a string name of one of the fields in this Store's configured Model, or an Array of sorter configurations.

- direction : String

  The overall direction to sort the data by. Defaults to "ASC".

- where : Object
- doSort : Object

### Returns

- void

Ext.util.Observable
view source
suspendEvents( Boolean queueSuspended) : void

Suspend the firing of all events. (see resumeEvents)

Suspend the firing of all events. (see resumeEvents)

### Parameters

- queueSuspended : Boolean

  Pass as true to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events;

### Returns

- void

Ext.data.AbstractStore
view source
sync : void
Synchronizes the Store with its Proxy. This asks the Proxy to batch together any new, updated and deleted records in ...

Synchronizes the Store with its Proxy. This asks the Proxy to batch together any new, updated and deleted records in the store, updating the Store's internal representation of the records as each operation completes.

### Returns

- void

Ext.util.Observable
view source
un( String eventName, Function handler, [Object scope]) : void

Removes an event handler (shorthand for removeListener.)

Removes an event handler (shorthand for removeListener.)

### Parameters

- eventName : String

  The type of event the handler was associated with.

- handler : Function

  The handler to remove. This must be a reference to the function passed into the addListener call.

- scope : Object

  (optional) The scope originally specified for the handler.

### Returns

- void

Defined By

### Events

Ext.data.AbstractStore
view source
add( Ext.data.Store store, Array records, Number index)

Fired when a Model instance has been added to this Store

Fired when a Model instance has been added to this Store

### Parameters

- store : Ext.data.Store

  The store

- records : Array

  The Model instances that were added

- index : Number

  The index at which the instances were inserted

Ext.data.TreeStore
view source
append( Tree tree, Node parent, Node node, Number index)

Fires when a new child node is appended to a node in this store's tree.

Fires when a new child node is appended to a node in this store's tree.

### Parameters

- tree : Tree

  The owner tree

- parent : Node

  The parent node

- node : Node

  The newly appended node

- index : Number

  The index of the newly appended node

Ext.data.TreeStore
view source
beforeappend( Tree tree, Node parent, Node node)

Fires before a new child is appended to a node in this store's tree, return false to cancel the append.

Fires before a new child is appended to a node in this store's tree, return false to cancel the append.

### Parameters

- tree : Tree

  The owner tree

- parent : Node

  The parent node

- node : Node

  The child node to be appended

Ext.data.TreeStore
view source
beforecollapse( Node this)

Fires before this node is collapsed.

Fires before this node is collapsed.

### Parameters

- this : Node

  The collapsing node

Ext.data.TreeStore
view source
beforeexpand( Node this)

Fires before this node is expanded.

Fires before this node is expanded.

### Parameters

- this : Node

  The expanding node

Ext.data.TreeStore
view source
beforeinsert( Tree tree, Node parent, Node node, Node refNode)

Fires before a new child is inserted in a node in this store's tree, return false to cancel the insert.

Fires before a new child is inserted in a node in this store's tree, return false to cancel the insert.

### Parameters

- tree : Tree

  The owner tree

- parent : Node

  The parent node

- node : Node

  The child node to be inserted

- refNode : Node

  The child node the node is being inserted before

Ext.data.AbstractStore
view source
beforeload( Ext.data.Store store, Ext.data.Operation operation)

Event description

Event description

### Parameters

- store : Ext.data.Store

  This Store

- operation : Ext.data.Operation

  The Ext.data.Operation object that will be passed to the Proxy to load the Store

Ext.data.TreeStore
view source
beforemove( Tree tree, Node node, Node oldParent, Node newParent, Number index)

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

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

### Parameters

- tree : Tree

  The owner tree

- node : Node

  The node being moved

- oldParent : Node

  The parent of the node

- newParent : Node

  The new parent the node is moving to

- index : Number

  The index it is being moved to

Ext.data.TreeStore
view source
beforeremove( Tree tree, Node parent, Node node)

Fires before a child is removed from a node in this store's tree, return false to cancel the remove.

Fires before a child is removed from a node in this store's tree, return false to cancel the remove.

### Parameters

- tree : Tree

  The owner tree

- parent : Node

  The parent node

- node : Node

  The child node to be removed

Ext.data.AbstractStore
view source
beforesync( Object options)

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

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

### Parameters

- options : Object

  Hash of all records to be synchronized, broken down into create, update and destroy

Ext.data.AbstractStore
view source
clear( Ext.data.Store this)

Fired after the removeAll method is called.

Fired after the removeAll method is called.

### Parameters

- this : Ext.data.Store

Ext.data.TreeStore
view source
collapse( Node this)

Fires when this node is collapsed.

Fires when this node is collapsed.

### Parameters

- this : Node

  The collapsing node

Ext.data.AbstractStore
view source
datachanged( Ext.data.Store this)
Fires whenever the records in the Store have changed in some way - this could include adding or removing records, or ...

Fires whenever the records in the Store have changed in some way - this could include adding or removing records, or updating the data in existing records

### Parameters

- this : Ext.data.Store

  The data store

Ext.data.TreeStore
view source
expand( Node this)

Fires when this node is expanded.

Fires when this node is expanded.

### Parameters

- this : Node

  The expanding node

Ext.data.TreeStore
view source
insert( Tree tree, Node parent, Node node, Node refNode)

Fires when a new child node is inserted in a node in this store's tree.

Fires when a new child node is inserted in a node in this store's tree.

### Parameters

- tree : Tree

  The owner tree

- parent : Node

  The parent node

- node : Node

  The child node inserted

- refNode : Node

  The child node the node was inserted before

Ext.data.AbstractStore
view source
load( Ext.data.Store this, Array records, Boolean successful)

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.Store
- records : Array

  An array of records

- successful : Boolean

  True if the operation was successful.

Ext.data.TreeStore
view source
move( Tree tree, Node node, Node oldParent, Node newParent, Number index)

Fires when a node is moved to a new location in the store's tree

Fires when a node is moved to a new location in the store's tree

### Parameters

- tree : Tree

  The owner tree

- node : Node

  The node moved

- oldParent : Node

  The old parent of this node

- newParent : Node

  The new parent of this node

- index : Number

  The index it was moved to

Ext.data.TreeStore
view source
remove( Tree tree, Node parent, Node node)

Fires when a child node is removed from a node in this store's tree.

Fires when a child node is removed from a node in this store's tree.

### Parameters

- tree : Tree

  The owner tree

- parent : Node

  The parent node

- node : Node

  The child node removed

Ext.data.TreeStore
view source
rootchange( Ext.data.TreeStore store, Node The)

Fires when the root node on this TreeStore is changed.

Fires when the root node on this TreeStore is changed.

### Parameters

- store : Ext.data.TreeStore

  This TreeStore

- The : Node

  new root node.

Ext.data.TreeStore
view source
sort( Node node)

Fires when this TreeStore is sorted.

Fires when this TreeStore is sorted.

### Parameters

- node : Node

  The node that is sorted.

Ext.data.AbstractStore
view source
update( Store this, Ext.data.Model record, String operation)

Fires when a Record has been updated

Fires when a Record has been updated

### Parameters

- this : Store
- record : Ext.data.Model

  The Model instance that was updated

- operation : String

  The update operation being performed. Value may be one of:

                     Ext.data.Model.EDIT
                     Ext.data.Model.REJECT
                     Ext.data.Model.COMMIT