Properties

Methods

Events

Config Options

Direct Link

Observable
  AbstractStore
    TreeStore

Class Ext.data.TreeStore

Package:	Ext.data
Defined In:	TreeStore.js
Class:	TreeStore
Extends:	AbstractStore

A store class that allows the representation of hierarchical data.

Config Options

Config Options		Defined By
	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.	AbstractStore
	autoSave : Boolean True to automatically sync the Store with its Proxy after every edit to one of its Records. Defaults to false.	AbstractStore
	clearOnLoad : Boolean Default to true. Remove previously existing child nodes before loading.	TreeStore
	defaultRootId : String The default root id. Defaults to 'root'	TreeStore
	listeners : Object A config object containing one or more event handlers to be added to this object during initialization. This should ... 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 a child element of a Component, we need to specify this explicitly: `new Ext.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'); } } } });`	Observable
	nodeParam : String The name of the parameter sent to the server which contains the identifier of the node. Defaults to `'node'`.	TreeStore
	proxy : String/Ext.data.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.	AbstractStore
	storeId : String Optional unique identifier for this store. If present, this Store will be registered with the Ext.StoreMgr, making i... Optional unique identifier for this store. If present, this Store will be registered with the Ext.StoreMgr, making it easy to reuse elsewhere. Defaults to undefined.	AbstractStore

Public Properties

Property		Defined By
	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.	AbstractStore
	defaultProxyType : String The string type of the Proxy to create if none is specified. This defaults to creating a memory proxy.	AbstractStore
	defaultSortDirection : String The default sort direction to use if one is not specified (defaults to "ASC")	AbstractStore
	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	AbstractStore
	filters : Ext.util.MixedCollection The collection of Filters currently applied to this Store	AbstractStore
	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.	AbstractStore
	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	AbstractStore
	sortToggle : Object Stores the current sort direction ('ASC' or 'DESC') for each field. Used internally to manage the toggling of sort di... Stores the current sort direction ('ASC' or 'DESC') for each field. Used internally to manage the toggling of sort direction per field. Read only	AbstractStore
	sorters : Ext.util.MixedCollection The collection of Sorters currently applied to this Store.	AbstractStore

Public Methods

Method		Defined By
	TreeStore( `Object config` ) Parameters: `config` : Object Optional config object Returns: void	TreeStore
	addEvents( `Object\|String o`, `string Optional.` ) : 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. `Optional.` : string Event name if multiple event names are being passed as separate parameters. Usage: `this.addEvents('storeloaded', 'storecleared');` Returns: void	Observable
	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. `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 The element reference on the component to bind the event to. This is used to bind DOM events to underlying elements on Components. - This option is only valid for listeners bound to Components Combining Options Using the options argument, it is possible to combine different types of listeners: A delayed, one-time listener. `myPanel.on('hide', this.onClick, 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 handlers. Returns: void	Observable
	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	Observable
	clearListeners() : void Removes all listeners for this object including the managed listeners Removes all listeners for this object including the managed listeners Parameters: None. Returns: void	Observable
	clearManagedListeners() : void Removes all managed listeners for this object. Removes all managed listeners for this object. Parameters: None. Returns: void	Observable
	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, { // Add functionality to Field's initComponent to enable the change event to bubble initComponent : Ext.createSequence(Ext.form.Field.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	Observable
	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 Obse... 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.	Observable
	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) Parameters: None. Returns: `Array` The Model instances	AbstractStore
	getNodeById() : Ext.data.RecordNode Returns the record node by id Returns the record node by id Parameters: None. Returns: `Ext.data.RecordNode`	TreeStore
	getProxy() : Ext.data.Proxy Returns the proxy currently attached to this proxy instance Returns the proxy currently attached to this proxy instance Parameters: None. Returns: `Ext.data.Proxy` The Proxy instance	AbstractStore
	getRootNode() : Ext.data.RecordNode Returns the root node for this tree. Returns the root node for this tree. Parameters: None. Returns: `Ext.data.RecordNode`	TreeStore
	getSortState() : Object Returns an object describing the current sort state of this Store. Returns an object describing the current sort state of this Store. Parameters: None. Returns: `Object` The sort state of the Store. An object with two properties:<ul> <li><b>field : String<p class="sub-desc">The name of the field by which the Records are sorted.</p></li> <li><b>direction : String<p class="sub-desc">The sort order, 'ASC' or 'DESC' (case-sensitive).</p></li> </ul> See <tt>{@link #sortInfo}</tt> for additional details.	AbstractStore
	getSubStore( `Ext.data.RecordNode/Ext.data.Record record` ) : void Returns a flat Ext.data.Store with the correct type of model. Returns a flat Ext.data.Store with the correct type of model. Parameters: `record` : Ext.data.RecordNode/Ext.data.Record Returns: void	TreeStore
	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 Parameters: None. Returns: `Array` The updated Model instances	AbstractStore
	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	Observable
	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.read function Returns: void	AbstractStore
	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	Observable
	relayEvents( `Object o`, `Array events` ) : 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: `o` : Object The Observable whose events this object is to relay. `events` : Array Array of event names to relay. Returns: void	Observable
	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	Observable
	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	Observable
	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. Parameters: None. Returns: void	Observable
	setProxy( `String\|Object\|Ext.data.Proxy proxy` ) : Ext.data.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 The new Proxy, which can be either a type string, a configuration object or an Ext.data.Proxy instance Returns: `Ext.data.Proxy` The attached Proxy object	AbstractStore
	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	Observable
	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. Parameters: None. Returns: void	AbstractStore
	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	Observable

Public Events

Event		Defined By
	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 Listeners will be called with the following arguments: `store` : Ext.data.Store The store `records` : Array The Model instances that were added `index` : Number The index at which the instances were inserted	AbstractStore
	beforeload : ( `Ext.data.Store store`, `Ext.data.Operation operation` ) Event description Event description Listeners will be called with the following arguments: `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	AbstractStore
	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 Listeners will be called with the following arguments: `options` : Object Hash of all records to be synchronized, broken down into create, update and destroy	AbstractStore
	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 Listeners will be called with the following arguments: `this` : Ext.data.Store The data store	AbstractStore
	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. Listeners will be called with the following arguments: `this` : Ext.data.store `records` : Array An array of records `successful` : Boolean True if the operation was successful.	AbstractStore
	remove : ( `Ext.data.Model record` ) Fired when a Model instance has been removed from this Store Fired when a Model instance has been removed from this Store Listeners will be called with the following arguments: `record` : Ext.data.Model The record that was removed	AbstractStore
	update : ( `Store this`, `Ext.data.Model record`, `String operation` ) Fires when a Record has been updated Fires when a Record has been updated Listeners will be called with the following arguments: `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`	AbstractStore