Ext.data.reader.Array

Alternate names

Ext.data.ArrayReader

Hierarchy

Inherited mixins

Files

Data reader class to create an Array of Ext.data.Model objects from an Array. Each element of that Array represents a row of data fields. The fields are pulled into a Record object using as a subscript, the mapping property of the field definition if it exists, or the field's ordinal position in the definition.

Example code:

Employee = Ext.define('Employee', {
    extend: 'Ext.data.Model',
    config: {
        fields: [
            'id',
            {name: 'name', mapping: 1}, // "mapping" only needed if an "id" field is present which
            {name: 'occupation', mapping: 2} // precludes using the ordinal position as the index.
        ]
    }
});

var myReader = new Ext.data.reader.Array({
    model: 'Employee'
}, Employee);

This would consume an Array like this:

[ [1, 'Bill', 'Gardener'], [2, 'Ben', 'Horticulturalist'] ]
Defined By

Config options

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

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

The name of the property with a response that contains the existing client side id for a record that we are reading. ...

The name of the property with a response that contains the existing client side id for a record that we are reading.

Defaults to: 'clientId'

Name of the property within a raw object that contains a record identifier value. ...

Name of the property within a raw object that contains a record identifier value. Defaults to The id of the model. If an idProperty is explicitly specified it will override that of the one specified on the model

true to automatically parse models nested within other models in a response object. ...

true to automatically parse models nested within other models in a response object. See the Ext.data.reader.Reader intro docs for full explanation.

Defaults to: true

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

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

See the Event guide for more

Note: It is bad practice to specify a listener's config when you are defining a class using Ext.define(). Instead, only specify listeners when you are instantiating your class with Ext.create().

(optional) The name of the property which contains a response message. ...

(optional) The name of the property which contains a response message. This property is optional.

The optional location within the JSON response that the record data itself can be found at. ...

The optional location within the JSON response that the record data itself can be found at. See the JsonReader intro docs for more details. This is not often needed.

Defaults to: null

The name of the property which contains the Array of row objects. ...

The name of the property which contains the Array of row objects. For JSON reader it's dot-separated list of property names. For XML reader it's a CSS selector. For array reader it's not applicable.

By default the natural root of the data will be used. The root Json array, the root XML element, or the array.

The data packet value for this property should be an empty array to clear the data or show no data.

This cfg has been deprecated since 2.0.0

Please use the rootProperty configuration instead.

The name of the property which contains the Array of row objects. ...

The name of the property which contains the Array of row objects. For JSON reader it's dot-separated list of property names. For XML reader it's a CSS selector. For array reader it's not applicable.

By default the natural root of the data will be used. The root JSON array, the root XML element, or the array.

The data packet value for this property should be an empty array to clear the data or show no data.

Defaults to: ''

Ext.data.reader.Array
view source
: String
Name of the property from which to retrieve the success attribute. ...

Name of the property from which to retrieve the success attribute. See Ext.data.proxy.Server.exception for additional information.

Defaults to: 'success'

Overrides: Ext.data.reader.Reader.successProperty

Ext.data.reader.Array
view source
: String
Name of the property from which to retrieve the total number of records in the dataset. ...

Name of the property from which to retrieve the total number of records in the dataset. This is only needed if the whole dataset is not passed in one go, but is being paged from the remote server.

Defaults to: 'total'

Overrides: Ext.data.reader.Reader.totalProperty

true to ensure that field names/mappings are treated as literals when reading values. ...

true to ensure that field names/mappings are treated as literals when reading values. For example, by default, using the mapping "foo.bar.baz" will try and read a property foo from the root, then a property bar from foo, then a property baz from bar. Setting the simple accessors to true will read the property with the name "foo.bar.baz" direct from the root object.

Defaults to: false

Properties

Defined By

Instance properties

Returns an accessor function for the given property string. ...

Returns an accessor function for the given property string. Gives support for properties such as the following: 'someProperty' 'some.property' 'some["property"]' This is used by buildExtractors to create optimized extractor functions when casting raw data into model instances.

...

Defaults to: /\.|[^\w\-]/g

...

Defaults to: true

...

Defaults to: /^(?:delegate|single|delay|buffer|args|prepend)$/

The raw meta data that was most recently read, if any. ...

The raw meta data that was most recently read, if any. Meta data can include existing Reader config options like idProperty, totalProperty, etc. that get automatically applied to the Reader, and those can still be accessed directly from the Reader if needed. However, meta data is also often used to pass other custom data to be processed by application code. For example, it is common when reconfiguring the data model of a grid to also pass a corresponding column model config to be applied to the grid. Any such data will not get applied to the Reader directly (it just gets passed through and is ignored by Ext). This metaData property gives you access to all meta data that was passed, including any such custom data ignored by the reader.

This is a read-only property, and it will get replaced each time a new meta data object is passed to the reader.

...

Defaults to: {id: 'observable', hooks: {destroy: 'destroy'}}

Overrides: Ext.mixin.Sortable.mixinConfig

...

Defaults to: 'identifiable'

...

Defaults to: /[\[\.]/

...

Defaults to: 'observable'

The raw data object that was last passed to readRecords. ...

The raw data object that was last passed to readRecords. Stored for further processing if needed

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

Defaults to: /^([\w\-]+)$/

Defined By

Static properties

...

Defaults to: []

Methods

Defined By

Instance methods

Create a new ArrayReader ...

Create a new ArrayReader

Parameters

  • meta : Object

    Metadata configuration options.

Returns

Overrides: Ext.data.reader.Reader.constructor

( eventName, fn, [scope], [options] )
Appends an after-event handler. ...

Appends an after-event handler.

Same as addListener with order set to 'after'.

Parameters

  • eventName : String/String[]/Object

    The name of the event to listen for.

  • fn : Function/String

    The method the event invokes.

  • scope : Object (optional)

    The scope for fn.

  • options : Object (optional)

    An object containing handler configuration.

Fires

    ( eventName, fn, [scope], [options] )
    Appends a before-event handler. ...

    Appends a before-event handler. Returning false from the handler will stop the event.

    Same as addListener with order set to 'before'.

    Parameters

    • eventName : String/String[]/Object

      The name of the event to listen for.

    • fn : Function/String

      The method the event invokes.

    • scope : Object (optional)

      The scope for fn.

    • options : Object (optional)

      An object containing handler configuration.

    Fires

      ( selector, name, fn, scope, options, order )private
      ...

      Parameters

      Fires

        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.

        This method has been deprecated since 2.0

        It's no longer needed to add events before firing.

        Parameters

        • eventNames : 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.

        ( eventName, [fn], [scope], [options], [order] )
        Appends an event handler to this object. ...

        Appends an event handler to this object. You can review the available handlers by looking at the 'events' section of the documentation for the component you are working with.

        Combining Options

        Using the options argument, it is possible to combine different types of listeners:

        A delayed, one-time listener:

        container.addListener('tap', this.handleTap, 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:

        container.addListener({
            tap  : this.onTap,
            swipe: this.onSwipe,
        
            scope: this // Important. Ensure "this" is correct during handler execution
        });
        

        One can also specify options for each event handler separately:

        container.addListener({
            tap  : { fn: this.onTap, scope: this, single: true },
            swipe: { fn: button.onSwipe, scope: button }
        });
        

        See the Events Guide for more.

        Parameters

        • eventName : String/String[]/Object

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

        • fn : Function/String (optional)

          The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below.

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

          This object may contain any of the following properties:

          • scope : Object (optional)

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

          • delay : Number (optional)

            The number of milliseconds to delay the invocation of the handler after the event fires.

          • single : Boolean (optional)

            true to add a handler to handle just the next firing of the event, and then remove itself.

          • order : String (optional)

            The order of when the listener should be added into the listener queue.

            If you set an order of before and the event you are listening to is preventable, you can return false and it will stop the event.

            Available options are before, current and after.

            Defaults to: current

          • buffer : Number (optional)

            Causes the handler to be 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.

          • element : String (optional)

            Allows you to add a listener onto a element of this component using the elements reference.

            Ext.create('Ext.Component', {
                listeners: {
                    element: 'element',
                    tap: function() {
                        alert('element tap!');
                    }
                }
            });
            

            All components have the element reference, which is the outer most element of the component. Ext.Container also has the innerElement element which contains all children. In most cases element is adequate.

          • delegate : String (optional)

            Uses Ext.ComponentQuery to delegate events to a specified query selector within this item.

            // Create a container with a two children; a button and a toolbar
            var container = Ext.create('Ext.Container', {
                items: [
                    {
                        xtype: 'toolbar',
                        docked: 'top',
                        title: 'My Toolbar'
                    },
                    {
                       xtype: 'button',
                       text: 'My Button'
                    }
                ]
            });
            
            container.addListener({
                // Ext.Buttons have an xtype of 'button', so we use that are a selector for our delegate
                delegate: 'button',
            
                tap: function() {
                    alert('Button tapped!');
                }
            });
            
        • order : String (optional)

          The order of when the listener should be added into the listener queue. Possible values are before, current and after.

          Defaults to: 'current'

        Fires

          ( object, eventName, [fn], [scope], [options] )deprecated
          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.

          This method has been deprecated since 2.0

          All listeners are now automatically managed where necessary. Simply use addListener.

          Parameters

          • object : Ext.mixin.Observable/HTMLElement

            The item to which to add a listener/listeners.

          • eventName : Object/String

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

          • fn : Function (optional)

            If the eventName parameter was an event name, this is the handler function.

          • scope : Object (optional)

            If the eventName parameter was an event name, this is the scope in which the handler function is executed.

          • options : Object (optional)

            If the eventName parameter was an event name, this is the addListener options.

          ...

          Parameters

          Fires

            ...

            Parameters

            Fires

              ...

              Parameters

              Fires

                ...

                Parameters

                This builds optimized functions for retrieving record data and meta data from an object. ...

                This builds optimized functions for retrieving record data and meta data from an object. Subclasses may need to implement their own getRoot function.

                Fires

                  Overrides: Ext.data.reader.Reader.buildExtractors

                  Return a function which will read a raw row object in the format this Reader accepts, and populates a record's data o...

                  Return a function which will read a raw row object in the format this Reader accepts, and populates a record's data object with converted data values.

                  The returned function must be passed the following parameters:

                  • dest - A record's empty data object into which the new field value properties are injected.
                  • source - A raw row data object of whatever type this Reader consumes
                  • `record - The record which is being populated.

                  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

                    ( actionFn, eventName, fn, scope, options, order ) : Ext.mixin.Observablechainableprivate
                    ...

                    Parameters

                    Returns

                    Removes all listeners for this object. ...

                    Removes all listeners for this object.

                    Fires

                      ...

                      Parameters

                      Fires

                        ...

                        Parameters

                        Fires

                          Creates an event handling function which re-fires the event from this object as the passed event name. ...

                          Creates an event handling function which re-fires the event from this object as the passed event name.

                          Parameters

                          Returns

                          Fires

                            Ext.data.reader.Array
                            view source
                            ( field, fieldVarName, dataName )private
                            Returns an accessor expression for the passed Field from an Array using either the Field's mapping, or its ordinal po...

                            Returns an accessor expression for the passed Field from an Array using either the Field's mapping, or its ordinal position in the fields collection as the index. This is used by buildExtractors to create optimized on extractor function which converts raw data into model instances.

                            Parameters

                            Fires

                              Overrides: Ext.data.reader.Json.createFieldAccessExpression

                              ( name, fn, scope, options, order ) : Booleanprivate
                              ...

                              Parameters

                              Returns

                              Fires

                                ( eventName, args, action, connectedController )private
                                ...

                                Parameters

                                Fires

                                  ( name, fn, scope, options, order )private
                                  ...

                                  Parameters

                                  Fires

                                    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.

                                    Parameters

                                    • events : String/String[]

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

                                    Fires

                                      We're just preparing the data for the superclass by pulling out the record objects we want. ...

                                      We're just preparing the data for the superclass by pulling out the record objects we want. If a record was specified we have to pull those out of the larger JSON object, which is most of what this function is doing

                                      Parameters

                                      • root : Object

                                        The JSON root node

                                      Returns

                                      Fires

                                        Overrides: Ext.data.reader.Reader.extractData

                                        ( eventName, args, fn, scope ) : Object
                                        Fires the specified event with the passed parameters and execute a function (action) at the end if there are no liste...

                                        Fires the specified event with the passed parameters and execute a function (action) at the end if there are no listeners that return false.

                                        Parameters

                                        • eventName : String

                                          The name of the event to fire.

                                        • args : Array

                                          Arguments to pass to handers.

                                        • fn : Function

                                          Action.

                                        • scope : Object

                                          Scope of fn.

                                        Returns

                                        Fires

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

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

                                          The first argument is the name of the event. Every other argument passed will be available when you listen for the event.

                                          Example

                                          Firstly, we set up a listener for our new event.

                                          this.on('myevent', function(arg1, arg2, arg3, arg4, options, e) {
                                              console.log(arg1); // true
                                              console.log(arg2); // 2
                                              console.log(arg3); // { test: 'foo' }
                                              console.log(arg4); // 14
                                              console.log(options); // the options added when adding the listener
                                              console.log(e); // the event object with information about the event
                                          });
                                          

                                          And then we can fire off the event.

                                          this.fireEvent('myevent', true, 2, { test: 'foo' }, 14);
                                          

                                          An event may be set to bubble up an Observable parent hierarchy 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.

                                          Fires

                                            Used internally by readAssociated. ...

                                            Used internally by readAssociated. Given a data object (which could be json, xml etc) for a specific record, this should return the relevant part of that data for the given association name. If a complex mapping, this will traverse arrays and objects to resolve the data.

                                            Parameters

                                            • data : Object

                                              The raw data object

                                            • associationName : String

                                              The name of the association to get data for (uses associationKey if present)

                                            Returns

                                            Returns the value of bubbleEvents. ...

                                            Returns the value of bubbleEvents.

                                            Returns

                                            Returns the value of clientIdProperty. ...

                                            Returns the value of clientIdProperty.

                                            Returns

                                            ...

                                            Parameters

                                            By default this function just returns what is passed to it. ...

                                            By default this function just returns what is passed to it. It can be overridden in a subclass to return something else. See XmlReader for an example.

                                            Parameters

                                            Returns

                                            • Object

                                              The normalized data object

                                            Retrieves the id of this component. ...

                                            Retrieves the id of this component. Will autogenerate an id if one has not already been set.

                                            Returns

                                            Fires

                                              Returns the value of idProperty. ...

                                              Returns the value of idProperty.

                                              Returns

                                              Returns the value of implicitIncludes. ...

                                              Returns the value of implicitIncludes.

                                              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

                                              Returns the value of listeners. ...

                                              Returns the value of listeners.

                                              Returns

                                              ...

                                              Parameters

                                              Returns the value of messageProperty. ...

                                              Returns the value of messageProperty.

                                              Returns

                                              Returns the value of model. ...

                                              Returns the value of model.

                                              Returns

                                              Returns the value of record. ...

                                              Returns the value of record.

                                              Returns

                                              Takes a raw response object (as passed to this.read) and returns the useful data segment of it. ...

                                              Takes a raw response object (as passed to this.read) and returns the useful data segment of it. This must be implemented by each subclass

                                              Parameters

                                              Returns

                                              • Object

                                                The useful data from the response

                                              Fires

                                              Overrides: Ext.data.reader.Reader.getResponseData

                                              We create this method because root is now a config so getRoot is already defined, but in the old data package getRoot...

                                              We create this method because root is now a config so getRoot is already defined, but in the old data package getRoot was passed a data argument and it would return the data inside of the root property. This method handles both cases.

                                              Parameters

                                              Returns

                                              • String/Object

                                                Returns the config root value if this method was called without passing data. Else it returns the object in the data bound to the root.

                                              Fires

                                                Overrides: Ext.data.reader.Reader.getRoot

                                                Returns the value of rootProperty. ...

                                                Returns the value of rootProperty.

                                                Returns

                                                Ext.data.reader.Array
                                                view source
                                                ( ) : Object
                                                Returns the value of successProperty. ...

                                                Returns the value of successProperty.

                                                Returns

                                                Overrides: Ext.data.reader.Reader.getSuccessProperty

                                                Ext.data.reader.Array
                                                view source
                                                ( ) : Object
                                                Returns the value of totalProperty. ...

                                                Returns the value of totalProperty.

                                                Returns

                                                Overrides: Ext.data.reader.Reader.getTotalProperty

                                                Returns the value of useSimpleAccessors. ...

                                                Returns the value of useSimpleAccessors.

                                                Returns

                                                ...

                                                Parameters

                                                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

                                                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

                                                    ( object, eventName, [fn], [scope], [options] )deprecated
                                                    Alias for addManagedListener. ...

                                                    Alias for addManagedListener.

                                                    This method has been deprecated since 2.0.0

                                                    This is now done automatically

                                                    Parameters

                                                    • object : Ext.mixin.Observable/HTMLElement

                                                      The item to which to add a listener/listeners.

                                                    • eventName : Object/String

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

                                                    • fn : Function (optional)

                                                      If the eventName parameter was an event name, this is the handler function.

                                                    • scope : Object (optional)

                                                      If the eventName parameter was an event name, this is the scope in which the handler function is executed.

                                                    • options : Object (optional)

                                                      If the eventName parameter was an event name, this is the addListener options.

                                                    ( object, eventName, [fn], [scope] )deprecated
                                                    Alias for removeManagedListener. ...

                                                    Alias for removeManagedListener.

                                                    This method has been deprecated since 2.0.0

                                                    This is now done automatically

                                                    Parameters

                                                    • object : Ext.mixin.Observable/HTMLElement

                                                      The item to which to add a listener/listeners.

                                                    • eventName : Object/String

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

                                                    • fn : Function (optional)

                                                      If the eventName parameter was an event name, this is the handler function.

                                                    • scope : Object (optional)

                                                      If the eventName parameter was an event name, this is the scope in which the handler function is executed.

                                                    ( eventName, [fn], [scope], [options], [order] )
                                                    Alias for addListener. ...

                                                    Alias for addListener.

                                                    Parameters

                                                    • eventName : String/String[]/Object

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

                                                    • fn : Function/String (optional)

                                                      The method the event invokes. Will be called with arguments given to fireEvent plus the options parameter described below.

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

                                                      This object may contain any of the following properties:

                                                      • scope : Object (optional)

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

                                                      • delay : Number (optional)

                                                        The number of milliseconds to delay the invocation of the handler after the event fires.

                                                      • single : Boolean (optional)

                                                        true to add a handler to handle just the next firing of the event, and then remove itself.

                                                      • order : String (optional)

                                                        The order of when the listener should be added into the listener queue.

                                                        If you set an order of before and the event you are listening to is preventable, you can return false and it will stop the event.

                                                        Available options are before, current and after.

                                                        Defaults to: current

                                                      • buffer : Number (optional)

                                                        Causes the handler to be 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.

                                                      • element : String (optional)

                                                        Allows you to add a listener onto a element of this component using the elements reference.

                                                        Ext.create('Ext.Component', {
                                                            listeners: {
                                                                element: 'element',
                                                                tap: function() {
                                                                    alert('element tap!');
                                                                }
                                                            }
                                                        });
                                                        

                                                        All components have the element reference, which is the outer most element of the component. Ext.Container also has the innerElement element which contains all children. In most cases element is adequate.

                                                      • delegate : String (optional)

                                                        Uses Ext.ComponentQuery to delegate events to a specified query selector within this item.

                                                        // Create a container with a two children; a button and a toolbar
                                                        var container = Ext.create('Ext.Container', {
                                                            items: [
                                                                {
                                                                    xtype: 'toolbar',
                                                                    docked: 'top',
                                                                    title: 'My Toolbar'
                                                                },
                                                                {
                                                                   xtype: 'button',
                                                                   text: 'My Button'
                                                                }
                                                            ]
                                                        });
                                                        
                                                        container.addListener({
                                                            // Ext.Buttons have an xtype of 'button', so we use that are a selector for our delegate
                                                            delegate: 'button',
                                                        
                                                            tap: function() {
                                                                alert('Button tapped!');
                                                            }
                                                        });
                                                        
                                                    • order : String (optional)

                                                      The order of when the listener should be added into the listener queue. Possible values are before, current and after.

                                                      Defaults to: 'current'

                                                    ( eventName, fn, [scope], [options] )
                                                    Alias for addAfterListener. ...

                                                    Alias for addAfterListener.

                                                    Parameters

                                                    • eventName : String/String[]/Object

                                                      The name of the event to listen for.

                                                    • fn : Function/String

                                                      The method the event invokes.

                                                    • scope : Object (optional)

                                                      The scope for fn.

                                                    • options : Object (optional)

                                                      An object containing handler configuration.

                                                    ( eventName, fn, [scope], [options] )
                                                    Alias for addBeforeListener. ...

                                                    Alias for addBeforeListener.

                                                    Parameters

                                                    • eventName : String/String[]/Object

                                                      The name of the event to listen for.

                                                    • fn : Function/String

                                                      The method the event invokes.

                                                    • scope : Object (optional)

                                                      The scope for fn.

                                                    • options : Object (optional)

                                                      An object containing handler configuration.

                                                    Convert old properties in data into a config object ...

                                                    Convert old properties in data into a config object

                                                    Parameters

                                                    Overrides: Ext.mixin.Mixin.onClassExtended

                                                    ( names, callback, scope )private
                                                    ...

                                                    Parameters

                                                    Reconfigures the meta data tied to this Reader ...

                                                    Reconfigures the meta data tied to this Reader

                                                    Parameters

                                                    Fires

                                                      ...

                                                      Parameters

                                                      Fires

                                                      • exception
                                                      Reads the given response object. ...

                                                      Reads the given response object. This method normalizes the different types of response object that may be passed to it, before handing off the reading of records to the readRecords function.

                                                      Parameters

                                                      • response : Object

                                                        The response object. This may be either an XMLHttpRequest object or a plain JS object

                                                      Returns

                                                      Fires

                                                      • exception
                                                      Loads a record's associations from the data object. ...

                                                      Loads a record's associations from the data object. This pre-populates hasMany and belongsTo associations on the record provided.

                                                      Parameters

                                                      Fires

                                                        Abstracts common functionality used by all Reader subclasses. ...

                                                        Abstracts common functionality used by all Reader subclasses. Each subclass is expected to call this function before running its own logic and returning the Ext.data.ResultSet instance. For most Readers additional processing should not be needed.

                                                        Parameters

                                                        • data : Object

                                                          The raw data object

                                                        Returns

                                                        Fires

                                                          ( args, fn, scope, options, order )private
                                                          ...

                                                          Parameters

                                                          Fires

                                                            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

                                                            • object : Object

                                                              The Observable whose events this object is to relay.

                                                            • events : String/Array/Object

                                                              Array of event names to relay.

                                                            Returns

                                                            Fires

                                                              ( eventName, fn, [scope], [options] )
                                                              Removes a before-event handler. ...

                                                              Removes a before-event handler.

                                                              Same as removeListener with order set to 'after'.

                                                              Parameters

                                                              • eventName : String/String[]/Object

                                                                The name of the event the handler was associated with.

                                                              • fn : Function/String

                                                                The handler to remove.

                                                              • scope : Object (optional)

                                                                The scope originally specified for fn.

                                                              • options : Object (optional)

                                                                Extra options object.

                                                              Fires

                                                                ( eventName, fn, [scope], [options] )
                                                                Removes a before-event handler. ...

                                                                Removes a before-event handler.

                                                                Same as removeListener with order set to 'before'.

                                                                Parameters

                                                                • eventName : String/String[]/Object

                                                                  The name of the event the handler was associated with.

                                                                • fn : Function/String

                                                                  The handler to remove.

                                                                • scope : Object (optional)

                                                                  The scope originally specified for fn.

                                                                • options : Object (optional)

                                                                  Extra options object.

                                                                Fires

                                                                  ( selector, name, fn, scope, order )private
                                                                  ...

                                                                  Parameters

                                                                  Fires

                                                                    ( eventName, fn, [scope], [options], [order] )
                                                                    Removes an event handler. ...

                                                                    Removes an event handler.

                                                                    Parameters

                                                                    • eventName : String/String[]/Object

                                                                      The type of event the handler was associated with.

                                                                    • fn : Function/String

                                                                      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. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.

                                                                    • options : Object (optional)

                                                                      Extra options object. See addListener for details.

                                                                    • order : String (optional)

                                                                      The order of the listener to remove. Possible values are before, current and after.

                                                                      Defaults to: 'current'

                                                                    Fires

                                                                      ( object, eventName, [fn], [scope] )deprecated
                                                                      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.

                                                                      This method has been deprecated since 2.0

                                                                      All listeners are now automatically managed where necessary. Simply use removeListener.

                                                                      Parameters

                                                                      • object : Ext.mixin.Observable/HTMLElement

                                                                        The item to which to add a listener/listeners.

                                                                      • eventName : Object/String

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

                                                                      • fn : Function (optional)

                                                                        If the eventName parameter was an event name, this is the handler function.

                                                                      • scope : Object (optional)

                                                                        If the eventName parameter was an event name, this is the scope in which the handler function is executed.

                                                                      Resumes firing events (see suspendEvents). ...

                                                                      Resumes firing events (see suspendEvents).

                                                                      Parameters

                                                                      • discardQueuedEvents : Boolean

                                                                        Pass as true to discard any queued events.

                                                                      Sets the value of bubbleEvents. ...

                                                                      Sets the value of bubbleEvents.

                                                                      Parameters

                                                                      Sets the value of clientIdProperty. ...

                                                                      Sets the value of clientIdProperty.

                                                                      Parameters

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

                                                                      Parameters

                                                                      Returns

                                                                      ...

                                                                      Parameters

                                                                      Sets the value of idProperty. ...

                                                                      Sets the value of idProperty.

                                                                      Parameters

                                                                      Sets the value of implicitIncludes. ...

                                                                      Sets the value of implicitIncludes.

                                                                      Parameters

                                                                      Sets the value of listeners. ...

                                                                      Sets the value of listeners.

                                                                      Parameters

                                                                      Sets the value of messageProperty. ...

                                                                      Sets the value of messageProperty.

                                                                      Parameters

                                                                      Sets the value of model. ...

                                                                      Sets the value of model.

                                                                      Parameters

                                                                      Sets the value of record. ...

                                                                      Sets the value of record.

                                                                      Parameters

                                                                      Sets the value of rootProperty. ...

                                                                      Sets the value of rootProperty.

                                                                      Parameters

                                                                      Ext.data.reader.Array
                                                                      view source
                                                                      ( successProperty )
                                                                      Sets the value of successProperty. ...

                                                                      Sets the value of successProperty.

                                                                      Parameters

                                                                      Overrides: Ext.data.reader.Reader.setSuccessProperty

                                                                      Ext.data.reader.Array
                                                                      view source
                                                                      ( totalProperty )
                                                                      Sets the value of totalProperty. ...

                                                                      Sets the value of totalProperty.

                                                                      Parameters

                                                                      Overrides: Ext.data.reader.Reader.setTotalProperty

                                                                      Sets the value of useSimpleAccessors. ...

                                                                      Sets the value of useSimpleAccessors.

                                                                      Parameters

                                                                      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

                                                                      Suspends the firing of all events. ...

                                                                      Suspends the firing of all events.

                                                                      All events will be queued but you can discard the queued events by passing false in the resumeEvents call

                                                                      ( toggle, eventName, fn, scope, options, order )private
                                                                      ...

                                                                      Parameters

                                                                      Fires

                                                                        ( eventName, fn, [scope], [options], [order] )
                                                                        Alias for removeListener. ...

                                                                        Alias for removeListener.

                                                                        Parameters

                                                                        • eventName : String/String[]/Object

                                                                          The type of event the handler was associated with.

                                                                        • fn : Function/String

                                                                          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. It must be the same as the scope argument specified in the original call to addListener or the listener will not be removed.

                                                                        • options : Object (optional)

                                                                          Extra options object. See addListener for details.

                                                                        • order : String (optional)

                                                                          The order of the listener to remove. Possible values are before, current and after.

                                                                          Defaults to: 'current'

                                                                        ( eventName, fn, [scope], [options] )
                                                                        Alias for removeAfterListener. ...

                                                                        Alias for removeAfterListener.

                                                                        Parameters

                                                                        • eventName : String/String[]/Object

                                                                          The name of the event the handler was associated with.

                                                                        • fn : Function/String

                                                                          The handler to remove.

                                                                        • scope : Object (optional)

                                                                          The scope originally specified for fn.

                                                                        • options : Object (optional)

                                                                          Extra options object.

                                                                        ( eventName, fn, [scope], [options] )
                                                                        Alias for removeBeforeListener. ...

                                                                        Alias for removeBeforeListener.

                                                                        Parameters

                                                                        • eventName : String/String[]/Object

                                                                          The name of the event the handler was associated with.

                                                                        • fn : Function/String

                                                                          The handler to remove.

                                                                        • scope : Object (optional)

                                                                          The scope originally specified for fn.

                                                                        • options : Object (optional)

                                                                          Extra options object.

                                                                        ...

                                                                        Parameters

                                                                        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

                                                                          Defined By

                                                                          Events

                                                                          ( reader, response, error, eOpts )
                                                                          Fires whenever the reader is unable to parse a response. ...

                                                                          Fires whenever the reader is unable to parse a response.

                                                                          Parameters