Ext.ComponentLoader

True to have the loader make a request as soon as it is created. This argument can also be a set of options that will be passed to load is called.

Defaults to: false

Available since: 4.0.0

Params that will be attached to every request. These parameters will not be overridden by any params in the load options.

Available since: 4.0.0

A function to be called when a load request finishes. Will be called with the following config parameters:

• this - The ElementLoader instance.
• success - True if successful request.
• response - The response object.
• options - Ajax options.

Available since: 4.0.4

A function to be called when a load request fails. Will be called with the following config parameters:

• this - The ElementLoader instance.
• response - The response object.
• options - Ajax options.

Available since: 4.0.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.

DOM events from Ext JS Components

While some Ext JS Component classes export selected DOM events (e.g. "click", "mouseover" etc), this is usually only done when extra value can be added. For example the DataView's itemclick event passing the node clicked on. To access DOM events directly from a child element of a Component, we need to specify the element option to identify the Component property to add a DOM listener to:

new Ext.panel.Panel({
    width: 400,
    height: 200,
    dockedItems: [{
        xtype: 'toolbar'
    }],
    listeners: {
        click: {
            element: 'el', //bind to the underlying el property on the panel
            fn: function(){ console.log('click el'); }
        },
        dblclick: {
            element: 'body', //bind to the underlying body property on the panel
            fn: function(){ console.log('dblclick body'); }
        }
    }
});

Available since: 1.1.0

Any params to be attached to the Ajax request. These parameters will be overridden by any params in the load options.

Available since: 4.0.0

The scope to execute the success and failure functions in.

Available since: 4.0.0

A function to be called when a load request is successful. Will be called with the following config parameters:

• this - The ElementLoader instance.
• response - The response object.
• options - Ajax options.

Available since: 4.0.0

The url to retrieve the content from.

Available since: 4.0.0

Defaults to: /^(?:scope|delay|buffer|single|stopEvent|preventDefault|stopPropagation|normalized|args|delegate|element|vertical|horizontal|freezeEvent)$/

Available since: 4.0.0

Defaults to: true

Available since: 4.0.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); / dependent on 'this'

        return 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: 4.0.0

Aborts the active load request

Available since: 4.0.0

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

Available since: 1.1.0

Parameters

• o : Object/String

  Either an object with event names as properties with a value of true or the first event name string if multiple event names are being passed as separate parameters. Usage:

  this.addEvents({
      storeloaded: true,
      storecleared: true
  });
  

• more : String... (optional)

  Additional event names if multiple event names are being passed as separate parameters. Usage:

  this.addEvents('storeloaded', 'storecleared');
  

Available since: 4.0.6

Parameters

• members : Object

Returns

• Ext.Base

  this

Appends an event handler to this object.

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.

  Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.

  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.

  • buffer : Number

    Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.

  • target : Observable

    Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.

  • element : String

    This option is only valid for listeners bound to Components. The name of a Component property which references an element to add a listener to.

    This option is useful during Component construction to add DOM event listeners to elements of Components which will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:

    new Ext.panel.Panel({
        title: 'The title',
        listeners: {
            click: this.handlePanelClick,
            element: 'body'
        }
    });
    

  Combining Options

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

  A delayed, one-time listener.

  myPanel.on('hide', this.handleClick, this, {
      single: true,
      delay: 100
  });
  

  Attaching multiple handlers in 1 call

  The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:

  myGridPanel.on({
      cellClick: this.onCellClick,
      mouseover: this.onMouseOver,
      mouseout: this.onMouseOut,
      scope: this // Important. Ensure "this" is correct during handler execution
  });
  

  One can also specify options for each event handler separately:

  myGridPanel.on({
      cellClick: {fn: this.onCellClick, scope: this, single: true},
      mouseover: {fn: panel.onMouseOver, scope: panel}
  });
  

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

Available since: 4.0.0

Parameters

• item : Ext.util.Observable/Ext.Element

  The item to which to add a listener/listeners.

• ename : Object/String

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

• fn : Function (optional)

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

• scope : Object (optional)

  If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

• opt : Object (optional)

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

Call the original method that was previously overridden with override

Ext.define('My.Cat', {
    constructor: function() {
        alert("I'm a cat!");

        return this;
    }
});

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

Parameters

• args : Array/Arguments

  The arguments, either an array or the arguments object

Returns

• Object

  Returns the result after calling the overridden method

Call the parent's overridden method. For example:

Ext.define('My.own.A', {
    constructor: function(test) {
        alert(test);
    }
});

Ext.define('My.own.B', {
    extend: 'My.own.A',

    constructor: function(test) {
        alert(test);

        this.callParent([test + 1]);
    }
});

Ext.define('My.own.C', {
    extend: 'My.own.B',

    constructor: function() {
        alert("Going to call parent's overriden constructor...");

        this.callParent(arguments);
    }
});

var a = new My.own.A(1); // alerts '1'
var b = new My.own.B(1); // alerts '1', then alerts '2'
var c = new My.own.C(2); // alerts "Going to call parent's overriden constructor..."
                         // alerts '2', then alerts '3'

Available since: 4.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 from the superclass' method

Removes all listeners for this object including the managed listeners

Available since: 4.0.0

Removes all managed listeners for this object.

Available since: 4.0.0

Continue to fire event.

Available since: Ext JS 4.0.7

Parameters

• eventName : String
• args : Array
• bubbles : Boolean

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

Available since: 4.0.0

Parameters

• newName : Object

Returns

• Function

Destroys the loader. Any active requests will be aborted.

Available since: 4.0.0

Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present. There is no implementation in the Observable base class.

This is commonly used by Ext.Components to bubble events to owner Containers. See Ext.Component.getBubbleTarget. The default implementation in Ext.Component returns the Component's immediate owner. But if a known target is required, this can be overridden to access the required target more quickly.

Example:

Ext.override(Ext.form.field.Base, {
    //  Add functionality to Field's initComponent to enable the change event to bubble
    initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
        this.enableBubble('change');
    }),

    //  We know that we want Field's events to bubble directly to the FormPanel.
    getBubbleTarget : function() {
        if (!this.formPanel) {
            this.formPanel = this.findParentByType('form');
        }
        return this.formPanel;
    }
});

var myForm = new Ext.formPanel({
    title: 'User Details',
    items: [{
        ...
    }],
    listeners: {
        change: function() {
            // Title goes red if form has been modified.
            myForm.header.setStyle('color', 'red');
        }
    }
});

Available since: 3.4.0

Parameters

• events : String/String[]

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

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

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) 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.

Gets the bubbling parent for an Observable

Available since: Ext JS 4.0.7

Returns

• Ext.util.Observable

  The bubble parent. null is returned if no bubble target exists

Returns the target of this loader.

Available since: 4.0.0

Returns

• Ext.Component

  The target or null if none exists.

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

        return this;
    }
});

var awesome = new My.awesome.Class({
    name: 'Super Awesome'
});

alert(awesome.getName()); // 'Super Awesome'

Available since: 4.0.0

Parameters

• config : Object

Returns

• Object

  mixins The mixin prototypes as key - value pairs

Checks whether the loader is automatically refreshing. See startAutoRefresh.

Available since: 4.0.0

Returns

• Boolean

  True if the loader is automatically refreshing

Loads new data from the server.

Available since: 4.0.0

Parameters

• options : Object

  The options for the request. They can be any configuration option that can be specified for the class, with the exception of the target option. Note that any options passed to the method will override any class defaults.

Used internally by the mixins pre-processor

Available since: 4.0.6

Parameters

• name : Object
• cls : Object

Shorthand for addManagedListener.

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

Available since: 4.0.2

Parameters

• item : Ext.util.Observable/Ext.Element

  The item to which to add a listener/listeners.

• ename : Object/String

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

• fn : Function (optional)

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

• scope : Object (optional)

  If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

• opt : Object (optional)

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

Shorthand for removeManagedListener.

Removes listeners that were added by the mon method.

Available since: 4.0.2

Parameters

• item : Ext.util.Observable/Ext.Element

  The item from which to remove a listener/listeners.

• ename : Object/String

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

• fn : Function (optional)

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

• scope : Object (optional)

  If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

Shorthand for addListener.

Appends an event handler to this object.

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.

  Note: Unlike in ExtJS 3.x, the options object will also be passed as the last argument to every event handler.

  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.

  • buffer : Number

    Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.

  • target : Observable

    Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.

  • element : String

    This option is only valid for listeners bound to Components. The name of a Component property which references an element to add a listener to.

    This option is useful during Component construction to add DOM event listeners to elements of Components which will exist only after the Component is rendered. For example, to add a click listener to a Panel's body:

    new Ext.panel.Panel({
        title: 'The title',
        listeners: {
            click: this.handlePanelClick,
            element: 'body'
        }
    });
    

  Combining Options

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

  A delayed, one-time listener.

  myPanel.on('hide', this.handleClick, this, {
      single: true,
      delay: 100
  });
  

  Attaching multiple handlers in 1 call

  The method also allows for a single argument to be passed which is a config object containing properties which specify multiple events. For example:

  myGridPanel.on({
      cellClick: this.onCellClick,
      mouseover: this.onMouseOver,
      mouseout: this.onMouseOut,
      scope: this // Important. Ensure "this" is correct during handler execution
  });
  

  One can also specify options for each event handler separately:

  myGridPanel.on({
      cellClick: {fn: this.onCellClick, scope: this, single: true},
      mouseover: {fn: panel.onMouseOver, scope: panel}
  });
  

Parses the response after the request completes

Available since: 4.0.0

Parameters

• options : Object

  Ajax options

• success : Boolean

  Success status of the request

• response : Object

  The response object

Available since: 4.0.6

Parameters

• name : Object
• value : Object

Available since: 4.0.0

Parameters

• name : Object
• fn : Object

Available since: 1.1.0

Available since: 4.0.0

Relays selected events from the specified Observable as if the events were fired by this.

Available since: 2.3.0

Parameters

• origin : Object

  The Observable whose events this object is to relay.

• events : String[]

  Array of event names to relay.

• prefix : String

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.

Removes listeners that were added by the mon method.

Available since: 4.0.0

Parameters

• item : Ext.util.Observable/Ext.Element

  The item from which to remove a listener/listeners.

• ename : Object/String

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

• fn : Function (optional)

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

• scope : Object (optional)

  If the ename parameter was an event name, this is the scope (this reference) in which the handler function is executed.

Remove a single managed listener item

Available since: 4.0.1

Parameters

• isClear : Boolean

  True if this is being called during a clear

• managedListener : Object

  The managed listener item See removeManagedListener for other args

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

Available since: 4.0.0

Parameters

• config : Object

Returns

• Ext.Base

  this

Automatically refreshes the content over a specified period.

Available since: 4.0.0

Parameters

• interval : Number

  The interval to refresh in ms.

• options : Object (optional)

  The options to pass to the load method. See load

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

        return this;
    },

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

Returns

• Ext.Class

Clears any auto refresh. See startAutoRefresh.

Available since: 4.0.0

Suspends the firing of all events. (see resumeEvents)

Available since: 2.3.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.

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

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

Parameters

• fromClass : Ext.Base

  The class to borrow members from

• members : String/String[]

  The names of the members to borrow

Returns

• Ext.Base

  this

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

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

Parameters

• alias : String/Object

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

• origin : String/Object

  The original method name

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

Returns

• String

  className

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

Parameters

• members : Object

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

Ext.define('My.Cat', {
    constructor: function() {
        alert("I'm a cat!");

        return this;
    }
});

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

Parameters

• members : Object

Returns

• Ext.Base

  this

Fires after an unsuccessful load.

Available since: 4.0.0

Parameters

• this : Ext.ElementLoader
• response : Object

  The response from the server

• options : Object

  The options passed to the request

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.

Fires after a successful load.

Available since: 4.0.4

Parameters

• this : Ext.ElementLoader
• response : Object

  The response from the server

• options : Object

  The options passed to the request

• eOpts : Object

  The options object passed to Ext.util.Observable.addListener.