For up to date documentation and features, visit http://docs.sencha.com/ext-js/4-0

Sencha Documentation

Hierarchy

Mixins

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 2 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.
  • data {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'
    }]
});
Defined By

Config Options

Other Configs

 

Number of pixels to indent per grouping level

Number of pixels to indent per grouping level

 

true to enable the grouping control in the header menu (defaults to true)

true to enable the grouping control in the header menu (defaults to true)

 

true to allow the user to turn off grouping (defaults to true)

true to allow the user to turn off grouping (defaults to true)

 

Text displayed in the grid header menu for grouping by header (defaults to 'Group By This Field').

Text displayed in the grid header menu for grouping by header (defaults to 'Group By This Field').

 
Template snippet, this cannot be an actual template. {name} will be replaced with the current group. Defaults to 'Gro...

Template snippet, this cannot be an actual template. {name} will be replaced with the current group. Defaults to 'Group: {name}'

 

true to hide the header that is currently grouped (defaults to false)

true to hide the header that is currently grouped (defaults to false)

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

(optional)

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 ExtJs Components


While some ExtJs 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 click 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'); }
        }
    }
});

 
. The name of the property which contains the Array of summary objects. Defaults to undefined. It allows to use ser...

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

 

Text displayed in the grid header for enabling/disabling grouping (defaults to 'Show in Groups').

Text displayed in the grid header for enabling/disabling grouping (defaults to 'Show in Groups').

 

True to show the summary row. Defaults to true.

True to show the summary row. Defaults to true.

 

true to start all groups collapsed (defaults to false)

true to start all groups collapsed (defaults to false)

Defined By

Properties

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

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

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

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

 

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

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

 

Reference to the grid panel

Reference to the grid panel

 

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.

 

Reference to the TableView.

Reference to the TableView.

Defined By

Methods

 
addEvents( Object/String o, String ) : void

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.

Parameters

  • o : Object/String

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

  • : String

    [additional] Optional additional event names if multiple event names are being passed as separate parameters. Usage:

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

Returns

  • void   
 
addListener( String eventName, Function handler, [Object scope], [Object options]) : void

Appends an event handler to this object.

Appends an event handler to this object.

Parameters

  • eventName : String

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

  • handler : Function

    The method the event invokes.

  • 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. properties. This may contain any of the following properties:

    • scope : Object
      The scope (this reference) in which the handler function is executed. If omitted, defaults to the object which fired the event.
    • delay : Number
      The number of milliseconds to delay the invocation of the handler after the event fires.
    • single : Boolean
      True to add a handler to handle just the next firing of the event, and then remove itself.
    • buffer : Number
      Causes the handler to be scheduled to run in an Ext.util.DelayedTask delayed by the specified number of milliseconds. If the event fires again within that time, the original handler is not invoked, but the new handler is scheduled in its place.
    • target : Observable
      Only call the handler if the event was fired on the target Observable, not if the event was bubbled up from a child Observable.
    • element : String
      This option is only valid for listeners bound to Components. The name of a Component property which references an element to add a listener to.

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

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

      When added in this way, the options available are the options applicable to Ext.core.Element.addListener


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

    A delayed, one-time listener.

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

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

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

Returns

  • void   
 
addManagedListener( Observable/Element item, Object/String ename, Function fn, Object scope, Object opt) : void

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

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

Parameters

  • item : Observable/Element

    The item to which to add a listener/listeners.

  • ename : Object/String

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

  • fn : Function

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

  • scope : Object

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

  • opt : Object

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

Returns

  • void   
 

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

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

Returns

  • void   
 
capture( Observable o, Function fn, [Object scope]) : void
Starts capture on the specified Observable. All events will be passed to the supplied function with the event name + ...

Starts capture on the specified Observable. All events will be passed to the supplied function with the event name + standard signature of the event before the event is fired. If the supplied function returns false, the event will not fire.

Parameters

  • o : Observable

    The Observable to capture events from.

  • fn : Function

    The function to call when an event is fired.

  • scope : Object

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

Returns

  • void   
 

Removes all listeners for this object including the managed listeners

Removes all listeners for this object including the managed listeners

Returns

  • void   
 

Removes all managed listeners for this object.

Removes all managed listeners for this object.

Returns

  • void   
 

Disable a feature

Disable a feature

Returns

  • void   
 

Enable a feature

Enable a feature

Returns

  • void   
 
enableBubble( String/Array events) : void
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.override(Ext.form.field.Base, {
//  Add functionality to Field's initComponent to enable the change event to bubble
initComponent : Ext.Function.createSequence(Ext.form.field.Base.prototype.initComponent, function() {
    this.enableBubble('change');
}),

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

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

Parameters

  • events : String/Array

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

Returns

  • void   
 
fireEvent( String eventName, Object... args) : Boolean
Fires the specified event with the passed parameters (minus the event name). An event may be set to bubble up an Ob...

Fires the specified event with the passed parameters (minus the event name).

An event may be set to bubble up an Observable parent hierarchy (See Ext.Component.getBubbleTarget) by calling enableBubble.

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.

 
getAdditionalData( Object data, Number idx, Ext.data.Model record, Object orig) : void

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

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

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.

Returns

  • void   
 
getColumnValue( Ext.grid.column.Column column, Object data) : String

Gets the value for the column from the attached data.

Gets the value for the column from the attached data.

Parameters

  • column : Ext.grid.column.Column

    The header

  • data : Object

    The current data

Returns

  • String   

    The value to be rendered

 
getFireEventArgs( Object eventName, Object view, Object featureTarget) : void
Abstract method to be overriden when a feature should add additional arguments to its event signature. By default the...

Abstract method to be overriden when a feature should add additional arguments to its event signature. By default the event will fire: - view - The underlying Ext.view.Table - featureTarget - The matched element by the defined eventSelector

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

Parameters

  • eventName : Object
  • view : Object
  • featureTarget : Object

Returns

  • void   
 
Allows a feature to inject member methods into the metaRowTpl. This is important for embedding functionality which wi...

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.

Returns

  • void   
 
hasListener( String eventName) : Boolean

Checks to see if this object has any listeners for a specified event

Checks to see if this object has any listeners for a specified event

Parameters

  • eventName : String

    The name of the event to check for

Returns

  • Boolean   

    True if the event is being listened for, else false

 
Allows a feature to mutate the metaRowTpl. The array received as a single argument can be manipulated to add things o...

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.

Parameters

  • metaRowTplArray : Object

Returns

  • void   
 
observe( Function c, Object listeners) : void
Sets observability on the passed class constructor. This makes any event fired on any instance of the passed class a...

Sets observability on the passed class constructor.

This makes any event fired on any instance of the passed class also fire a single event through the class allowing for central handling of events on many instances at once.

Usage:

Ext.util.Observable.observe(Ext.data.Connection);
Ext.data.Connection.on('beforerequest', function(con, options) {
    console.log('Ajax request made to ' + options.url);
});

Parameters

  • c : Function

    The class constructor to make observable.

  • listeners : Object

    An object containing a series of listeners to add. See addListener.

Returns

  • void   
 
on( String eventName, Function handler, [Object scope], [Object options]) : void

Appends an event handler to this object (shorthand for addListener.)

Appends an event handler to this object (shorthand for addListener.)

Parameters

  • eventName : String

    The type of event to listen for

  • handler : Function

    The method the event invokes

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

Returns

  • void   
 
relayEvents( Object origin, Array events, Object prefix) : void

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.

Parameters

  • origin : Object

    The Observable whose events this object is to relay.

  • events : Array

    Array of event names to relay.

  • prefix : Object

Returns

  • void   
 

Removes all added captures from the Observable.

Removes all added captures from the Observable.

Parameters

  • o : Observable

    The Observable to release

Returns

  • void   
 
removeListener( String eventName, Function handler, [Object scope]) : void

Removes an event handler.

Removes an event handler.

Parameters

  • eventName : String

    The type of event the handler was associated with.

  • handler : 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.

Returns

  • void   
 
removeManagedListener( Observable|Element item, Object|String ename, Function fn, Object scope) : void

Removes listeners that were added by the mon method.

Removes listeners that were added by the mon method.

Parameters

  • item : Observable|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.

Returns

  • void   
 
Resume firing events. (see suspendEvents) If events were suspended using the queueSuspended parameter, then all event...

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

Returns

  • void   
 
suspendEvents( Boolean queueSuspended) : void

Suspend the firing of all events. (see resumeEvents)

Suspend the firing of all events. (see resumeEvents)

Parameters

  • queueSuspended : Boolean

    Pass as true to queue up suspended events to be fired after the resumeEvents call instead of discarding all suspended events;

Returns

  • void   
 

Toggle whether or not to show the summary row.

Toggle whether or not to show the summary row.

Parameters

  • visible : Boolan

    True to show the summary row

Returns

  • void   
 
un( String eventName, Function handler, [Object scope]) : void

Removes an event handler (shorthand for removeListener.)

Removes an event handler (shorthand for removeListener.)

Parameters

  • eventName : String

    The type of event the handler was associated with.

  • handler : 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.

Returns

  • void   
Defined By

Events

 
groupclick( Ext.view.Table view, HTMLElement node, Number unused, Number unused, Ext.EventObject e)

 

Parameters

  • view : Ext.view.Table
  • node : HTMLElement
  • unused : Number
  • unused : Number
  • e : Ext.EventObject
 
groupcollapse( Ext.view.Table view, HTMLElement node, Number unused, Number unused, Ext.EventObject e)

 

Parameters

  • view : Ext.view.Table
  • node : HTMLElement
  • unused : Number
  • unused : Number
  • e : Ext.EventObject
 
groupcontextmenu( Ext.view.Table view, HTMLElement node, Number unused, Number unused, Ext.EventObject e)

 

Parameters

  • view : Ext.view.Table
  • node : HTMLElement
  • unused : Number
  • unused : Number
  • e : Ext.EventObject
 
groupdblclick( Ext.view.Table view, HTMLElement node, Number unused, Number unused, Ext.EventObject e)

 

Parameters

  • view : Ext.view.Table
  • node : HTMLElement
  • unused : Number
  • unused : Number
  • e : Ext.EventObject
 
groupexpand( Ext.view.Table view, HTMLElement node, Number unused, Number unused, Ext.EventObject e)

 

Parameters

  • view : Ext.view.Table
  • node : HTMLElement
  • unused : Number
  • unused : Number
  • e : Ext.EventObject