Touch 2.0.2 Sencha Docs

Ext.data.reader.Reader

Alternate names

Ext.data.DataReader
Ext.data.Reader

Hierarchy

Ext.Base
Ext.data.reader.Reader

Mixins

Requires

Subclasses

Files

Readers are used to interpret data to be loaded into a Model instance or a Store - often in response to an AJAX request. In general there is usually no need to create a Reader instance directly, since a Reader is almost always used together with a Proxy, and is configured using the Proxy's reader configuration property:

Ext.create('Ext.data.Store', {
    model: 'User',
    proxy: {
        type: 'ajax',
        url : 'users.json',
        reader: {
            type: 'json',
            rootProperty: 'users'
        }
    },
});

The above reader is configured to consume a JSON string that looks something like this:

{
    "success": true,
    "users": [
        { "name": "User 1" },
        { "name": "User 2" }
    ]
}

Loading Nested Data

Readers have the ability to automatically load deeply-nested data objects based on the associations configured on each Model. Below is an example demonstrating the flexibility of these associations in a fictional CRM system which manages a User, their Orders, OrderItems and Products. First we'll define the models:

Ext.define('User', {
    extend: 'Ext.data.Model',
    config: {
        fields: [
            'id', 'name'
        ],

        hasMany: {model: 'Order', name: 'orders'},

        proxy: {
            type: 'rest',
            url : 'users.json',
            reader: {
                type: 'json',
                rootProperty: 'users'
            }
        }
    }
});

Ext.define('Order', {
    extend: 'Ext.data.Model',
    config: {
        fields: [
            'id', 'total'
        ],

        hasMany  : {model: 'OrderItem', name: 'orderItems', associationKey: 'order_items'},
        belongsTo: 'User'
    }
});

Ext.define('OrderItem', {
    extend: 'Ext.data.Model',
    config: {
        fields: [
            'id', 'price', 'quantity', 'order_id', 'product_id'
        ],

        belongsTo: ['Order', {model: 'Product', associationKey: 'product'}]
    }
});

Ext.define('Product', {
    extend: 'Ext.data.Model',
    config : {
        fields: [
            'id', 'name'
        ],

        hasMany: 'OrderItem'
    }
});

This may be a lot to take in - basically a User has many Orders, each of which is composed of several OrderItems. Finally, each OrderItem has a single Product. This allows us to consume data like this:

{
    "users": [
        {
            "id": 123,
            "name": "Ed",
            "orders": [
                {
                    "id": 50,
                    "total": 100,
                    "order_items": [
                        {
                            "id"      : 20,
                            "price"   : 40,
                            "quantity": 2,
                            "product" : {
                                "id": 1000,
                                "name": "MacBook Pro"
                            }
                        },
                        {
                            "id"      : 21,
                            "price"   : 20,
                            "quantity": 3,
                            "product" : {
                                "id": 1001,
                                "name": "iPhone"
                            }
                        }
                    ]
                }
            ]
        }
    ]
}

The JSON response is deeply nested - it returns all Users (in this case just 1 for simplicity's sake), all of the Orders for each User (again just 1 in this case), all of the OrderItems for each Order (2 order items in this case), and finally the Product associated with each OrderItem. Now we can read the data and use it as follows:

var store = Ext.create('Ext.data.Store', {
    model: 'User'
});

store.load({
    callback: function() {
        //the user that was loaded
        var user = store.first();

        console.log('Orders for ' + user.get('name') + ':')

        //iterate over the Orders for each User
        user.orders().each(function(order) {
            console.log('Order ID: ' + order.getId() + ', which contains items:');

            //iterate over the OrderItems for each Order
            order.orderItems().each(function(orderItem) {
                //we know that the Product data is already loaded, so we can use the synchronous getProduct
                //usually, we would use the asynchronous version (see Ext.data.association.BelongsTo)
                var product = orderItem.getProduct();

                console.log(orderItem.get('quantity') + ' orders of ' + product.get('name'));
            });
        });
    }
});

Running the code above results in the following:

Orders for Ed:
Order ID: 50, which contains items:
2 orders of MacBook Pro
3 orders of iPhone

Available since: 1.1.0

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.

Available since: 2.0.0

Ext.data.reader.Reader
view source
: String
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'

Available since: 2.0.0

Ext.data.reader.Reader
view source
: String
Name of the property within a row object that contains a record identifier value. ...

Name of the property within a row 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

Available since: 1.1.0

Ext.data.reader.Reader
view source
: Boolean
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.

Defaults to: true

Available since: 1.1.0

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 listeners config when you are defining a class using Ext.define. Instead, only specify listeners when you are instantiating your class with Ext.create.

Available since: 1.1.0

Ext.data.reader.Reader
view source
: String
The name of the property which contains a response message. ...

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

Available since: 2.0.0

Ext.data.reader.Reader
view source
: Objectprivate

Available since: 2.0.0

Ext.data.reader.Reader
view source
: Stringdeprecated
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.

Available since: 1.1.0

This cfg has been deprecated since 2.0.0

Please use the rootProperty configuration instead.

Ext.data.reader.Reader
view source
: String
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: ''

Available since: 2.0.0

Ext.data.reader.Reader
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. Defaults to success. See Ext.data.proxy.Server.exception for additional information.

Defaults to: 'success'

Available since: 1.1.0

Ext.data.reader.Reader
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.

Defaults to: 'total'

Available since: 1.1.0

Properties

Defined By

Instance properties

...

Defaults to: 'ext-'

Available since: 2.0.0

...

Defaults to: '-'

Available since: 2.0.0

...

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

Available since: 2.0.0

...

Defaults to: true

Available since: 2.0.0

...

Defaults to: true

Available since: 1.1.0

Ext.data.reader.Reader
view source
: Booleanprivate
private ...

private

Defaults to: true

Available since: 2.0.0

...

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

Available since: 2.0.0

Ext.data.reader.Reader
view source
: Object
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.

Available since: 2.0.0

...

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

Available since: 2.0.0

...

Defaults to: 'identifiable'

Available since: 2.0.0

...

Defaults to: '#'

Available since: 2.0.0

...

Defaults to: 'observable'

Available since: 2.0.0

Ext.data.reader.Reader
view source
: Object
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

Available since: 1.1.0

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); / dependentOL 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'

Available since: 2.0.0

...

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

Available since: 2.0.0

Defined By

Static properties

...

Defaults to: []

Available since: 2.0.0

Methods

Defined By

Instance methods

Ext.data.reader.Reader
view source
new( config ) : Ext.data.reader.Reader
...

Available since: 1.1.0

Parameters

Returns

Fires

    Overrides: Ext.mixin.Observable.constructor

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

    Appends an after-event handler.

    Same as addListener with order set to 'after'.

    Available since: 2.0.0

    Parameters

    • eventName : String

      The name of the event to listen for.

    • fn : Function

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

      Available since: 2.0.0

      Parameters

      • eventName : String

        The name of the event to listen for.

      • fn : Function

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

        Available since: 2.0.0

        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.

          Available since: 1.1.0

          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.on('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.on({
              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.on({
              tap  : { fn: this.onTap, scope: this, single: true },
              swipe: { fn: button.onSwipe, scope: button }
          });
          

          See the Events Guide for more.

          Available since: 1.1.0

          Parameters

          • eventName : String

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

          • fn : Function

            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

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

            • delay : Number

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

            • single : Boolean

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

            • order : String

              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

              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

              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() {
                          console.log('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

              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.on({
                  // 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.

            Available since: 1.1.0

            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.

            ...

            Available since: 2.0.0

            Parameters

            Fires

              Ext.data.reader.Reader
              view source
              ( idProperty )private
              ...

              Available since: 2.0.0

              Parameters

              Fires

                ...

                Available since: 2.0.0

                Parameters

                Fires

                  Ext.data.reader.Reader
                  view source
                  ( model )private
                  ...

                  Available since: 2.0.0

                  Parameters

                  Ext.data.reader.Reader
                  view source
                  ( )private
                  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.

                  Available since: 1.1.0

                  Fires

                    Ext.data.reader.Reader
                    view source
                    ( )private
                    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.

                    Available since: 2.0.0

                    Fires

                      Call the original method that was previously overridden with override Ext.define('My.Cat', { constructor: functi...

                      Call the original method that was previously overridden with override

                      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"
                      

                      Available since: 2.0.0

                      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
                      

                      Available since: 2.0.0

                      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

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

                      Available since: 2.0.0

                      Parameters

                      Removes all listeners for this object. ...

                      Removes all listeners for this object.

                      Available since: 1.1.0

                      Fires

                        ...

                        Available since: 1.1.0

                        Parameters

                        Fires

                          Ext.data.reader.Reader
                          view source
                          ( )private
                          ...

                          Available since: 2.0.0

                          ...

                          Available since: 2.0.0

                          Parameters

                          Fires

                            Creates an event handling function which refires the event from this object as the passed event name. ...

                            Creates an event handling function which refires the event from this object as the passed event name.

                            Available since: 2.0.0

                            Parameters

                            Returns

                            Fires

                              Ext.data.reader.Reader
                              view source
                              ( )private
                              ...

                              Available since: 2.0.0

                              ...

                              Available since: 2.0.0

                              Fires

                              • destroy

                              Overrides: Ext.Base.destroy

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

                              Available since: 2.0.0

                              Parameters

                              Fires

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

                                Available since: 2.0.0

                                Parameters

                                Fires

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

                                  Available since: 2.0.0

                                  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.

                                    Available since: 1.1.0

                                    Parameters

                                    • events : String/String[]

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

                                    Fires

                                      Ext.data.reader.Reader
                                      view source
                                      ( root )private
                                      Returns extracted, type-cast rows of data. ...

                                      Returns extracted, type-cast rows of data.

                                      Available since: 1.1.0

                                      Parameters

                                      Fires

                                        ( eventName, args, fn, scope )
                                        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.

                                        Available since: 2.0.0

                                        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

                                        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.

                                          Available since: 1.1.0

                                          Parameters

                                          • eventName : String

                                            The name of the event to fire.

                                          • args : Object...

                                            Variable number of parameters are passed to handlers.

                                          Returns

                                          • Boolean

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

                                          Fires

                                            Ext.data.reader.Reader
                                            view source
                                            ( data, associationName ) : Objectprivate
                                            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. This is only really needed to support the XML Reader, which has to do a query to get the associated data object

                                            Available since: 1.1.0

                                            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.

                                            Available since: 2.0.0

                                            Returns

                                            ...

                                            Available since: 2.0.0

                                            Ext.data.reader.Reader
                                            view source
                                            ( ) : String
                                            Returns the value of clientIdProperty. ...

                                            Returns the value of clientIdProperty.

                                            Available since: 2.0.0

                                            Returns

                                            ...

                                            Available since: 2.0.0

                                            Parameters

                                            ...

                                            Available since: 2.0.0

                                            Ext.data.reader.Reader
                                            view source
                                            ( data ) : Objectprivate
                                            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.

                                            Available since: 1.1.0

                                            Parameters

                                            Returns

                                            • Object

                                              The normalized data object

                                            ...

                                            Available since: 2.0.0

                                            Fires

                                              Ext.data.reader.Reader
                                              view source
                                              ( )private
                                              ...

                                              Available since: 2.0.0

                                              Fires

                                                Retrieves the id of this component. ...

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

                                                Available since: 2.0.0

                                                Returns

                                                Fires

                                                  Ext.data.reader.Reader
                                                  view source
                                                  ( ) : String
                                                  Returns the value of idProperty. ...

                                                  Returns the value of idProperty.

                                                  Available since: 2.0.0

                                                  Returns

                                                  Ext.data.reader.Reader
                                                  view source
                                                  ( ) : Boolean
                                                  Returns the value of implicitIncludes. ...

                                                  Returns the value of implicitIncludes.

                                                  Available since: 2.0.0

                                                  Returns

                                                  Returns the initial configuration passed to constructor. ...

                                                  Returns the initial configuration passed to constructor.

                                                  Available since: 2.0.0

                                                  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.

                                                  Available since: 2.0.0

                                                  Returns

                                                  ...

                                                  Available since: 2.0.0

                                                  Parameters

                                                  Ext.data.reader.Reader
                                                  view source
                                                  ( ) : String
                                                  Returns the value of messageProperty. ...

                                                  Returns the value of messageProperty.

                                                  Available since: 2.0.0

                                                  Returns

                                                  Ext.data.reader.Reader
                                                  view source
                                                  ( ) : Object
                                                  Returns the value of model. ...

                                                  Returns the value of model.

                                                  Available since: 2.0.0

                                                  Returns

                                                  ...

                                                  Available since: 2.0.0

                                                  Fires

                                                    ...

                                                    Available since: 2.0.0

                                                    ...

                                                    Available since: 2.0.0

                                                    Ext.data.reader.Reader
                                                    view source
                                                    ( response ) : Object
                                                    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

                                                    Available since: 1.1.0

                                                    Parameters

                                                    • response : Object

                                                      The response object

                                                    Returns

                                                    • Object

                                                      The useful data from the response

                                                    Ext.data.reader.Reader
                                                    view source
                                                    ( data ) : Objectprivate
                                                    This will usually need to be implemented in a subclass. ...

                                                    This will usually need to be implemented in a subclass. Given a generic data object (the type depends on the type of data we are reading), this function should return the object as configured by the Reader's 'rootProperty' meta data config. See XmlReader's getRoot implementation for an example. By default the same data object will simply be returned.

                                                    Available since: 1.1.0

                                                    Parameters

                                                    Returns

                                                    Ext.data.reader.Reader
                                                    view source
                                                    ( ) : String
                                                    Returns the value of rootProperty. ...

                                                    Returns the value of rootProperty.

                                                    Available since: 2.0.0

                                                    Returns

                                                    Ext.data.reader.Reader
                                                    view source
                                                    ( ) : String
                                                    Returns the value of successProperty. ...

                                                    Returns the value of successProperty.

                                                    Available since: 2.0.0

                                                    Returns

                                                    Ext.data.reader.Reader
                                                    view source
                                                    ( ) : String
                                                    Returns the value of totalProperty. ...

                                                    Returns the value of totalProperty.

                                                    Available since: 2.0.0

                                                    Returns

                                                    ...

                                                    Available since: 2.0.0

                                                    ...

                                                    Available since: 2.0.0

                                                    ...

                                                    Available since: 2.0.0

                                                    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

                                                    Available since: 1.1.0

                                                    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'
                                                      

                                                      Available since: 2.0.0

                                                      Parameters

                                                      Returns

                                                      • Object

                                                        mixins The mixin prototypes as key - value pairs

                                                      Fires

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

                                                        Alias for addManagedListener.

                                                        Available since: 2.0.0

                                                        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.

                                                        Available since: 2.0.0

                                                        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.

                                                        Available since: 1.1.0

                                                        Parameters

                                                        • eventName : String

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

                                                        • fn : Function

                                                          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

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

                                                          • delay : Number

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

                                                          • single : Boolean

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

                                                          • order : String

                                                            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

                                                            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

                                                            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() {
                                                                        console.log('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

                                                            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.on({
                                                                // 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.

                                                        Available since: 2.0.0

                                                        Parameters

                                                        • eventName : String

                                                          The name of the event to listen for.

                                                        • fn : Function

                                                          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.

                                                        Available since: 2.0.0

                                                        Parameters

                                                        • eventName : String

                                                          The name of the event to listen for.

                                                        • fn : Function

                                                          The method the event invokes.

                                                        • scope : Object (optional)

                                                          The scope for fn.

                                                        • options : Object (optional)

                                                          An object containing handler configuration.

                                                        Ext.data.reader.Reader
                                                        view source
                                                        ( cls, data, hooks )private
                                                        Convert old properties in data into a config object ...

                                                        Convert old properties in data into a config object

                                                        Available since: 2.0.0

                                                        Parameters

                                                        Overrides: Ext.mixin.Mixin.onClassExtended

                                                        ( names, callback, scope )private
                                                        ...

                                                        Available since: 2.0.0

                                                        Parameters

                                                        Ext.data.reader.Reader
                                                        view source
                                                        ( meta )private
                                                        Reconfigures the meta data tied to this Reader ...

                                                        Reconfigures the meta data tied to this Reader

                                                        Available since: 1.1.0

                                                        Parameters

                                                        Fires

                                                          Ext.data.reader.Reader
                                                          view source
                                                          ( response )private
                                                          ...

                                                          Available since: 2.0.0

                                                          Parameters

                                                          Fires

                                                            Ext.data.reader.Reader
                                                            view source
                                                            ( response ) : Ext.data.ResultSet
                                                            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.

                                                            Available since: 1.1.0

                                                            Parameters

                                                            • response : Object

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

                                                            Returns

                                                            Fires

                                                              Ext.data.reader.Reader
                                                              view source
                                                              ( record, data ) : Stringprivate
                                                              Loads a record's associations from the data object. ...

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

                                                              Available since: 1.1.0

                                                              Parameters

                                                              Returns

                                                              • String

                                                                Return value description

                                                              Fires

                                                                Ext.data.reader.Reader
                                                                view source
                                                                ( data ) : Ext.data.ResultSet
                                                                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.

                                                                Available since: 1.1.0

                                                                Parameters

                                                                • data : Object

                                                                  The raw data object

                                                                Returns

                                                                Fires

                                                                  ...

                                                                  Available since: 2.0.0

                                                                  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.

                                                                    Available since: 1.1.0

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

                                                                      Available since: 2.0.0

                                                                      Parameters

                                                                      • eventName : String

                                                                        The name of the event the handler was associated with.

                                                                      • fn : Function

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

                                                                        Available since: 2.0.0

                                                                        Parameters

                                                                        • eventName : String

                                                                          The name of the event the handler was associated with.

                                                                        • fn : Function

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

                                                                          Available since: 2.0.0

                                                                          Parameters

                                                                          Fires

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

                                                                            Removes an event handler.

                                                                            Available since: 1.1.0

                                                                            Parameters

                                                                            • eventName : String

                                                                              The type of event the handler was associated with.

                                                                            • fn : Function

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

                                                                            • scope : Object (optional)

                                                                              The scope originally specified for the handler. 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.

                                                                              Available since: 1.1.0

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

                                                                              If events were suspended using the queueSuspended parameter, then all events fired during event suspension will be sent to any listeners now.

                                                                              Available since: 1.1.0

                                                                              Sets the value of bubbleEvents. ...

                                                                              Sets the value of bubbleEvents.

                                                                              Available since: 2.0.0

                                                                              Parameters

                                                                              Ext.data.reader.Reader
                                                                              view source
                                                                              ( clientIdProperty )
                                                                              Sets the value of clientIdProperty. ...

                                                                              Sets the value of clientIdProperty.

                                                                              Available since: 2.0.0

                                                                              Parameters

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

                                                                              Available since: 2.0.0

                                                                              Parameters

                                                                              Returns

                                                                              ...

                                                                              Available since: 2.0.0

                                                                              Parameters

                                                                              Ext.data.reader.Reader
                                                                              view source
                                                                              ( idProperty )
                                                                              Sets the value of idProperty. ...

                                                                              Sets the value of idProperty.

                                                                              Available since: 2.0.0

                                                                              Parameters

                                                                              Ext.data.reader.Reader
                                                                              view source
                                                                              ( implicitIncludes )
                                                                              Sets the value of implicitIncludes. ...

                                                                              Sets the value of implicitIncludes.

                                                                              Available since: 2.0.0

                                                                              Parameters

                                                                              Sets the value of listeners. ...

                                                                              Sets the value of listeners.

                                                                              Available since: 2.0.0

                                                                              Parameters

                                                                              Ext.data.reader.Reader
                                                                              view source
                                                                              ( messageProperty )
                                                                              Sets the value of messageProperty. ...

                                                                              Sets the value of messageProperty.

                                                                              Available since: 2.0.0

                                                                              Parameters

                                                                              Ext.data.reader.Reader
                                                                              view source
                                                                              ( model )
                                                                              Sets the value of model. ...

                                                                              Sets the value of model.

                                                                              Available since: 1.1.0

                                                                              Parameters

                                                                              Ext.data.reader.Reader
                                                                              view source
                                                                              ( rootProperty )
                                                                              Sets the value of rootProperty. ...

                                                                              Sets the value of rootProperty.

                                                                              Available since: 2.0.0

                                                                              Parameters

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

                                                                              Sets the value of successProperty.

                                                                              Available since: 2.0.0

                                                                              Parameters

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

                                                                              Sets the value of totalProperty.

                                                                              Available since: 2.0.0

                                                                              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
                                                                              

                                                                              Available since: 2.0.0

                                                                              Returns

                                                                              Suspends the firing of all events. ...

                                                                              Suspends the firing of all events. (see resumeEvents)

                                                                              Available since: 1.1.0

                                                                              Parameters

                                                                              • queueSuspended : Boolean

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

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

                                                                              Alias for removeListener.

                                                                              Available since: 1.1.0

                                                                              Parameters

                                                                              • eventName : String

                                                                                The type of event the handler was associated with.

                                                                              • fn : Function

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

                                                                              • scope : Object (optional)

                                                                                The scope originally specified for the handler. 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.

                                                                              Available since: 2.0.0

                                                                              Parameters

                                                                              • eventName : String

                                                                                The name of the event the handler was associated with.

                                                                              • fn : Function

                                                                                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.

                                                                              Available since: 2.0.0

                                                                              Parameters

                                                                              • eventName : String

                                                                                The name of the event the handler was associated with.

                                                                              • fn : Function

                                                                                The handler to remove.

                                                                              • scope : Object (optional)

                                                                                The scope originally specified for fn.

                                                                              • options : Object (optional)

                                                                                Extra options object.

                                                                              Ext.data.reader.Reader
                                                                              view source
                                                                              ( model )private
                                                                              ...

                                                                              Available since: 2.0.0

                                                                              Parameters

                                                                              Fires

                                                                                Defined By

                                                                                Static methods

                                                                                ( config, fullMerge )privatestatic
                                                                                ...

                                                                                Available since: 2.0.0

                                                                                Parameters

                                                                                ( members )chainableprivatestatic
                                                                                ...

                                                                                Available since: 2.0.0

                                                                                Parameters

                                                                                ( name, member )chainableprivatestatic
                                                                                ...

                                                                                Available since: 2.0.0

                                                                                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.implement({
                                                                                     meow: function() {
                                                                                        alert('Meowww...');
                                                                                     }
                                                                                 });
                                                                                
                                                                                 var kitty = new My.awesome.Cat;
                                                                                 kitty.meow();
                                                                                

                                                                                Available since: 2.0.0

                                                                                Parameters

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

                                                                                Add / override static properties of this class.

                                                                                Ext.define('My.cool.Class', {
                                                                                    ...
                                                                                });
                                                                                
                                                                                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() { ... };
                                                                                });
                                                                                

                                                                                Available since: 2.0.0

                                                                                Parameters

                                                                                Returns

                                                                                ( xtype )chainableprivatestatic
                                                                                ...

                                                                                Available since: 2.0.0

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

                                                                                Available since: 2.0.0

                                                                                Parameters

                                                                                • fromClass : Ext.Base

                                                                                  The class to borrow members from

                                                                                • members : Array/String

                                                                                  The names of the members to borrow

                                                                                Returns

                                                                                ( args )privatestatic
                                                                                ...

                                                                                Available since: 2.0.0

                                                                                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.

                                                                                Available since: 2.0.0

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

                                                                                Available since: 2.0.0

                                                                                Parameters

                                                                                ( parent )privatestatic
                                                                                ...

                                                                                Available since: 2.0.0

                                                                                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'
                                                                                

                                                                                Available since: 2.0.0

                                                                                Returns

                                                                                ...

                                                                                Available since: 2.0.0

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

                                                                                Used internally by the mixins pre-processor

                                                                                Available since: 2.0.0

                                                                                Parameters

                                                                                ( fn, scope )chainableprivatestatic
                                                                                ...

                                                                                Available since: 2.0.0

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

                                                                                Available since: 2.0.0

                                                                                This method has been deprecated since 4.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

                                                                                ...

                                                                                Available since: 2.0.0