Ext JS 4.1.3 Sencha Docs

Ext.grid.feature.GroupingSummary

Hierarchy

Mixins

Files

This feature adds an aggregate summary row at the bottom of each group that is provided by the Ext.grid.feature.Grouping feature. There are two aspects to the summary:

Calculation

The summary value needs to be calculated for each column in the grid. This is controlled by the summaryType option specified on the column. There are several built in summary types, which can be specified as a string on the column configuration. These call underlying methods on the store:

Alternatively, the summaryType can be a function definition. If this is the case, the function is called with an array of records to calculate the summary value.

Rendering

Similar to a column, the summary also supports a summaryRenderer function. This summaryRenderer is called before displaying a value. The function is optional, if not specified the default calculated value is shown. The summaryRenderer is called with:

  • value {Object} - The calculated value.
  • summaryData {Object} - Contains all raw summary values for the row.
  • field {String} - The name of the field we are calculating

Example Usage

Ext.define('TestResult', {
    extend: 'Ext.data.Model',
    fields: ['student', 'subject', {
        name: 'mark',
        type: 'int'
    }]
});

Ext.create('Ext.grid.Panel', {
    width: 200,
    height: 240,
    renderTo: document.body,
    features: [{
        groupHeaderTpl: 'Subject: {name}',
        ftype: 'groupingsummary'
    }],
    store: {
        model: 'TestResult',
        groupField: 'subject',
        data: [{
            student: 'Student 1',
            subject: 'Math',
            mark: 84
        },{
            student: 'Student 1',
            subject: 'Science',
            mark: 72
        },{
            student: 'Student 2',
            subject: 'Math',
            mark: 96
        },{
            student: 'Student 2',
            subject: 'Science',
            mark: 68
        }]
    },
    columns: [{
        dataIndex: 'student',
        text: 'Name',
        summaryType: 'count',
        summaryRenderer: function(value){
            return Ext.String.format('{0} student{1}', value, value !== 1 ? 's' : '');
        }
    }, {
        dataIndex: 'mark',
        text: 'Mark',
        summaryType: 'average'
    }]
});

Available since: 4.0.0

Defined By

Config options

Set to falsee to disable collapsing groups from the UI. ...

Set to falsee to disable collapsing groups from the UI.

This is set to false when the associated store is buffered.

Defaults to: true

Available since: 4.1.1

Number of pixels to indent per grouping level ...

Number of pixels to indent per grouping level

Defaults to: 17

Available since: 4.0.0

True to enable the grouping control in the header menu. ...

True to enable the grouping control in the header menu.

Defaults to: true

Available since: 4.0.0

True to allow the user to turn off grouping. ...

True to allow the user to turn off grouping.

Defaults to: true

Available since: 4.0.0

Text displayed in the grid header menu for grouping by header. ...

Text displayed in the grid header menu for grouping by header.

Defaults to: "Group by this field"

Available since: 4.0.0

A string Template snippet, an array of strings (optionally followed by an object containing Template methods) to be u...

A string Template snippet, an array of strings (optionally followed by an object containing Template methods) to be used to construct a Template, or a Template instance.

  • Example 1 (Template snippet):

    groupHeaderTpl: 'Group: {name}'
    
  • Example 2 (Array):

    groupHeaderTpl: [
        'Group: ',
        '<div>{name:this.formatName}</div>',
        {
            formatName: function(name) {
                return Ext.String.trim(name);
            }
        }
    ]
    
  • Example 3 (Template Instance):

    groupHeaderTpl: Ext.create('Ext.XTemplate',
        'Group: ',
        '<div>{name:this.formatName}</div>',
        {
            formatName: function(name) {
                return Ext.String.trim(name);
            }
        }
    )
    

Defaults to: '{columnName}: {name}'

Available since: 4.0.0

  • groupField : String

    The field name being grouped by.

  • columnName : String

    The column header associated with the field being grouped by if there is a column for the field, falls back to the groupField name.

  • groupValue : Mixed

    The value of the groupField for the group header being rendered.

  • renderedGroupValue : String

    The rendered value of the groupField for the group header being rendered, as produced by the column renderer.

  • name : String

    An alias for renderedGroupValue

  • rows : Object[]

    An array of child row data objects as returned by the View's prepareData method.

  • children : Ext.data.Model[]

    An array containing the child records for the group being rendered.

True to hide the header that is currently grouped. ...

True to hide the header that is currently grouped.

Defaults to: false

Available since: 4.0.0

A config object containing one or more event handlers to be added to this object during initialization. ...

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

Ext.grid.feature.GroupingSummary
view source
: String
The name of the property which contains the Array of summary objects. ...

The name of the property which contains the Array of summary objects. It allows to use server-side calculated summaries.

Available since: 4.0.0

Text displayed in the grid header for enabling/disabling grouping. ...

Text displayed in the grid header for enabling/disabling grouping.

Defaults to: "Show in groups"

Available since: 4.0.0

True to show the summary row. ...

True to show the summary row.

Defaults to: true

Available since: 4.0.2

True to start all groups collapsed. ...

True to start all groups collapsed.

Defaults to: false

Available since: 4.0.0

Properties

Defined By

Instance properties

...

Defaults to: 'Ext.Base'

Available since: 4.1.1

...

Defaults to: '.' + Ext.baseCSSPrefix + 'grid-group-body'

Available since: 4.1.0

...

Defaults to: Ext.baseCSSPrefix + 'grid-group-collapsed'

Available since: 4.0.0

Most features will not modify the data returned to the view. ...

Most features will not modify the data returned to the view. This is limited to one feature that manipulates the data per grid view.

Defaults to: false

Available since: 4.0.0

...

Defaults to: {}

Available since: 4.1.1

True when feature is disabled. ...

True when feature is disabled.

Defaults to: false

Available since: 4.0.0

Prefix to use when firing events on the view. ...

Prefix to use when firing events on the view. For example a prefix of group would expose "groupclick", "groupcontextmenu", "groupdblclick".

Available since: 4.0.0

Overrides: Ext.grid.feature.Grouping.eventPrefix

Selector used to determine when to fire the event with the eventPrefix.

Selector used to determine when to fire the event with the eventPrefix.

Available since: 4.0.0

Overrides: Ext.grid.feature.Grouping.eventSelector

Initial suspended call count. ...

Initial suspended call count. Incremented when suspendEvents is called, decremented when resumeEvents is called.

Defaults to: 0

Available since: 4.1.1

Reference to the grid panel

Reference to the grid panel

Available since: 4.0.0

Most features will expose additional events, some may not and will need to change this to false. ...

Most features will expose additional events, some may not and will need to change this to false.

Defaults to: true

Available since: 4.0.0

This object holds a key for any event that has a listener. ...

This object holds a key for any event that has a listener. The listener may be set directly on the instance, or on its class or a super class (via observe) or on the MVC EventBus. The values of this object are truthy (a non-zero number) and falsy (0 or undefined). They do not represent an exact count of listeners. The value for an event is truthy if the event must be fired and is falsy if there is no need to fire the event.

The intended use of this property is to avoid the expense of fireEvent calls when there are no listeners. This can be particularly helpful when one would otherwise have to call fireEvent hundreds or thousands of times. It is used like this:

 if (this.hasListeners.foo) {
     this.fireEvent('foo', this, arg1);
 }

Available since: 4.1.0

...

Defaults to: Ext.baseCSSPrefix + 'grid-group-hd-collapsed'

Available since: 4.0.0

...

Defaults to: Ext.baseCSSPrefix + 'grid-group-hd-collapsible'

Available since: 4.1.1

...

Defaults to: []

Available since: 4.1.1

...

Defaults to: {}

Available since: 4.1.1

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

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

Defaults to: true

Available since: 4.0.0

...

Defaults to: true

Available since: 4.1.1

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

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

Defaults to: true

Available since: 4.0.0

...

Defaults to: /\{\{id\}([\w\-]*)\}/g

Available since: 4.0.2

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

Reference to the TableView.

Reference to the TableView.

Available since: 4.0.0

Defined By

Static properties

...

Defaults to: []

Available since: 4.1.1

Methods

Defined By

Instance methods

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

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

Available since: 1.1.0

Parameters

  • eventNames : Object/String...

    Either an object with event names as properties with a value of true. For example:

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

    Or any number of event names as separate parameters. For example:

    this.addEvents('storeloaded', 'storecleared');
    
( eventName, [fn], [scope], [options] ) : Object
Appends an event handler to this object. ...

Appends an event handler to this object. For example:

myGridPanel.on("mouseover", this.onMouseOver, this);

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

Names of methods in a specified scope may also be used. Note that scope MUST be specified to use this option:

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

Available since: 1.1.0

Parameters

  • eventName : String/Object

    The name of the event to listen for. May also be an object who's property names are event names.

  • fn : Function (optional)

    The method the event invokes, or if scope is specified, the name* of the method within the specified scope. 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 : Ext.util.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'
            }
        });
      
    • destroyable : Boolean (optional)

      When specified as true, the function returns A Destroyable object. An object which implements the destroy method which removes all listeners added in this call.

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

      Defaults to: false

Returns

  • Object

    Only when the destroyable option is specified.

    A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

    this.btnListeners =  = myButton.on({
        destroyable: true
        mouseover:   function() { console.log('mouseover'); },
        mouseout:    function() { console.log('mouseout'); },
        click:       function() { console.log('click'); }
    });
    

    And when those listeners need to be removed:

    Ext.destroy(this.btnListeners);
    

    or

    this.btnListeners.destroy();
    

Fires

    Overrides: Ext.AbstractComponent.addListener

    ( item, ename, [fn], [scope], [options] ) : Object
    Adds listeners to any Observable object (or Ext.Element) which are automatically removed when this Component is destr...

    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.

    • options : Object (optional)

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

    Returns

    • Object

      Only when the destroyable option is specified.

      A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

      this.btnListeners =  = myButton.mon({
          destroyable: true
          mouseover:   function() { console.log('mouseover'); },
          mouseout:    function() { console.log('mouseout'); },
          click:       function() { console.log('click'); }
      });
      

      And when those listeners need to be removed:

      Ext.destroy(this.btnListeners);
      

      or

      this.btnListeners.destroy();
      

    Fires

      Approriate place to attach events to the view, selectionmodel, headerCt, etc ...

      Approriate place to attach events to the view, selectionmodel, headerCt, etc

      Available since: 4.0.0

      This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

      Overrides: Ext.grid.feature.Grouping.attachEvents

      ...

      Available since: 4.0.6

      ( 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

      Removes all listeners for this object including the managed listeners ...

      Removes all listeners for this object including the managed listeners

      Available since: 4.0.0

      Fires

        Removes all managed listeners for this object. ...

        Removes all managed listeners for this object.

        Available since: 4.0.0

        Fires

          ...

          Available since: 4.1.1

          injected into rowtpl and wrapped around metaRowTpl becomes part of the standard tpl ...

          injected into rowtpl and wrapped around metaRowTpl becomes part of the standard tpl

          Available since: 4.0.0

          Collapse a group ...

          Collapse a group

          Available since: 4.0.0

          Parameters

          • groupName : String/Ext.Element

            The group name, or the element that contains group body

          • focus : Boolean

            Pass true to focus the group after expand.

          Fires

            Collapse all groups ...

            Collapse all groups

            Available since: 4.1.0

            Fires

              ( records, preppedRecords, startIndex, fullWidth, o )private
              return the data in a grouped format. ...

              return the data in a grouped format.

              Available since: 4.0.0

              Parameters

              Fires

                ...

                Available since: 4.1.1

                ( eventName, args, bubbles )private
                Continue to fire event. ...

                Continue to fire event.

                Available since: 4.0.7

                Parameters

                Fires

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

                  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
                  • beginEnd : Array (optional)

                    The caller can specify on which indices to slice

                  Returns

                  Disables the feature. ...

                  Disables the feature.

                  Available since: 4.0.0

                  Overrides: Ext.grid.feature.Grouping.disable

                  Enables the feature. ...

                  Enables the feature.

                  Available since: 4.0.0

                  Overrides: Ext.grid.feature.Grouping.enable

                  Enables events fired by this Observable to bubble up an owner hierarchy by calling this.getBubbleTarget() if present. ...

                  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.define('Ext.overrides.form.field.Base', {
                      override: 'Ext.form.field.Base',
                  
                      //  Add functionality to Field's initComponent to enable the change event to bubble
                      initComponent: function () {
                          this.callParent();
                          this.enableBubble('change');
                      }
                  });
                  
                  var myForm = Ext.create('Ext.form.Panel', {
                      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

                  • eventNames : String/String[]

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

                  Expand a group ...

                  Expand a group

                  Available since: 4.0.0

                  Parameters

                  • groupName : String/Ext.Element

                    The group name, or the element that contains the group body

                  • focus : Boolean

                    Pass true to focus the group after expand.

                  Fires

                    Expand all groups ...

                    Expand all groups

                    Available since: 4.1.0

                    Fires

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

                      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.

                      Fires

                        Ext.grid.feature.GroupingSummary
                        view source
                        ( ) : Objectprivate
                        Generates all of the summary data to be used when processing the template ...

                        Generates all of the summary data to be used when processing the template

                        Available since: 4.0.0

                        Returns

                        Fires

                          ( data, idx, record, orig )template
                          Provide additional data to the prepareData call within the grid view. ...

                          Provide additional data to the prepareData call within the grid view.

                          Available since: 4.0.0

                          This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

                          Parameters

                          • data : Object

                            The data for this particular record.

                          • idx : Number

                            The row index for this record.

                          • record : Ext.data.Model

                            The record instance

                          • orig : Object

                            The original result from the prepareData call to massage.

                          Overrides: Ext.grid.feature.Grouping.getAdditionalData

                          Gets the bubbling parent for an Observable ...

                          Gets the bubbling parent for an Observable

                          Available since: 4.0.7

                          Returns

                          Fires

                            Gets the value for the column from the attached data. ...

                            Gets the value for the column from the attached data.

                            Available since: 4.0.2

                            Parameters

                            Returns

                            • String

                              The value to be rendered

                            ...

                            Available since: 4.1.0

                            Parameters

                            Ext.grid.feature.GroupingSummary
                            view source
                            ( ) : Stringprivate
                            Modifies the row template to include the summary row. ...

                            Modifies the row template to include the summary row.

                            Available since: 4.0.0

                            Returns

                            Fires

                              Overrides: Ext.grid.feature.Feature.getFeatureTpl

                              ( eventName, view, featureTarget, e )template
                              Abstract method to be overriden when a feature should add additional arguments to its event signature. ...

                              Abstract method to be overriden when a feature should add additional arguments to its event signature. By default the event will fire:

                              The method must also return the eventName as the first index of the array to be passed to fireEvent.

                              Available since: 4.0.0

                              This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

                              Parameters

                              Overrides: Ext.grid.feature.Grouping.getFireEventArgs

                              Ext.grid.feature.GroupingSummary
                              view source
                              ( ) : Objectprivate
                              Gets any fragments needed for the template. ...

                              Gets any fragments needed for the template.

                              Available since: 4.0.0

                              Returns

                              Fires

                                Overrides: Ext.grid.feature.Feature.getFragmentTpl

                                Create an associated DOM id for the group's body element given the group name ...

                                Create an associated DOM id for the group's body element given the group name

                                Available since: 4.1.0

                                Parameters

                                ...

                                Available since: 4.0.0

                                Create an associated DOM id for the group's header element given the group name ...

                                Create an associated DOM id for the group's header element given the group name

                                Available since: 4.1.0

                                Parameters

                                Get the group name from an associated element whether it's within a header or a body ...

                                Get the group name from an associated element whether it's within a header or a body

                                Available since: 4.1.0

                                Parameters

                                ( group, records, preppedRecords, fullWidth )private
                                return matching preppedRecords ...

                                return matching preppedRecords

                                Available since: 4.0.0

                                Parameters

                                Fires

                                  ...

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

                                    Gets the related menu item for a dataIndex ...

                                    Gets the related menu item for a dataIndex

                                    Available since: 4.0.6

                                    Parameters

                                    Returns

                                    ...

                                    Available since: 4.0.0

                                    Fires

                                      Allows a feature to inject member methods into the metaRowTpl. ...

                                      Allows a feature to inject member methods into the metaRowTpl. This is important for embedding functionality which will become part of the proper row tpl.

                                      Available since: 4.0.0

                                      This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

                                      Overrides: Ext.grid.feature.Grouping.getMetaRowTplFragments

                                      Ext.grid.feature.GroupingSummary
                                      view source
                                      ( index ) : Arrayprivate
                                      Gets the data for printing a template row ...

                                      Gets the data for printing a template row

                                      Available since: 4.0.0

                                      Parameters

                                      • index : Number

                                        The index in the template

                                      Returns

                                      • Array

                                        The template values

                                      Fires

                                        Get the summary data for a field. ...

                                        Get the summary data for a field.

                                        Available since: 4.0.2

                                        Parameters

                                        • store : Ext.data.Store

                                          The store to get the data from

                                        • type : String/Function

                                          The type of aggregation. If a function is specified it will be passed to the stores aggregate function.

                                        • field : String

                                          The field to aggregate on

                                        • group : Boolean

                                          True to aggregate in grouped mode

                                        Returns

                                        Gets any fragments to be used in the tpl ...

                                        Gets any fragments to be used in the tpl

                                        Available since: 4.0.2

                                        Returns

                                        ...

                                        Available since: 4.0.0

                                        ...

                                        Available since: 4.1.0

                                        Parameters

                                        Checks to see if this object has any listeners for a specified event, or whether the event bubbles. ...

                                        Checks to see if this object has any listeners for a specified event, or whether the event bubbles. The answer indicates whether the event needs firing or not.

                                        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 or bubbles, else false

                                        ...

                                        Available since: 4.0.0

                                        Parameters

                                        Ext.grid.feature.GroupingSummary
                                        view source
                                        ( )private
                                        End Definitions ...

                                        End Definitions

                                        Available since: 4.1.0

                                        Overrides: Ext.grid.feature.AbstractSummary.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

                                        ...

                                        Available since: 4.0.0

                                        Fires

                                          Returns true if the named group is expanded. ...

                                          Returns true if the named group is expanded.

                                          Available since: 4.1.1

                                          Parameters

                                          Returns

                                          • Boolean

                                            true if the group defined by that value is expanded.

                                          injected into rowtpl and wrapped around metaRowTpl becomes part of the standard tpl ...

                                          injected into rowtpl and wrapped around metaRowTpl becomes part of the standard tpl

                                          Available since: 4.0.0

                                          ( item, ename, [fn], [scope], [options] ) : Object
                                          Shorthand for addManagedListener. ...

                                          Shorthand for addManagedListener.

                                          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.

                                          • options : Object (optional)

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

                                          Returns

                                          • Object

                                            Only when the destroyable option is specified.

                                            A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

                                            this.btnListeners =  = myButton.mon({
                                                destroyable: true
                                                mouseover:   function() { console.log('mouseover'); },
                                                mouseout:    function() { console.log('mouseout'); },
                                                click:       function() { console.log('click'); }
                                            });
                                            

                                            And when those listeners need to be removed:

                                            Ext.destroy(this.btnListeners);
                                            

                                            or

                                            this.btnListeners.destroy();
                                            
                                          ( item, ename, [fn], [scope] )
                                          Shorthand for removeManagedListener. ...

                                          Shorthand for removeManagedListener.

                                          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.

                                          Allows a feature to mutate the metaRowTpl. ...

                                          Allows a feature to mutate the metaRowTpl. The array received as a single argument can be manipulated to add things on the end/begining of a particular row.

                                          Available since: 4.0.0

                                          This is a template method. a hook into the functionality of this class. Feel free to override it in child classes.

                                          Parameters

                                          • metaRowTplArray : Array

                                            A String array to be used constructing an XTemplate to render the rows. This Array may be changed to provide extra DOM structure.

                                          Overrides: Ext.grid.feature.Grouping.mutateMetaRowTpl

                                          ( eventName, [fn], [scope], [options] ) : Object
                                          Shorthand for addListener. ...

                                          Shorthand for addListener.

                                          Available since: 1.1.0

                                          Parameters

                                          • eventName : String/Object

                                            The name of the event to listen for. May also be an object who's property names are event names.

                                          • fn : Function (optional)

                                            The method the event invokes, or if scope is specified, the name* of the method within the specified scope. 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 : Ext.util.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'
                                                    }
                                                });
                                              
                                            • destroyable : Boolean (optional)

                                              When specified as true, the function returns A Destroyable object. An object which implements the destroy method which removes all listeners added in this call.

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

                                              Defaults to: false

                                          Returns

                                          • Object

                                            Only when the destroyable option is specified.

                                            A Destroyable object. An object which implements the destroy method which removes all listeners added in this call. For example:

                                            this.btnListeners =  = myButton.on({
                                                destroyable: true
                                                mouseover:   function() { console.log('mouseover'); },
                                                mouseout:    function() { console.log('mouseout'); },
                                                click:       function() { console.log('click'); }
                                            });
                                            

                                            And when those listeners need to be removed:

                                            Ext.destroy(this.btnListeners);
                                            

                                            or

                                            this.btnListeners.destroy();
                                            
                                          If we add a new item that doesn't belong to a rendered group, refresh the view ...

                                          If we add a new item that doesn't belong to a rendered group, refresh the view

                                          Available since: 4.1.0

                                          Parameters

                                          Fires

                                            ...

                                            Available since: Ext JS 4.1.3

                                            ( names, callback, scope )private
                                            ...

                                            Available since: 4.1.0

                                            Parameters

                                            ...

                                            Available since: 4.0.0

                                            Fires

                                              ( view, rowElement, groupName, e )private
                                              Toggle between expanded/collapsed state when clicking on the group. ...

                                              Toggle between expanded/collapsed state when clicking on the group.

                                              Available since: 4.0.0

                                              Parameters

                                              Fires

                                                Group by the header the user has clicked on. ...

                                                Group by the header the user has clicked on.

                                                Available since: 4.0.0

                                                Parameters

                                                Fires

                                                  Turn on and off grouping via the menu ...

                                                  Turn on and off grouping via the menu

                                                  Available since: 4.0.0

                                                  Parameters

                                                  ...

                                                  Available since: 4.1.0

                                                  Parameters

                                                  Fires

                                                    When a row gains focus, expand the groups above it ...

                                                    When a row gains focus, expand the groups above it

                                                    Available since: 4.0.0

                                                    Parameters

                                                    Fires

                                                      Refresh the whole view on edit so that the Summary gets updated ...

                                                      Refresh the whole view on edit so that the Summary gets updated

                                                      Available since: 4.1.0

                                                      ( store, record, type, changedFields )private
                                                      ...

                                                      Available since: 4.1.0

                                                      Parameters

                                                      Fires

                                                        Prepares a given class for observable instances. ...

                                                        Prepares a given class for observable instances. This method is called when a class derives from this class or uses this class as a mixin.

                                                        Available since: 4.1.2

                                                        Parameters

                                                        • T : Function

                                                          The class constructor to prepare.

                                                        Prints a summary row ...

                                                        Prints a summary row

                                                        Available since: 4.0.2

                                                        Parameters

                                                        • index : Object

                                                          The index in the template

                                                        Returns

                                                        • String

                                                          The value of the summary row

                                                        Fires

                                                          Prunes the grouped header from the header container ...

                                                          Prunes the grouped header from the header container

                                                          Available since: 4.0.0

                                                          Fires

                                                            ...

                                                            Available since: 4.0.6

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

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

                                                            For example if you are extending Grid, you might decide to forward some events from store. So you can do this inside your initComponent:

                                                            this.relayEvents(this.getStore(), ['load']);
                                                            

                                                            The grid instance will then have an observable 'load' event which will be passed the parameters of the store's load event and any function fired with the grid's load event would have access to the grid using the this keyword.

                                                            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 (optional)

                                                              A common prefix to prepend to the event names. For example:

                                                              this.relayEvents(this.getStore(), ['load', 'clear'], 'store');
                                                              

                                                              Now the grid will forward 'load' and 'clear' events of store as 'storeload' and 'storeclear'.

                                                            Returns

                                                            • Object

                                                              A Destroyable object. An object which implements the destroy method which, when destroyed, removes all relayers. For example:

                                                              this.storeRelayers = this.relayEvents(this.getStore(), ['load', 'clear'], 'store');
                                                              

                                                              Can be undone by calling

                                                              Ext.destroy(this.storeRelayers);
                                                              

                                                              or

                                                              this.store.relayers.destroy();
                                                              

                                                            Fires

                                                              Removes an event handler. ...

                                                              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.

                                                              Fires

                                                                Removes listeners that were added by the mon method. ...

                                                                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.

                                                                Fires

                                                                  Remove a single managed listener item ...

                                                                  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

                                                                  Overrides: Ext.AbstractComponent.removeManagedListenerItem

                                                                  Resumes firing events (see suspendEvents). ...

                                                                  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

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

                                                                  Available since: 4.0.0

                                                                  Parameters

                                                                  Returns

                                                                  ...

                                                                  Available since: 4.0.0

                                                                  Parameters

                                                                  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

                                                                    Suspends the firing of all events. ...

                                                                    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.

                                                                    Toggle whether or not to show the summary row. ...

                                                                    Toggle whether or not to show the summary row.

                                                                    Available since: 4.0.2

                                                                    Parameters

                                                                    • visible : Boolean

                                                                      True to show the summary row

                                                                    ( eventName, fn, [scope] )
                                                                    Shorthand for removeListener. ...

                                                                    Shorthand for removeListener.

                                                                    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.

                                                                    ...

                                                                    Available since: 4.0.6

                                                                    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

                                                                    Defined By

                                                                    Events

                                                                    ( view, node, group, e, eOpts )
                                                                    ...

                                                                    Available since: 4.0.0

                                                                    Parameters

                                                                    ...

                                                                    Available since: 4.0.0

                                                                    Parameters

                                                                    ...

                                                                    Available since: 4.0.0

                                                                    Parameters

                                                                    ...

                                                                    Available since: 4.0.0

                                                                    Parameters

                                                                    ...

                                                                    Available since: 4.0.0

                                                                    Parameters