Ext JS 4.2.1 Sencha Docs

Ext.grid.plugin.RowExpander

Hierarchy

Ext.Base
Ext.AbstractPlugin
Ext.grid.plugin.RowExpander

Requires

Subclasses

Files

Plugin (ptype = 'rowexpander') that adds the ability to have a Column in a grid which enables a second row body which expands/contracts. The expand/contract behavior is configurable to react on clicking of the column, double click of the row, and/or hitting enter while a row is selected.

Available since: 4.2.0

Defined By

Config options

Ext.grid.plugin.RowExpander
view source
: Boolean
true to toggle a row between expanded/collapsed when double clicked (defaults to true). ...

true to toggle a row between expanded/collapsed when double clicked (defaults to true).

Defaults to: true

Available since: 4.2.0

Ext.grid.plugin.RowExpander
view source
: Boolean
true to toggle selected row(s) between expanded/collapsed when the enter key is pressed (defaults to true). ...

true to toggle selected row(s) between expanded/collapsed when the enter key is pressed (defaults to true).

Defaults to: true

Available since: 4.2.0

A name for the plugin that can be set at creation time to then retrieve the plugin through getPlugin method. ...

A name for the plugin that can be set at creation time to then retrieve the plugin through getPlugin method. For example:

var grid = Ext.create('Ext.grid.Panel', {
    plugins: [{
        ptype: 'cellediting',
        clicksToEdit: 2,
        pluginId: 'cellplugin'
    }]
});

// later on:
var plugin = grid.getPlugin('cellplugin');

Available since: 4.1.1

Ext.grid.plugin.RowExpander
view source
: Boolean
true to select a row when clicking on the expander icon (defaults to false). ...

true to select a row when clicking on the expander icon (defaults to false).

Defaults to: false

Available since: 4.2.0

Properties

Defined By

Instance properties

...

Defaults to: 'Ext.Base'

Available since: 4.1.1

Ext.grid.plugin.RowExpander
view source
: Objectprivate

Available since: 4.2.0

...

Defaults to: {}

Available since: 4.1.1

...

Defaults to: false

Available since: 4.0.0

...

Defaults to: []

Available since: 4.1.1

...

Defaults to: {}

Available since: 4.1.1

...

Defaults to: true

Available since: 4.1.1

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

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

Defaults to: true

Available since: 4.2.0

Ext.grid.plugin.RowExpander
view source
: Stringprivate
...

Defaults to: 'normal'

Available since: 4.2.0

Ext.grid.plugin.RowExpander
view source
: Stringprivate
...

Defaults to: 'x-grid-row-body-hidden'

Available since: 4.2.0

Ext.grid.plugin.RowExpander
view source
: Objectprivate

Available since: 4.2.0

Ext.grid.plugin.RowExpander
view source
: Stringprivate
...

Defaults to: '.x-grid-rowbody-tr'

Available since: 4.2.0

Ext.grid.plugin.RowExpander
view source
: Stringprivate
...

Defaults to: 'x-grid-row-collapsed'

Available since: 4.2.0

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

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

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

    constructor: function() {
        alert(this.self.speciesName); // 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

Instantiates the plugin. ...

Instantiates the plugin.

Available since: 4.0.0

Parameters

  • config : Object (optional)

    Configuration object.

Returns

Ext.grid.plugin.RowExpander
view source
( )private
Inject the expander column into the correct grid. ...

Inject the expander column into the correct grid.

If we are expanding the normal side of a lockable grid, poke the column into the locked side

Available since: 4.2.0

Fires

    Ext.grid.plugin.RowExpander
    view source
    ( grid, store, columns, oldStore, oldColumns )private
    ...

    Available since: 4.2.0

    Parameters

    Fires

      Ext.grid.plugin.RowExpander
      view source
      ( view )private
      ...

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

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

      Creates clone of the plugin. ...

      Creates clone of the plugin.

      Available since: 4.2.0

      Parameters

      • overrideCfg : Object (optional)

        Additional config for the derived plugin.

      ...

      Available since: 4.1.1

      The destroy method is invoked by the owning Component at the time the Component is being destroyed. ...

      The destroy method is invoked by the owning Component at the time the Component is being destroyed.

      The supplied implementation is empty. Subclasses should perform plugin cleanup in their own implementation of this method.

      Available since: 4.0.0

      Overrides: Ext.Base.destroy, Ext.AbstractPlugin.destroy

      The base implementation just sets the plugin's disabled flag to true Plugin subclasses which need more complex proce...

      The base implementation just sets the plugin's disabled flag to true

      Plugin subclasses which need more complex processing may implement an overriding implementation.

      Available since: 4.0.0

      Ext.grid.plugin.RowExpander
      view source
      ( )private
      ...

      Available since: 4.2.0

      The base implementation just sets the plugin's disabled flag to false Plugin subclasses which need more complex proc...

      The base implementation just sets the plugin's disabled flag to false

      Plugin subclasses which need more complex processing may implement an overriding implementation.

      Available since: 4.0.0

      Returns the component to which this plugin is attached. ...

      Returns the component to which this plugin is attached.

      Available since: 4.0.0

      Returns

      ...

      Available since: 4.1.0

      Parameters

      Ext.grid.plugin.RowExpander
      view source
      ( )private
      ...

      Available since: 4.2.0

      Fires

        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.grid.plugin.RowExpander
        view source
        ( record, idx, rowValues )private
        ...

        Available since: 4.2.0

        Parameters

        Fires

          ...

          Available since: 4.1.0

          Parameters

          Ext.grid.plugin.RowExpander
          view source
          ( grid )
          The init method is invoked after initComponent method has been run for the client Component. ...

          The init method is invoked after initComponent method has been run for the client Component.

          The supplied implementation is empty. Subclasses should perform plugin initialization, and set up bidirectional links between the plugin and its client Component in their own implementation of this method.

          Available since: 4.2.0

          Parameters

          Fires

            Overrides: Ext.AbstractPlugin.init

            ( 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

            ( cls, data, hooks )private
            Private. ...

            Private. Inject a ptype property so that AbstractComponent.findPlugin(ptype) works.

            Available since: Ext JS 4.2.1

            Parameters

            ( names, callback, scope )private
            ...

            Available since: 4.1.0

            Parameters

            Ext.grid.plugin.RowExpander
            view source
            ( view, record, row, rowIdx, e )private
            ...

            Available since: 4.2.0

            Parameters

            Fires

              Ext.grid.plugin.RowExpander
              view source
              ( view, record, row, rowIdx, e )private
              ...

              Available since: 4.2.0

              Parameters

              Fires

                Ext.grid.plugin.RowExpander
                view source
                ( )private
                refreshRowHeights often gets called in the middle of some complex processing. ...

                refreshRowHeights often gets called in the middle of some complex processing. For example, it's called on the store's datachanged event, but it must execute after* other objects interested in datachanged have done their job. Or it's called on column lock/unlock, but that could be just the start of a cross-container drag/drop of column headers which then moves the column into its final place. So this throws execution forwards until the idle event.

                Available since: 4.2.0

                Sets the component to which this plugin is attached. ...

                Sets the component to which this plugin is attached.

                Available since: 4.2.0

                Parameters

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

                Available since: 4.0.0

                Parameters

                Returns

                Ext.grid.plugin.RowExpander
                view source
                ( rows, rowValues )private
                ...

                Available since: Ext JS 4.2.1

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

                Returns

                Ext.grid.plugin.RowExpander
                view source
                ( rowIdx, record )private
                ...

                Available since: 4.2.0

                Parameters

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

                Defined By

                Events

                Ext.grid.plugin.RowExpander
                view source
                ( rowNode, record, expandRow, eOpts )
                Fired through the grid's View. ...

                Fired through the grid's View.

                Available since: 4.2.0

                Parameters

                • rowNode : HTMLElement

                  The <tr> element which owns the expanded row.

                • record : Ext.data.Model

                  The record providing the data.

                • expandRow : HTMLElement

                  The <tr> element containing the expanded data.

                • eOpts : Object

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

                Ext.grid.plugin.RowExpander
                view source
                ( rowNode, record, expandRow, eOpts )
                Fired through the grid's View ...

                Fired through the grid's View

                Available since: 4.2.0

                Parameters

                • rowNode : HTMLElement

                  The <tr> element which owns the expanded row.

                • record : Ext.data.Model

                  The record providing the data.

                • expandRow : HTMLElement

                  The <tr> element containing the expanded data.

                • eOpts : Object

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

                Defined By

                CSS Variables

                Ext.grid.plugin.RowExpander
                view source
                : number
                The horizontal space after the RowExpander icon ...

                The horizontal space after the RowExpander icon

                Defaults to: 6px

                Available since: Ext JS 4.2.1

                Ext.grid.plugin.RowExpander
                view source
                : number
                The horizontal space before the RowExpander icon ...

                The horizontal space before the RowExpander icon

                Defaults to: 6px

                Available since: Ext JS 4.2.1

                Ext.grid.plugin.RowExpander
                view source
                : string
                The cursor for the RowExpander icon ...

                The cursor for the RowExpander icon

                Defaults to: pointer

                Available since: Ext JS 4.2.1

                Ext.grid.plugin.RowExpander
                view source
                : number
                The height of the RowExpander icon ...

                The height of the RowExpander icon

                Defaults to: 11px

                Available since: Ext JS 4.2.1

                Ext.grid.plugin.RowExpander
                view source
                : number
                The width of the RowExpander icon ...

                The width of the RowExpander icon

                Defaults to: 11px

                Available since: Ext JS 4.2.1