Ext.util.Collection

Hierarchy

Ext.Base
Ext.util.Collection

Mixins

Subclasses

Files

NOTE: This is a private utility class for internal use by the framework. Don't rely on its existence.

Defined By

Config options

Ext.util.Collection
view source
: Booleanprivate
...

Defaults to: true

Ext.util.Collection
view source
: Booleanprivate
...

Defaults to: true

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"

The root inside each item in which the properties exist that we want to filter on. ...

The root inside each item in which the properties exist that we want to filter on. This is useful for filtering records in which the data exists inside a 'data' property.

Ext.util.Collection
view source
: Object[]

Array of Filters for this collection.

Array of Filters for this collection.

Overrides: Ext.mixin.Filterable.filters

The root inside each item in which the properties exist that we want to sort on. ...

The root inside each item in which the properties exist that we want to sort on. This is useful for sorting records in which the data exists inside a data property.

Ext.util.Collection
view source
: Object[]

Array of Sorters for this collection.

Array of Sorters for this collection.

Overrides: Ext.mixin.Sortable.sorters

Properties

Defined By

Instance properties

Ext.util.Collection
view source
: Array
An array containing all the items (unsorted, unfiltered) ...

An array containing all the items (unsorted, unfiltered)

Defaults to: []

This is the cached sorting function which is a generated function that calls all the configured sorters in the correc...

This is the cached sorting function which is a generated function that calls all the configured sorters in the correct order.

Overrides: Ext.mixin.Filterable.currentSortFn

A flag indicating whether the currently cashed filter function is still valid. ...

A flag indicating whether the currently cashed filter function is still valid.

Defaults to: false

A flag indicating whether the currently cashed sort function is still valid. ...

A flag indicating whether the currently cashed sort function is still valid.

Defaults to: false

A read-only flag indicating if this object is filtered. ...

A read-only flag indicating if this object is filtered.

Defaults to: false

Ext.util.Collection
view source
: Object
An object used as map to get a sorted and filtered index of an item ...

An object used as map to get a sorted and filtered index of an item

Defaults to: {}

Ext.util.Collection
view source
: Array
An array containing the filtered items (sorted) ...

An array containing the filtered items (sorted)

Defaults to: []

Ext.util.Collection
view source
: Array
An array containing all the filtered keys (sorted) ...

An array containing all the filtered keys (sorted)

Defaults to: []

Ext.util.Collection
view source
: Number
The count of items in the collection filtered and sorted ...

The count of items in the collection filtered and sorted

Defaults to: 0

Ext.util.Collection
view source
: Object
An object used as map to get an object based on its key ...

An object used as map to get an object based on its key

Defaults to: {}

...

Defaults to: {id: 'sortable'}

Overrides: Ext.mixin.Filterable.mixinConfig

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, this.self is scope-dependent and it's meant to be used for dynamic inheritance. See statics for a detailed comparison

Ext.define('My.Cat', {
    statics: {
        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
    },

    constructor: function() {
        alert(this.self.speciesName); // dependent on 'this'
    },

    clone: function() {
        return new this.self();
    }
});


Ext.define('My.SnowLeopard', {
    extend: 'My.Cat',
    statics: {
        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'
    }
});

var cat = new My.Cat();                     // alerts 'Cat'
var snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'

var clone = snowLeopard.clone();
alert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'
A read-only flag indicating if this object is sorted. ...

A read-only flag indicating if this object is sorted.

Defaults to: false

Defined By

Static properties

...

Defaults to: []

Methods

Defined By

Instance methods

Ext.util.Collection
view source
new( keyFn, config ) : Ext.util.Collection
...

Parameters

Returns

Fires

    Ext.util.Collection
    view source
    ( key, item ) : Object
    Adds an item to the collection. ...

    Adds an item to the collection.

    Parameters

    • key : String

      The key to associate with the item, or the new item.

      If a getKey implementation was specified for this MixedCollection, or if the key of the stored items is in a property called id, the MixedCollection will be able to derive the key for the new item. In this case just pass the new item in this parameter.

    • item : Object

      The item to add.

    Returns

    Fires

      Ext.util.Collection
      view source
      ( addItems )
      Adds all elements of an Array or an Object to the collection. ...

      Adds all elements of an Array or an Object to the collection.

      Parameters

      • addItems : Object/Array

        An Object containing properties which will be added to the collection, or an Array of values, each of which are added to the collection. Functions references will be added to the collection if {@link} Ext.util.MixedCollection.allowFunctions allowFunctions} has been set to true.

      Fires

        This method adds a filter. ...

        This method adds a filter.

        Parameters

        Fires

          Ext.util.Collection
          view source
          ( filters ) : Objectchainable
          This method adds all the filters in a passed array. ...

          This method adds all the filters in a passed array.

          Parameters

          Returns

          Fires

            Overrides: Ext.mixin.Filterable.addFilters

            ( sorter, defaultDirection )
            This method adds a sorter. ...

            This method adds a sorter.

            Parameters

            Fires

              ( sorters, defaultDirection )
              This method adds all the sorters in a passed array. ...

              This method adds all the sorters in a passed array.

              Parameters

              • sorters : Array

                An array with sorters. A sorter can be an instance of Ext.util.Sorter, a string indicating a property name, an object representing an Ext.util.Sorter configuration, or a sort function.

              • defaultDirection : String

                The default direction for each sorter in the array. Defaults to the value of defaultSortDirection. Can be either 'ASC' or 'DESC'.

              Fires

                Ext.util.Collection
                view source
                ( filters )private
                ...

                Parameters

                Fires

                  Overrides: Ext.mixin.Filterable.applyFilters

                  ( sorters, collection )private
                  ...

                  Parameters

                  Fires

                    Call the original method that was previously overridden with override, This method is deprecated as callParent does ...

                    Call the original method that was previously overridden with override,

                    This method is deprecated as callParent does the same thing.

                    Ext.define('My.Cat', {
                        constructor: function() {
                            alert("I'm a cat!");
                        }
                    });
                    
                    My.Cat.override({
                        constructor: function() {
                            alert("I'm going to be a cat!");
                    
                            var instance = this.callOverridden();
                    
                            alert("Meeeeoooowwww");
                    
                            return instance;
                        }
                    });
                    
                    var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                                              // alerts "I'm a cat!"
                                              // alerts "Meeeeoooowwww"
                    

                    Parameters

                    • args : Array/Arguments

                      The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments)

                    Returns

                    • Object

                      Returns the result of calling the overridden method

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

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

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

                    This can be used with an override as follows:

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

                    This also works with static methods.

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

                    Lastly, it also works with overridden static methods.

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

                    To override a method and replace it and also call the superclass method, use callSuper. 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 from the current method, for example: this.callParent(arguments)

                    Returns

                    • Object

                      Returns the result of calling the parent method

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

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

                    Consider:

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

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

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

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

                    Parameters

                    • args : Array/Arguments

                      The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments)

                    Returns

                    • Object

                      Returns the result of calling the superclass method

                    Ext.util.Collection
                    view source
                    ( )
                    Removes all items from the collection. ...

                    Removes all items from the collection. Fires the clear event when complete.

                    Creates a shallow copy of this collection ...

                    Creates a shallow copy of this collection

                    Returns

                    Ext.util.Collection
                    view source
                    ( item ) : Boolean
                    Returns true if the collection contains the passed Object as an item. ...

                    Returns true if the collection contains the passed Object as an item.

                    Parameters

                    • item : Object

                      The Object to look for in the collection.

                    Returns

                    • Boolean

                      true if the collection contains the Object as an item.

                    Fires

                      Ext.util.Collection
                      view source
                      ( key ) : Boolean
                      Returns true if the collection contains the passed Object as a key. ...

                      Returns true if the collection contains the passed Object as a key.

                      Parameters

                      • key : String

                        The key to look for in the collection.

                      Returns

                      • Boolean

                        true if the collection contains the Object as a key.

                      Ext.util.Collection
                      view source
                      ( )protected
                      ...

                      Fires

                        Overrides: Ext.Base.destroy

                        Ext.util.Collection
                        view source
                        ( fn, scope )
                        Executes the specified function once for every item in the collection. ...

                        Executes the specified function once for every item in the collection. The function should return a Boolean value. Returning false from the function will stop the iteration.

                        Parameters

                        • fn : Function

                          The function to execute for each item.

                          Parameters

                          • item : Mixed

                            The collection item.

                          • index : Number

                            The item's index.

                          • length : Number

                            The total number of items in the collection.

                        • scope : Object

                          The scope (this reference) in which the function is executed. Defaults to the current item in the iteration.

                        Ext.util.Collection
                        view source
                        ( fn, scope )
                        Executes the specified function once for every key in the collection, passing each key, and its associated item as th...

                        Executes the specified function once for every key in the collection, passing each key, and its associated item as the first two parameters.

                        Parameters

                        • fn : Function

                          The function to execute for each item.

                        • scope : Object

                          The scope (this reference) in which the function is executed. Defaults to the browser window.

                        Ext.util.Collection
                        view source
                        ( property, value, anyMatch, caseSensitive ) : Array
                        This method will sort a collection based on the currently configured sorters. ...

                        This method will sort a collection based on the currently configured sorters.

                        Parameters

                        Returns

                        Fires

                          Overrides: Ext.mixin.Filterable.filter

                          Ext.util.Collection
                          view source
                          ( fn, scope ) : Ext.util.MixedCollection
                          Filter by a function. ...

                          Filter by a function. Returns a new collection that has been filtered. The passed function will be called with each object in the collection. If the function returns true, the value is included otherwise it is filtered.

                          Parameters

                          • fn : Function

                            The function to be called.

                            Parameters

                          • scope : Object

                            The scope (this reference) in which the function is executed. Defaults to this MixedCollection.

                          Returns

                          Fires

                            Ext.util.Collection
                            view source
                            ( fn, scope ) : Object
                            Returns the first item in the collection which elicits a true return value from the passed selection function. ...

                            Returns the first item in the collection which elicits a true return value from the passed selection function.

                            Parameters

                            • fn : Function

                              The selection function to execute for each item.

                            • scope : Object

                              The scope (this reference) in which the function is executed. Defaults to the browser window.

                            Returns

                            • Object

                              The first item in the collection which returned true from the selection function.

                            Ext.util.Collection
                            view source
                            ( fn, scope, [start] ) : Number
                            Find the index of the first matching object in this collection by a function. ...

                            Find the index of the first matching object in this collection by a function. If the function returns true it is considered a match.

                            Parameters

                            • fn : Function

                              The function to be called.

                              Parameters

                            • scope : Object

                              The scope (this reference) in which the function is executed. Defaults to this MixedCollection.

                            • start : Number (optional)

                              The index to start searching at.

                              Defaults to: 0

                            Returns

                            • Number

                              The matched index, or -1 if the item was not found.

                            This method returns the index that a given item would be inserted into a given array based on the current sorters. ...

                            This method returns the index that a given item would be inserted into a given array based on the current sorters.

                            Parameters

                            • items : Array

                              The array that you want to insert the item into.

                            • item : Mixed

                              The item that you want to insert into the items array.

                            Returns

                            • Number

                              The index for the given item in the given array based on the current sorters.

                            Fires

                              Ext.util.Collection
                              view source
                              ( ) : Object
                              Returns the first item in the collection. ...

                              Returns the first item in the collection.

                              Returns

                              • Object

                                the first item in the collection.

                              Ext.util.Collection
                              view source
                              ( key ) : Object
                              Returns the item associated with the passed key OR index. ...

                              Returns the item associated with the passed key OR index. Key has priority over index. This is the equivalent of calling getByKey first, then if nothing matched calling getAt.

                              Parameters

                              Returns

                              • Object

                                If the item is found, returns the item. If the item was not found, returns undefined. If an item was found, but is a Class, returns null.

                              Fires

                                Ext.util.Collection
                                view source
                                ( index ) : Object
                                Returns the item at the specified index. ...

                                Returns the item at the specified index.

                                Parameters

                                • index : Number

                                  The index of the item.

                                Returns

                                • Object

                                  The item at the specified index.

                                Ext.util.Collection
                                view source
                                ( ) : Boolean
                                Returns the value of autoFilter. ...

                                Returns the value of autoFilter.

                                Returns

                                Ext.util.Collection
                                view source
                                ( ) : Boolean
                                Returns the value of autoSort. ...

                                Returns the value of autoSort.

                                Returns

                                Ext.util.Collection
                                view source
                                ( key ) : Object
                                Returns the item associated with the passed key. ...

                                Returns the item associated with the passed key.

                                Parameters

                                Returns

                                • Object

                                  The item associated with the passed key.

                                ...

                                Parameters

                                Ext.util.Collection
                                view source
                                ( ) : Number
                                Returns the number of items in the collection. ...

                                Returns the number of items in the collection.

                                Returns

                                • Number

                                  the number of items in the collection.

                                Returns the value of defaultSortDirection. ...

                                Returns the value of defaultSortDirection.

                                Returns

                                Returns an up to date sort function. ...

                                Returns an up to date sort function.

                                Returns

                                Fires

                                  Returns the value of filterRoot. ...

                                  Returns the value of filterRoot.

                                  Returns

                                  Returns the value of filters. ...

                                  Returns the value of filters.

                                  Returns

                                  Returns the initial configuration passed to constructor. ...

                                  Returns the initial configuration passed to constructor.

                                  Parameters

                                  • name : String (optional)

                                    When supplied, value for particular configuration option is returned, otherwise the full config object is returned.

                                  Returns

                                  Ext.util.Collection
                                  view source
                                  ( item ) : Object
                                  MixedCollection has a generic way to fetch keys if you implement getKey. ...

                                  MixedCollection has a generic way to fetch keys if you implement getKey. The default implementation simply returns item.id but you can provide your own implementation to return a different value as in the following examples:

                                  // normal way
                                  var mc = new Ext.util.MixedCollection();
                                  mc.add(someEl.dom.id, someEl);
                                  mc.add(otherEl.dom.id, otherEl);
                                  //and so on
                                  
                                  // using getKey
                                  var mc = new Ext.util.MixedCollection();
                                  mc.getKey = function(el){
                                     return el.dom.id;
                                  };
                                  mc.add(someEl);
                                  mc.add(otherEl);
                                  
                                  // or via the constructor
                                  var mc = new Ext.util.MixedCollection(false, function(el){
                                     return el.dom.id;
                                  });
                                  mc.add(someEl);
                                  mc.add(otherEl);
                                  

                                  Parameters

                                  • item : Object

                                    The item for which to find the key.

                                  Returns

                                  • Object

                                    The key for the passed item.

                                  Ext.util.Collection
                                  view source
                                  ( [start], [end] ) : Array
                                  Returns a range of items in this collection ...

                                  Returns a range of items in this collection

                                  Parameters

                                  • start : Number (optional)

                                    The starting index.

                                    Defaults to: 0

                                  • end : Number (optional)

                                    The ending index. Defaults to the last item.

                                    Defaults to: -1

                                  Returns

                                  Returns an up to date sort function. ...

                                  Returns an up to date sort function.

                                  Returns

                                  Fires

                                    Returns the value of sortRoot. ...

                                    Returns the value of sortRoot.

                                    Returns

                                    Returns the value of sorters. ...

                                    Returns the value of sorters.

                                    Returns

                                    Ext.util.Collection
                                    view source
                                    ( items )private
                                    ...

                                    Parameters

                                    ...

                                    Parameters

                                    Ext.util.Collection
                                    view source
                                    ( item ) : Number
                                    Returns index within the collection of the passed Object. ...

                                    Returns index within the collection of the passed Object.

                                    Parameters

                                    • item : Object

                                      The item to find the index of.

                                    Returns

                                    • Number

                                      Index of the item. Returns -1 if not found.

                                    Fires

                                      Ext.util.Collection
                                      view source
                                      ( key ) : Number
                                      Returns index within the collection of the passed key. ...

                                      Returns index within the collection of the passed key.

                                      Parameters

                                      • key : String

                                        The key to find the index of.

                                      Returns

                                      Fires

                                        ( instanceConfig ) : Objectchainableprotected
                                        Initialize configuration for this class. ...

                                        Initialize configuration for this class. a typical example:

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

                                        Parameters

                                        Returns

                                        • Object

                                          mixins The mixin prototypes as key - value pairs

                                        Fires

                                          Ext.util.Collection
                                          view source
                                          ( index, key, item ) : Object
                                          Inserts an item at the specified index in the collection. ...

                                          Inserts an item at the specified index in the collection. Fires the add event when complete.

                                          Parameters

                                          • index : Number

                                            The index to insert the item at.

                                          • key : String

                                            The key to associate with the new item, or the item itself.

                                          • item : Object

                                            If the second parameter was a key, the new item.

                                          Returns

                                          Fires

                                            Ext.util.Collection
                                            view source
                                            ( index, insertItems )private
                                            ...

                                            Parameters

                                            Fires

                                              This method adds a filter at a given index. ...

                                              This method adds a filter at a given index.

                                              Parameters

                                              Returns

                                              Fires

                                                This method inserts all the filters in the passed array at the given index. ...

                                                This method inserts all the filters in the passed array at the given index.

                                                Parameters

                                                Returns

                                                Fires

                                                  ( index, sorter, defaultDirection )
                                                  This method adds a sorter at a given index. ...

                                                  This method adds a sorter at a given index.

                                                  Parameters

                                                  Fires

                                                    Ext.util.Collection
                                                    view source
                                                    ( ) : Ext.util.Collectionchainable
                                                    This method inserts all the sorters in the passed array at the given index. ...

                                                    This method inserts all the sorters in the passed array at the given index.

                                                    Returns

                                                    Fires

                                                      Overrides: Ext.mixin.Sortable.insertSorters

                                                      ...

                                                      Parameters

                                                      Fires

                                                        Ext.util.Collection
                                                        view source
                                                        ( ) : Object
                                                        Returns the last item in the collection. ...

                                                        Returns the last item in the collection.

                                                        Returns

                                                        • Object

                                                          the last item in the collection.

                                                        ( names, callback, scope )private
                                                        ...

                                                        Parameters

                                                        Ext.util.Collection
                                                        view source
                                                        ( item ) : Object
                                                        Remove an item from the collection. ...

                                                        Remove an item from the collection.

                                                        Parameters

                                                        • item : Object

                                                          The item to remove.

                                                        Returns

                                                        • Object

                                                          The item removed or false if no item was removed.

                                                        Fires

                                                          Ext.util.Collection
                                                          view source
                                                          ( items ) : Ext.util.MixedCollectionchainable
                                                          Remove all items in the passed array from the collection. ...

                                                          Remove all items in the passed array from the collection.

                                                          Parameters

                                                          • items : Array

                                                            An array of items to be removed.

                                                          Returns

                                                          Fires

                                                            Ext.util.Collection
                                                            view source
                                                            ( index ) : Object
                                                            Remove an item from a specified index in the collection. ...

                                                            Remove an item from a specified index in the collection. Fires the remove event when complete.

                                                            Parameters

                                                            • index : Number

                                                              The index within the collection of the item to remove.

                                                            Returns

                                                            • Object

                                                              The item removed or false if no item was removed.

                                                            Ext.util.Collection
                                                            view source
                                                            ( key ) : Object/Boolean
                                                            Removed an item associated with the passed key from the collection. ...

                                                            Removed an item associated with the passed key from the collection.

                                                            Parameters

                                                            • key : String

                                                              The key of the item to remove.

                                                            Returns

                                                            Fires

                                                              Ext.util.Collection
                                                              view source
                                                              ( filters ) : Ext.util.Collectionchainable
                                                              This method removes all the filters in a passed array. ...

                                                              This method removes all the filters in a passed array.

                                                              Parameters

                                                              Returns

                                                              Fires

                                                                Overrides: Ext.mixin.Filterable.removeFilters

                                                                This method removes a sorter. ...

                                                                This method removes a sorter.

                                                                Parameters

                                                                Fires

                                                                  Ext.util.Collection
                                                                  view source
                                                                  ( sorters ) : Ext.util.Collectionchainable
                                                                  This method removes all the sorters in a passed array. ...

                                                                  This method removes all the sorters in a passed array.

                                                                  Parameters

                                                                  Returns

                                                                  Fires

                                                                    Overrides: Ext.mixin.Sortable.removeSorters

                                                                    Ext.util.Collection
                                                                    view source
                                                                    ( oldKey, item ) : Object
                                                                    Replaces an item in the collection. ...

                                                                    Replaces an item in the collection. Fires the replace event when complete.

                                                                    Parameters

                                                                    • oldKey : String

                                                                      The key associated with the item to replace, or the replacement item.

                                                                      If you supplied a getKey implementation for this MixedCollection, or if the key of your stored items is in a property called id, then the MixedCollection will be able to derive the key of the replacement item. If you want to replace an item with one having the same key value, then just pass the replacement item in this parameter.

                                                                    • item : Object

                                                                      {Object} item (optional) If the first parameter passed was a key, the item to associate with that key.

                                                                    Returns

                                                                    Fires

                                                                      Ext.util.Collection
                                                                      view source
                                                                      ( autoFilter )
                                                                      Sets the value of autoFilter. ...

                                                                      Sets the value of autoFilter.

                                                                      Parameters

                                                                      Ext.util.Collection
                                                                      view source
                                                                      ( autoSort )
                                                                      Sets the value of autoSort. ...

                                                                      Sets the value of autoSort.

                                                                      Parameters

                                                                      ( config, applyIfNotSet ) : Ext.Basechainableprivate
                                                                      ...

                                                                      Parameters

                                                                      Returns

                                                                      Sets the value of defaultSortDirection. ...

                                                                      Sets the value of defaultSortDirection.

                                                                      Parameters

                                                                      • defaultSortDirection : String
                                                                      Sets the value of filterRoot. ...

                                                                      Sets the value of filterRoot.

                                                                      Parameters

                                                                      Sets the value of filters. ...

                                                                      Sets the value of filters.

                                                                      Parameters

                                                                      Sets the value of sortRoot. ...

                                                                      Sets the value of sortRoot.

                                                                      Parameters

                                                                      Sets the value of sorters. ...

                                                                      Sets the value of sorters.

                                                                      Parameters

                                                                      Ext.util.Collection
                                                                      view source
                                                                      ( sorters, defaultDirection ) : Array
                                                                      This method will sort an array based on the currently configured sorters. ...

                                                                      This method will sort an array based on the currently configured sorters.

                                                                      Parameters

                                                                      Returns

                                                                      • Array

                                                                        The array you passed after it is sorted.

                                                                      Fires

                                                                        Overrides: Ext.mixin.Sortable.sort

                                                                        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, this.statics() is scope-independent and it always returns the class from which it was called, regardless of what this points to during run-time

                                                                        Ext.define('My.Cat', {
                                                                            statics: {
                                                                                totalCreated: 0,
                                                                                speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
                                                                            },
                                                                        
                                                                            constructor: function() {
                                                                                var statics = this.statics();
                                                                        
                                                                                alert(statics.speciesName);     // always equals to 'Cat' no matter what 'this' refers to
                                                                                                                // equivalent to: My.Cat.speciesName
                                                                        
                                                                                alert(this.self.speciesName);   // dependent on 'this'
                                                                        
                                                                                statics.totalCreated++;
                                                                            },
                                                                        
                                                                            clone: function() {
                                                                                var cloned = new this.self();                    // dependent on 'this'
                                                                        
                                                                                cloned.groupName = this.statics().speciesName;   // equivalent to: My.Cat.speciesName
                                                                        
                                                                                return cloned;
                                                                            }
                                                                        });
                                                                        
                                                                        
                                                                        Ext.define('My.SnowLeopard', {
                                                                            extend: 'My.Cat',
                                                                        
                                                                            statics: {
                                                                                speciesName: 'Snow Leopard'     // My.SnowLeopard.speciesName = 'Snow Leopard'
                                                                            },
                                                                        
                                                                            constructor: function() {
                                                                                this.callParent();
                                                                            }
                                                                        });
                                                                        
                                                                        var cat = new My.Cat();                 // alerts 'Cat', then alerts 'Cat'
                                                                        
                                                                        var snowLeopard = new My.SnowLeopard(); // alerts 'Cat', then alerts 'Snow Leopard'
                                                                        
                                                                        var clone = snowLeopard.clone();
                                                                        alert(Ext.getClassName(clone));         // alerts 'My.SnowLeopard'
                                                                        alert(clone.groupName);                 // alerts 'Cat'
                                                                        
                                                                        alert(My.Cat.totalCreated);             // alerts 3
                                                                        

                                                                        Returns

                                                                        Ext.util.Collection
                                                                        view source
                                                                        ( )private
                                                                        ...

                                                                        Fires

                                                                          Ext.util.Collection
                                                                          view source
                                                                          ( autoFilter, oldAutoFilter )private
                                                                          ...

                                                                          Parameters

                                                                          Fires

                                                                            Ext.util.Collection
                                                                            view source
                                                                            ( autoSort, oldAutoSort )private
                                                                            ...

                                                                            Parameters

                                                                            Fires

                                                                              This updates the cached sortFn based on the current sorters. ...

                                                                              This updates the cached sortFn based on the current sorters.

                                                                              Returns

                                                                              • Function

                                                                                sortFn The generated sort function.

                                                                              Fires

                                                                                Ext.util.Collection
                                                                                view source
                                                                                ( )private
                                                                                ...

                                                                                Fires

                                                                                  This updates the cached sortFn based on the current sorters. ...

                                                                                  This updates the cached sortFn based on the current sorters.

                                                                                  Returns

                                                                                  Fires

                                                                                    Defined By

                                                                                    Static methods

                                                                                    ( config, fullMerge )privatestatic
                                                                                    ...

                                                                                    Parameters

                                                                                    ( members )chainableprivatestatic
                                                                                    ...

                                                                                    Parameters

                                                                                    ( name, member )chainableprivatestatic
                                                                                    ...

                                                                                    Parameters

                                                                                    ( members )chainablestatic
                                                                                    Add methods / properties to the prototype of this class. ...

                                                                                    Add methods / properties to the prototype of this class.

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

                                                                                    Parameters

                                                                                    ( members ) : Ext.Basechainablestatic
                                                                                    Add / override static properties of this class. ...

                                                                                    Add / override static properties of this class.

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

                                                                                    Parameters

                                                                                    Returns

                                                                                    ( xtype )chainableprivatestatic
                                                                                    ...

                                                                                    Parameters

                                                                                    ( fromClass, members ) : Ext.Basechainableprivatestatic
                                                                                    Borrow another class' members to the prototype of this class. ...

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

                                                                                    Ext.define('Bank', {
                                                                                        money: '$$$',
                                                                                        printMoney: function() {
                                                                                            alert('$$$$$$$');
                                                                                        }
                                                                                    });
                                                                                    
                                                                                    Ext.define('Thief', {
                                                                                        // ...
                                                                                    });
                                                                                    
                                                                                    Thief.borrow(Bank, ['money', 'printMoney']);
                                                                                    
                                                                                    var steve = new Thief();
                                                                                    
                                                                                    alert(steve.money); // alerts '$$$'
                                                                                    steve.printMoney(); // alerts '$$$$$$$'
                                                                                    

                                                                                    Parameters

                                                                                    • fromClass : Ext.Base

                                                                                      The class to borrow members from

                                                                                    • members : Array/String

                                                                                      The names of the members to borrow

                                                                                    Returns

                                                                                    ( args )protectedstatic
                                                                                    ...

                                                                                    Parameters

                                                                                    Create a new instance of this Class. ...

                                                                                    Create a new instance of this Class.

                                                                                    Ext.define('My.cool.Class', {
                                                                                        // ...
                                                                                    });
                                                                                    
                                                                                    My.cool.Class.create({
                                                                                        someConfig: true
                                                                                    });
                                                                                    

                                                                                    All parameters are passed to the constructor of the class.

                                                                                    Returns

                                                                                    ( alias, origin )static
                                                                                    Create aliases for existing prototype methods. ...

                                                                                    Create aliases for existing prototype methods. Example:

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

                                                                                    Parameters

                                                                                    ( parent )privatestatic
                                                                                    ...

                                                                                    Parameters

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

                                                                                    Get the current class' name in string format.

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

                                                                                    Returns

                                                                                    ...
                                                                                    ( name, mixinClass )privatestatic
                                                                                    Used internally by the mixins pre-processor ...

                                                                                    Used internally by the mixins pre-processor

                                                                                    Parameters

                                                                                    ( fn, scope )chainableprivatestatic
                                                                                    ...

                                                                                    Parameters

                                                                                    ( members ) : Ext.Basechainabledeprecatedstatic
                                                                                    Override members of this class. ...

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

                                                                                    Ext.define('My.Cat', {
                                                                                        constructor: function() {
                                                                                            alert("I'm a cat!");
                                                                                        }
                                                                                    });
                                                                                    
                                                                                    My.Cat.override({
                                                                                        constructor: function() {
                                                                                            alert("I'm going to be a cat!");
                                                                                    
                                                                                            var instance = this.callParent(arguments);
                                                                                    
                                                                                            alert("Meeeeoooowwww");
                                                                                    
                                                                                            return instance;
                                                                                        }
                                                                                    });
                                                                                    
                                                                                    var kitty = new My.Cat(); // alerts "I'm going to be a cat!"
                                                                                                              // alerts "I'm a cat!"
                                                                                                              // alerts "Meeeeoooowwww"
                                                                                    

                                                                                    As of 2.1, direct use of this method is deprecated. Use Ext.define instead:

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

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

                                                                                    This method has been deprecated since 2.1.0

                                                                                    Please use Ext.define instead

                                                                                    Parameters

                                                                                    • members : Object

                                                                                      The properties to add to this class. This should be specified as an object literal containing one or more properties.

                                                                                    Returns