Ext.data.reader.Array

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

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

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

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

Available since: 2.0.0

Available since: 2.0.0

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

Defaults to: null

Available since: 1.1.0

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

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

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

Defaults to: false

Available since: 2.0.0

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

private

Defaults to: true

Available since: 2.0.0

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

Available since: 2.0.0

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: '#'

Available since: 2.0.0

Defaults to: 'observable'

Available since: 2.0.0

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

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.

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.

Available since: 2.0.0

Parameters

• selector : Object
• name : Object
• fn : Object
• scope : Object
• options : Object
• order : Object

Adds the specified events to the list of events which this Observable may fire.

Available since: 1.1.0

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.

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'

Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed.

Available since: 1.1.0

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

• bubbleEvents : Object

Available since: 2.0.0

Parameters

• idProperty : Object

Available since: 2.0.0

Parameters

• listeners : Object

Available since: 2.0.0

Parameters

• model : Object

inherit docs

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

Overrides: Ext.data.reader.Reader.buildExtractors

Return a function which will read a raw row object in the format this Reader accepts, and populates a record's data 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

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

Available since: 2.0.0

Parameters

• operation : Object
• eventName : Object
• fn : Object
• scope : Object
• options : Object
• order : Object

Removes all listeners for this object.

Available since: 1.1.0

Available since: 1.1.0

Parameters

• object : Object

Available since: 2.0.0

Available since: 2.0.0

Parameters

• name : Object

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

Available since: 2.0.0

Parameters

• newName : Object

Returns

• Function

Available since: 2.0.0

Overrides: Ext.Base.destroy

Available since: 2.0.0

Parameters

• name : Object
• fn : Object
• scope : Object
• options : Object

Available since: 2.0.0

Parameters

• eventName : Object
• args : Object
• action : Object
• connectedController : Object

Available since: 2.0.0

Parameters

• name : Object
• fn : Object
• scope : Object
• options : Object
• order : Object

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.

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

Available since: 1.1.0

Parameters

• root : Object

  The JSON root node

Returns

• Ext.data.Model[]

  The records

Overrides: Ext.data.reader.Reader.extractData

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

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

• Object

  The root

Returns the value of bubbleEvents.

Available since: 2.0.0

Returns

• String/String[]

Available since: 2.0.0

Returns the value of clientIdProperty.

Available since: 2.0.0

Returns

• String

Available since: 2.0.0

Parameters

• name : Object

Available since: 2.0.0

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

• data : Object

  The data object

Returns

• Object

  The normalized data object

Available since: 2.0.0

Available since: 2.0.0

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

Available since: 2.0.0

Returns

• String

  id

Returns the value of idProperty.

Available since: 2.0.0

Returns

• String

Returns the value of implicitIncludes.

Available since: 2.0.0

Returns

• Boolean

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

• Object/Mixed

Returns the value of listeners.

Available since: 2.0.0

Returns

• Object

Available since: 2.0.0

Parameters

• object : Object
• eventName : Object

Returns the value of messageProperty.

Available since: 2.0.0

Returns

• String

Returns the value of model.

Available since: 2.0.0

Returns

• Object

Available since: 2.0.0

Available since: 2.0.0

Available since: 2.0.0

Available since: 2.0.0

Returns the value of record.

Available since: 2.0.0

Returns

• String

inherit docs

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

Overrides: Ext.data.reader.Reader.getResponseData

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

Available since: 1.1.0

Parameters

• data : Object (optional)

Returns

• String/Object

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

Overrides: Ext.data.reader.Reader.getRoot

Returns the value of rootProperty.

Available since: 2.0.0

Returns

• String

Available since: 2.0.0

Returns the value of useSimpleAccessors.

Available since: 2.0.0

Returns

• Boolean

Available since: 2.0.0

Available since: 2.0.0

Parameters

• name : Object

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

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

• instanceConfig : Object

Returns

• Object

  mixins The mixin prototypes as key - value pairs

Alias for addManagedListener.

Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed.

Available since: 2.0.0

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.

Alias for removeManagedListener.

Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed.

Available since: 2.0.0

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.

Alias for addListener.

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'

Alias for addAfterListener.

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.

Alias for addBeforeListener.

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.

Convert old properties in data into a config object

Available since: 2.0.0

Parameters

• cls : Object
• data : Object
• hooks : Object

Overrides: Ext.mixin.Mixin.onClassExtended

Available since: 2.0.0

Parameters

• names : Object
• callback : Object
• scope : Object

Reconfigures the meta data tied to this Reader

Available since: 1.1.0

Parameters

• meta : Object

Available since: 2.0.0

Parameters

• 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

• Ext.data.ResultSet

  The parsed ResultSet 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

• record : Ext.data.Model

  The record to load associations for

• data : Object

  The data object

Returns

• String

  Return value description

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

• Ext.data.ResultSet

  A ResultSet object

Available since: 2.0.0

Parameters

• args : Object
• fn : Object

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

• Ext.mixin.Observable

  this

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.

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.

Available since: 2.0.0

Parameters

• selector : Object
• name : Object
• fn : Object
• scope : Object
• order : Object

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'

Adds listeners to any Observable object (or Element) which are automatically removed when this Component is destroyed.

Available since: 1.1.0

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

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.

Available since: 2.0.0

Parameters

• bubbleEvents : String/String[]

Sets the value of clientIdProperty.

Available since: 2.0.0

Parameters

• clientIdProperty : String

Available since: 2.0.0

Parameters

• config : Object
• applyIfNotSet : Object

Returns

• Ext.Base

  this

Available since: 2.0.0

Parameters

• id : Object

Sets the value of idProperty.

Available since: 2.0.0

Parameters

• idProperty : String

Sets the value of implicitIncludes.

Available since: 2.0.0

Parameters

• implicitIncludes : Boolean

Sets the value of listeners.

Available since: 2.0.0

Parameters

• listeners : Object

Sets the value of messageProperty.

Available since: 2.0.0

Parameters

• messageProperty : String

Sets the value of model.

Available since: 1.1.0

Parameters

• model : Object

Sets the value of record.

Available since: 2.0.0

Parameters

• record : String

Sets the value of rootProperty.

Available since: 2.0.0

Parameters

• rootProperty : String

Sets the value of useSimpleAccessors.

Available since: 2.0.0

Parameters

• useSimpleAccessors : Boolean

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

• Ext.Class

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.

Alias for removeListener.

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'

Alias for removeAfterListener.

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.

Alias for removeBeforeListener.

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.

Available since: 2.0.0

Parameters

• model : Object

Available since: 2.0.0

Parameters

• members : Object

Available since: 2.0.0

Parameters

• name : Object
• member : Object

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

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

• members : Object

Returns

• Ext.Base

  this

Available since: 2.0.0

Parameters

• xtype : Object

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

• Ext.Base

  this

Available since: 2.0.0

Parameters

• args : Object

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

• Object

  the created instance.

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

• alias : String/Object

  The new method name, or an object to set multiple aliases. See flexSetter

• origin : String/Object

  The original method name

Available since: 2.0.0

Parameters

• parent : Object

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

• String

  className

Available since: 2.0.0

Used internally by the mixins pre-processor

Available since: 2.0.0

Parameters

• name : Object
• mixinClass : Object

Available since: 2.0.0

Parameters

• fn : Object
• scope : Object

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

Parameters

• members : Object

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

Returns

• Ext.Base

  this class

Available since: 2.0.0