Touch 2.0.2 Sencha Docs

Ext.app.Action

Hierarchy

Ext.Base
Ext.app.Action

Files

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

Represents a single action as dispatched by an Application. This is typically generated as a result of a url change being matched by a Route, triggering Application's dispatch function.

This is a private class and its functionality and existence may change in the future. Use at your own risk.

Available since: 2.0.0

Defined By

Config options

Ext.app.Action
view source
action : String

The name of the action on the controller that should be called

The name of the action on the controller that should be called

Available since: 2.0.0

The Application that this Action is bound to

The Application that this Action is bound to

Available since: 2.0.0

Ext.app.Action
view source
: Array
The set of arguments that will be passed to the controller's action ...

The set of arguments that will be passed to the controller's action

Defaults to: []

Available since: 2.0.0

The (optional) set of functions to call before the action is called. ...

The (optional) set of functions to call before the action is called. This is usually handled directly by the Controller or Application when an Ext.app.Action instance is created, but is alterable before resume is called.

Defaults to: []

Available since: 2.0.0

The controller whose action should be called

The controller whose action should be called

Available since: 2.0.0

Ext.app.Action
view source
currentFilterIndex : Objectprivate

Keeps track of which before filter is currently being executed by resume

Keeps track of which before filter is currently being executed by resume

Available since: 2.0.0

Ext.app.Action
view source
: Objectprivate
...

Defaults to: {}

Available since: 2.0.0

Ext.app.Action
view source
scope : Object

The scope in which the action should be called

The scope in which the action should be called

Available since: 2.0.0

Ext.app.Action
view source
title : Objectprivate

Available since: 2.0.0

Ext.app.Action
view source
url : String

The url that was decoded into the controller/action/args in this Action

The url that was decoded into the controller/action/args in this Action

Available since: 2.0.0

Properties

Defined By

Instance Properties

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

Defined By

Static Properties

...

Defaults to: []

Available since: 2.0.0

Methods

Defined By

Instance Methods

Ext.app.Action
view source
new( config ) : Ext.app.Action
...

Available since: 2.0.0

Parameters

Returns

Ext.app.Action
view source
( controller )private
If the controller config is a string, swap it for a reference to the actuall controller instance ...

If the controller config is a string, swap it for a reference to the actuall controller instance

Available since: 2.0.0

Parameters

  • controller : String

    The controller name

Ext.app.Action
view source
( url )private
...

Available since: 2.0.0

Parameters

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

Ext.app.Action
view source
( )
Starts execution of this Action by calling each of the beforeFilters in turn (if any are specified), before calling t...

Starts execution of this Action by calling each of the beforeFilters in turn (if any are specified), before calling the Controller action. Same as calling resume.

Available since: 2.0.0

Ext.app.Action
view source
( ) : String
Returns the value of action. ...

Returns the value of action.

Available since: 2.0.0

Returns

Returns the value of application. ...

Returns the value of application.

Available since: 2.0.0

Returns

Ext.app.Action
view source
( ) : Array
Returns the value of args. ...

Returns the value of args.

Available since: 2.0.0

Returns

Returns the value of beforeFilters. ...

Returns the value of beforeFilters.

Available since: 2.0.0

Returns

...

Available since: 2.0.0

Parameters

Returns the value of controller. ...

Returns the value of controller.

Available since: 2.0.0

Returns

...

Available since: 2.0.0

Ext.app.Action
view source
( ) : Objectprivate
Returns the value of currentFilterIndex. ...

Returns the value of currentFilterIndex.

Available since: 2.0.0

Returns

Ext.app.Action
view source
( ) : Object
Returns the value of data. ...

Returns the value of data.

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

Ext.app.Action
view source
( ) : Object
Returns the value of scope. ...

Returns the value of scope.

Available since: 2.0.0

Returns

Ext.app.Action
view source
( ) : Object
Returns the value of title. ...

Returns the value of title.

Available since: 2.0.0

Returns

Ext.app.Action
view source
( ) : String
Returns the value of url. ...

Returns the value of url.

Available since: 2.0.0

Returns

...

Available since: 2.0.0

Parameters

( 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

( names, callback, scope )private
...

Available since: 2.0.0

Parameters

Ext.app.Action
view source
( )
Resumes the execution of this Action (or starts it if it had not been started already). ...

Resumes the execution of this Action (or starts it if it had not been started already). This iterates over all of the configured beforeFilters and calls them. Each before filter is called with this Action as the sole argument, and is expected to call action.resume() in order to allow the next filter to be called, or if this is the final filter, the original Controller function.

Available since: 2.0.0

Ext.app.Action
view source
( action )
Sets the value of action. ...

Sets the value of action.

Available since: 2.0.0

Parameters

Ext.app.Action
view source
( application )
Sets the value of application. ...

Sets the value of application.

Available since: 2.0.0

Parameters

Ext.app.Action
view source
( args )
Sets the value of args. ...

Sets the value of args.

Available since: 2.0.0

Parameters

Ext.app.Action
view source
( beforeFilters )
Sets the value of beforeFilters. ...

Sets the value of beforeFilters.

Available since: 2.0.0

Parameters

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

Available since: 2.0.0

Parameters

Returns

Ext.app.Action
view source
( controller )
Sets the value of controller. ...

Sets the value of controller.

Available since: 2.0.0

Parameters

Ext.app.Action
view source
( currentFilterIndex )private
Sets the value of currentFilterIndex. ...

Sets the value of currentFilterIndex.

Available since: 2.0.0

Parameters

Ext.app.Action
view source
( data )
Sets the value of data. ...

Sets the value of data.

Available since: 2.0.0

Parameters

Ext.app.Action
view source
( scope )
Sets the value of scope. ...

Sets the value of scope.

Available since: 2.0.0

Parameters

Ext.app.Action
view source
( title )
Sets the value of title. ...

Sets the value of title.

Available since: 2.0.0

Parameters

Ext.app.Action
view source
( url )
Sets the value of url. ...

Sets the value of url.

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

Ext.app.Action
view source
( )private
...

Available since: 2.0.0

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

This method has been deprecated since 4.1.0

Please use Ext.define instead

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

...

Available since: 2.0.0