Ext JS 4.1.3 Sencha Docs

Ext.Action

Hierarchy

Ext.Base
Ext.Action

Files

An Action is a piece of reusable functionality that can be abstracted out of any particular component so that it can be usefully shared among multiple components. Actions let you share handlers, configuration options and UI updates across any components that support the Action interface (primarily Ext.toolbar.Toolbar, Ext.button.Button and Ext.menu.Menu components).

Use a single Action instance as the config object for any number of UI Components which share the same configuration. The Action not only supplies the configuration, but allows all Components based upon it to have a common set of methods called at once through a single call to the Action.

Any Component that is to be configured with an Action must also support the following methods:

  • setText(string)
  • setIconCls(string)
  • setDisabled(boolean)
  • setVisible(boolean)
  • setHandler(function)

This allows the Action to control its associated Components.

Example usage:

// Define the shared Action.  Each Component below will have the same
// display text and icon, and will display the same message on click.
var action = new Ext.Action({
    text: 'Do something',
    handler: function(){
        Ext.Msg.alert('Click', 'You did something.');
    },
    iconCls: 'do-something',
    itemId: 'myAction'
});

var panel = new Ext.panel.Panel({
    title: 'Actions',
    width: 500,
    height: 300,
    tbar: [
        // Add the Action directly to a toolbar as a menu button
        action,
        {
            text: 'Action Menu',
            // Add the Action to a menu as a text item
            menu: [action]
        }
    ],
    items: [
        // Add the Action to the panel body as a standard button
        new Ext.button.Button(action)
    ],
    renderTo: Ext.getBody()
});

// Change the text for all components using the Action
action.setText('Something else');

// Reference an Action through a container using the itemId
var btn = panel.getComponent('myAction');
var aRef = btn.baseAction;
aRef.setText('New text');

Available since: 2.3.0

Defined By

Config options

True to disable all components configured by this Action, false to enable them. ...

True to disable all components configured by this Action, false to enable them.

Defaults to: false

Available since: 2.3.0

The function that will be invoked by each component tied to this Action when the component's primary event is triggered.

The function that will be invoked by each component tied to this Action when the component's primary event is triggered.

Available since: 2.3.0

True to hide all components configured by this Action, false to show them. ...

True to hide all components configured by this Action, false to show them.

Defaults to: false

Available since: 2.3.0

The CSS class selector that specifies a background image to be used as the header icon for all components configured ...

The CSS class selector that specifies a background image to be used as the header icon for all components configured by this Action.

An example of specifying a custom icon class would be something like:

// specify the property in the config for the class:
     ...
     iconCls: 'do-something'

// css class that specifies background image to be used as the icon image:
.do-something { background-image: url(../images/my-icon.gif) 0 6px no-repeat !important; }

Defaults to: ''

Available since: 2.3.0

See Ext.Component.itemId.

Available since: 3.4.0

The scope (this reference) in which the handler is executed. ...

The scope (this reference) in which the handler is executed. Defaults to the browser window.

Available since: 2.3.0

The text to set for all components configured by this Action. ...

The text to set for all components configured by this Action.

Defaults to: ''

Available since: 2.3.0

Properties

Defined By

Instance properties

...

Defaults to: 'Ext.Base'

Available since: 4.1.1

...

Defaults to: {}

Available since: 4.1.1

...

Defaults to: []

Available since: 4.1.1

...

Defaults to: {}

Available since: 4.1.1

Ext.Action
view source
: Booleanprivate
true in this class to identify an object as an instantiated Action, or subclass thereof. ...

true in this class to identify an object as an instantiated Action, or subclass thereof.

Defaults to: true

Available since: 3.4.0

...

Defaults to: true

Available since: 4.1.1

Get the reference to the current class from which this object was instantiated. ...

Get the reference to the current class from which this object was instantiated. Unlike statics, this.self is scope-dependent and it's meant to be used for dynamic inheritance. See statics for a detailed comparison

Ext.define('My.Cat', {
    statics: {
        speciesName: 'Cat' // My.Cat.speciesName = 'Cat'
    },

    constructor: function() {
        alert(this.self.speciesName); // dependent on 'this'
    },

    clone: function() {
        return new this.self();
    }
});


Ext.define('My.SnowLeopard', {
    extend: 'My.Cat',
    statics: {
        speciesName: 'Snow Leopard'         // My.SnowLeopard.speciesName = 'Snow Leopard'
    }
});

var cat = new My.Cat();                     // alerts 'Cat'
var snowLeopard = new My.SnowLeopard();     // alerts 'Snow Leopard'

var clone = snowLeopard.clone();
alert(Ext.getClassName(clone));             // alerts 'My.SnowLeopard'

Available since: 4.0.0

Defined By

Static properties

...

Defaults to: []

Available since: 4.1.1

Methods

Defined By

Instance methods

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

Creates new Action.

Available since: 2.3.0

Parameters

  • config : Object

    Config object.

Returns

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

Available since: 3.4.0

Parameters

Ext.Action
view source
( fnName, args )private
...

Available since: 3.4.0

Parameters

( args ) : Objectdeprecatedprotected
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!");

        this.callOverridden();

        alert("Meeeeoooowwww");
    }
});

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

This method has been deprecated

as of 4.1. Use callParent instead.

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object from the current method, for example: this.callOverridden(arguments)

Returns

  • Object

    Returns the result of calling the overridden method

Call the "parent" method of the current method. ...

Call the "parent" method of the current method. That is the method previously overridden by derivation or by an override (see Ext.define).

 Ext.define('My.Base', {
     constructor: function (x) {
         this.x = x;
     },

     statics: {
         method: function (x) {
             return x;
         }
     }
 });

 Ext.define('My.Derived', {
     extend: 'My.Base',

     constructor: function () {
         this.callParent([21]);
     }
 });

 var obj = new My.Derived();

 alert(obj.x);  // alerts 21

This can be used with an override as follows:

 Ext.define('My.DerivedOverride', {
     override: 'My.Derived',

     constructor: function (x) {
         this.callParent([x*2]); // calls original My.Derived constructor
     }
 });

 var obj = new My.Derived();

 alert(obj.x);  // now alerts 42

This also works with static methods.

 Ext.define('My.Derived2', {
     extend: 'My.Base',

     statics: {
         method: function (x) {
             return this.callParent([x*2]); // calls My.Base.method
         }
     }
 });

 alert(My.Base.method(10);     // alerts 10
 alert(My.Derived2.method(10); // alerts 20

Lastly, it also works with overridden static methods.

 Ext.define('My.Derived2Override', {
     override: 'My.Derived2',

     statics: {
         method: function (x) {
             return this.callParent([x*2]); // calls My.Derived2.method
         }
     }
 });

 alert(My.Derived2.method(10); // now alerts 40

To override a method and replace it and also call the superclass method, use callSuper. This is often done to patch a method to fix a bug.

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 of calling the parent method

( args ) : Objectprotected
This method is used by an override to call the superclass method but bypass any overridden method. ...

This method is used by an override to call the superclass method but bypass any overridden method. This is often done to "patch" a method that contains a bug but for whatever reason cannot be fixed directly.

Consider:

 Ext.define('Ext.some.Class', {
     method: function () {
         console.log('Good');
     }
 });

 Ext.define('Ext.some.DerivedClass', {
     method: function () {
         console.log('Bad');

         // ... logic but with a bug ...

         this.callParent();
     }
 });

To patch the bug in DerivedClass.method, the typical solution is to create an override:

 Ext.define('App.paches.DerivedClass', {
     override: 'Ext.some.DerivedClass',

     method: function () {
         console.log('Fixed');

         // ... logic but with bug fixed ...

         this.callSuper();
     }
 });

The patch method cannot use callParent to call the superclass method since that would call the overridden method containing the bug. In other words, the above patch would only produce "Fixed" then "Good" in the console log, whereas, using callParent would produce "Fixed" then "Bad" then "Good".

Available since: Ext JS 4.1.3

Parameters

  • args : Array/Arguments

    The arguments, either an array or the arguments object from the current method, for example: this.callSuper(arguments)

Returns

  • Object

    Returns the result of calling the superclass method

...

Available since: 4.1.1

Ext.Action
view source
( )
Disables all components configured by this Action. ...

Disables all components configured by this Action.

Available since: 2.3.0

Fires

    Ext.Action
    view source
    ( fn, scope )
    Executes the specified function once for each Component currently tied to this Action. ...

    Executes the specified function once for each Component currently tied to this Action. The function passed in should accept a single argument that will be an object that supports the basic Action config/method interface.

    Available since: 2.3.0

    Parameters

    • fn : Function

      The function to execute for each component

    • scope : Object

      The scope (this reference) in which the function is executed. Defaults to the Component.

    Ext.Action
    view source
    ( )
    Enables all components configured by this Action. ...

    Enables all components configured by this Action.

    Available since: 2.3.0

    Fires

      Ext.Action
      view source
      ( args )
      Executes this Action manually using the handler function specified in the original config object or the handler funct...

      Executes this Action manually using the handler function specified in the original config object or the handler function set with setHandler. Any arguments passed to this function will be passed on to the handler function.

      Available since: 2.3.0

      Parameters

      • args : Object...

        Variable number of arguments passed to the handler function

      ...

      Available since: 4.1.0

      Parameters

      Gets the icon CSS class currently used by all components configured by this Action. ...

      Gets the icon CSS class currently used by all components configured by this Action.

      Available since: 4.0.0

      Returns the initial configuration passed to constructor when instantiating this class. ...

      Returns the initial configuration passed to constructor when instantiating this class.

      Available since: 4.1.0

      Parameters

      • name : String (optional)

        Name of the config option to return.

      Returns

      • Object/Mixed

        The full config object or a single config value when name parameter specified.

      Ext.Action
      view source
      ( )
      Gets the text currently displayed by all components configured by this Action. ...

      Gets the text currently displayed by all components configured by this Action.

      Available since: 2.3.0

      ...

      Available since: 4.1.0

      Parameters

      Ext.Action
      view source
      ( )
      Hides all components configured by this Action. ...

      Hides all components configured by this Action.

      Available since: 2.3.0

      Fires

        ( config ) : Ext.Basechainableprotected
        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: 4.0.0

        Parameters

        Returns

        Returns true if the components using this Action are currently disabled, else returns false. ...

        Returns true if the components using this Action are currently disabled, else returns false.

        Available since: 2.3.0

        Ext.Action
        view source
        ( )
        Returns true if the components configured by this Action are currently hidden, else returns false. ...

        Returns true if the components configured by this Action are currently hidden, else returns false.

        Available since: 2.3.0

        ( names, callback, scope )private
        ...

        Available since: 4.1.0

        Parameters

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

        Available since: 3.4.0

        Parameters

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

        Available since: 4.0.0

        Parameters

        Returns

        Ext.Action
        view source
        ( disabled )
        Sets the disabled state of all components configured by this Action. ...

        Sets the disabled state of all components configured by this Action. Shortcut method for enable and disable.

        Available since: 2.3.0

        Parameters

        • disabled : Boolean

          True to disable the component, false to enable it

        Fires

          Ext.Action
          view source
          ( fn, scope )
          Sets the function that will be called by each Component using this action when its primary event is triggered. ...

          Sets the function that will be called by each Component using this action when its primary event is triggered.

          Available since: 2.3.0

          Parameters

          • fn : Function

            The function that will be invoked by the action's components. The function will be called with no arguments.

          • scope : Object

            The scope (this reference) in which the function is executed. Defaults to the Component firing the event.

          Fires

            Ext.Action
            view source
            ( hidden )
            Sets the hidden state of all components configured by this Action. ...

            Sets the hidden state of all components configured by this Action. Shortcut method for hide and show.

            Available since: 2.3.0

            Parameters

            • hidden : Boolean

              True to hide the component, false to show it.

            Fires

              Ext.Action
              view source
              ( cls )
              Sets the icon CSS class for all components configured by this Action. ...

              Sets the icon CSS class for all components configured by this Action. The class should supply a background image that will be used as the icon image.

              Available since: 4.0.0

              Parameters

              • cls : String

                The CSS class supplying the icon image

              Fires

                Ext.Action
                view source
                ( text )
                Sets the text to be displayed by all components configured by this Action. ...

                Sets the text to be displayed by all components configured by this Action.

                Available since: 2.3.0

                Parameters

                • text : String

                  The text to display

                Fires

                  Ext.Action
                  view source
                  ( )
                  Shows all components configured by this Action. ...

                  Shows all components configured by this Action.

                  Available since: 2.3.0

                  Fires

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

                    Returns

                    Defined By

                    Static methods

                    ( config )privatestatic
                    ...

                    Available since: 4.1.1

                    Parameters

                    ( members )chainableprivatestatic
                    ...

                    Available since: 4.1.1

                    Parameters

                    ( name, member )chainableprivatestatic
                    ...

                    Available since: 4.1.1

                    Parameters

                    ( members )chainablestatic
                    Add methods / properties to the prototype of this class. ...

                    Add methods / properties to the prototype of this class.

                    Ext.define('My.awesome.Cat', {
                        constructor: function() {
                            ...
                        }
                    });
                    
                     My.awesome.Cat.addMembers({
                         meow: function() {
                            alert('Meowww...');
                         }
                     });
                    
                     var kitty = new My.awesome.Cat;
                     kitty.meow();
                    

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

                    Parameters

                    Returns

                    ( xtype )chainableprivatestatic
                    ...

                    Available since: 4.1.1

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

                    Parameters

                    • fromClass : Ext.Base

                      The class to borrow members from

                    • members : Array/String

                      The names of the members to borrow

                    Returns

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

                    Returns

                    Overrides: Ext.layout.Layout.create

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

                    Parameters

                    ( config )privatestatic
                    ...

                    Available since: 4.1.1

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

                    Returns

                    ( )deprecatedstatic
                    Adds members to class. ...

                    Adds members to class.

                    Available since: 4.0.2

                    This method has been deprecated since 4.1

                    Use addMembers instead.

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

                    Used internally by the mixins pre-processor

                    Available since: 4.1.1

                    Parameters

                    ( fn, scope )chainableprivatestatic
                    ...

                    Available since: 4.1.1

                    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!");
                    
                            this.callParent(arguments);
                    
                            alert("Meeeeoooowwww");
                        }
                    });
                    
                    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!");
                    
                            this.callParent(arguments);
                    
                            alert("Meeeeoooowwww");
                        }
                    });
                    

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

                    This method has been deprecated since 4.1.0

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