X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..3789b528d8dd8aad4558e38e22d775bcab1cbd36:/docs/api/Ext.data.AbstractStore.html?ds=sidebyside diff --git a/docs/api/Ext.data.AbstractStore.html b/docs/api/Ext.data.AbstractStore.html deleted file mode 100644 index acde3dba..00000000 --- a/docs/api/Ext.data.AbstractStore.html +++ /dev/null @@ -1,565 +0,0 @@ -Ext.data.AbstractStore | Ext JS 4.0 Documentation -
For up to date documentation and features, visit -http://docs.sencha.com/ext-js/4-0

Sencha Documentation

- - - - - -

Mixins

AbstractStore is a superclass of Ext.data.Store and Ext.data.TreeStore. It's never used directly, -but offers a set of methods used by both of those subclasses.

- - - - -

We've left it here in the docs for reference purposes, but unless you need to make a whole new type of Store, what -you're probably looking for is Ext.data.Store. If you're still interested, here's a brief description of what -AbstractStore is and is not.

- - - - -

AbstractStore provides the basic configuration for anything that can be considered a Store. It expects to be -given a Model that represents the type of data in the Store. It also expects to be given a -Proxy that handles the loading of data into the Store.

- - - - -

AbstractStore provides a few helpful methods such as load and sync, which load and save data -respectively, passing the requests through the configured proxy. Both built-in Store subclasses add extra -behavior to each of these functions. Note also that each AbstractStore subclass has its own way of storing data - -in Ext.data.Store the data is saved as a flat MixedCollection, whereas in -TreeStore we use a Ext.data.Tree to maintain the data's hierarchy.

- - -

TODO: Update these docs to explain about the sortable and filterable mixins.

- -

Finally, AbstractStore provides an API for sorting and filtering data via its sorters and filters -MixedCollections. Although this functionality is provided by AbstractStore, there's a -good description of how to use it in the introduction of Ext.data.Store. - -

Defined By

Config Options

Other Configs

 
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.

-
 

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.

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

-
 
(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'); }
-        }
-    }
-});
-
- - -

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

-
 
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

 
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.

-
 

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.

-
 

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")

-
 
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

-
 
filters : Ext.util.MixedCollection

The collection of Filters currently applied to this Store

-

The collection of Filters currently applied to this Store

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

-
 

Flag denoting that this object is sortable. Always true.

-

Flag denoting that this object is sortable. Always true.

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

-
 
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

-
 

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)

-
 
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

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

Removes all listeners for this object including the managed listeners

-

Removes all listeners for this object including the managed listeners

-

Returns

  • void    -
 

Removes all managed listeners for this object.

-

Removes all managed listeners for this object.

-

Returns

  • void    -
 
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    -
 
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.

    -
 
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

    -
 

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

    -
 

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.

    -
 

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

    -
 
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

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

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

    -
 
load( -Object options) - : void

Loads the Store using its configured proxy.

-

Loads the Store using its configured proxy.

-

Parameters

Returns

  • void    -
 
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    -
 
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    -
 
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    -
 

Removes all added captures from the Observable.

-

Removes all added captures from the Observable.

-

Parameters

  • o : Observable

    The Observable to release

    -

Returns

  • void    -
 
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    -
 
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    -
 
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    -
 
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

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

 
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

    -
 
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

    -
 

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

    -
 

Fired after the removeAll method is called.

-

Fired after the removeAll method is called.

-

Parameters

  • this : Ext.data.Store
    -
 
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

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

    -
 
remove( -Ext.data.Store store, Ext.data.Model record, Number index) -

Fired when a Model instance has been removed from this Store

-

Fired when a Model instance has been removed from this Store

-

Parameters

  • store : Ext.data.Store

    The Store object

    -
  • record : Ext.data.Model

    The record that was removed

    -
  • index : Number

    The index of the record that was removed

    -
 
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
    -
    - -
\ No newline at end of file