X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..3789b528d8dd8aad4558e38e22d775bcab1cbd36:/docs/api/Ext.grid.feature.Grouping.html?ds=sidebyside diff --git a/docs/api/Ext.grid.feature.Grouping.html b/docs/api/Ext.grid.feature.Grouping.html deleted file mode 100644 index 3fc618f9..00000000 --- a/docs/api/Ext.grid.feature.Grouping.html +++ /dev/null @@ -1,491 +0,0 @@ -
Hierarchy
Ext.util.ObservableExt.grid.feature.FeatureExt.grid.feature.Grouping
This feature allows to display the grid rows aggregated into groups as specified by the Ext.data.Store.groupers -specified on the Store. The group will show the title for the group name and then the appropriate records for the group -underneath. The groups can also be expanded and collapsed.
- -This feature adds several extra events that will be fired on the grid to interact with the groups:
- - - - -This feature adds extra options to the grid column menu to provide the user with functionality to modify the grouping. -This can be disabled by setting the enableGroupingMenu option. The option to disallow grouping from being turned off -by thew user is enableNoGroups.
- -The groupHeaderTpl is used to control the rendered title for each group. It can modified to customized -the default display.
- -var groupingFeature = Ext.create('Ext.grid.feature.Grouping', {
- groupHeaderTpl: 'Group: {name} ({rows.length})', //print the number of items in the group
- startCollapsed: true // start all groups collapsed
-});
-
-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 '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. 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'); }
- }
- }
-});
-
-
-
-
-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').
-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", "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.
-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.
-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.
[additional] Optional additional event names if multiple event names are being passed as separate parameters. -Usage:
- -this.addEvents('storeloaded', 'storecleared');
-
-
-Appends an event handler to this object.
-Appends an event handler to this object.
-The name of the event to listen for. May also be an object who's property names are event names. See
-The method the event invokes.
-(optional) The scope (this
reference) in which the handler function is executed.
-If omitted, defaults to the object which fired the event.
(optional) An object containing handler configuration. -properties. This may contain any of the following properties:
this
reference) in which the handler function is executed.
-If omitted, defaults to the object which fired the event.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
-});
-
.
-- -
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. - -
The item to which to add a listener/listeners.
-The event name, or an object containing event name properties.
-Optional. If the ename
parameter was an event name, this
-is the handler function.
Optional. If the ename
parameter was an event name, this
-is the scope (this
reference) in which the handler function is executed.
Optional. If the ename
parameter was an event name, this
-is the addListener options.
Approriate place to attach events to the view, selectionmodel, headerCt, etc
-Approriate place to attach events to the view, selectionmodel, headerCt, etc
-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.
-The Observable to capture events from.
-The function to call when an event is fired.
-(optional) The scope (this
reference) in which the function is executed. Defaults to the Observable firing the event.
Removes all listeners for this object including the managed listeners
-Removes all listeners for this object including the managed listeners
-Removes all managed listeners for this object.
-Removes all managed listeners for this object.
-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');
- }
-}
-});
-
-
-The event name to bubble, or an Array of event names.
-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.
- -The name of the event to fire.
-Variable number of parameters are passed to handlers.
-returns false if any of the handlers return false otherwise it returns true.
-Provide additional data to the prepareData call within the grid view.
-Provide additional data to the prepareData call within the grid view.
-The data for this particular record.
-The row index for this record.
-The record instance
-The original result from the prepareData call to massage.
-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.
-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.
-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
-The name of the event to check for
-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 -on the end/begining of a particular row.
-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);
-});
-
-The class constructor to make observable.
-An object containing a series of listeners to add. See addListener.
-Appends an event handler to this object (shorthand for addListener.)
-Appends an event handler to this object (shorthand for addListener.)
-The type of event to listen for
-The method the event invokes
-(optional) The scope (this
reference) in which the handler function is executed.
-If omitted, defaults to the object which fired the event.
(optional) An object containing handler configuration.
-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
.
The Observable whose events this object is to relay.
-Array of event names to relay.
-Removes all added captures from the Observable.
-Removes all added captures from the Observable.
-The Observable to release
-Removes an event handler.
-Removes an event handler.
-The type of event the handler was associated with.
-The handler to remove. This must be a reference to the function passed into the addListener call.
-(optional) The scope originally specified for the handler.
-Removes listeners that were added by the mon method.
-Removes listeners that were added by the mon method.
-The item from which to remove a listener/listeners.
-The event name, or an object containing event name properties.
-Optional. If the ename
parameter was an event name, this
-is the handler function.
Optional. If the ename
parameter was an event name, this
-is the scope (this
reference) in which the handler function is executed.
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.
Suspend the firing of all events. (see resumeEvents)
-Suspend the firing of all events. (see resumeEvents)
-Pass as true to queue up suspended events to be fired -after the resumeEvents call instead of discarding all suspended events;
-Removes an event handler (shorthand for removeListener.)
-Removes an event handler (shorthand for removeListener.)
-The type of event the handler was associated with.
-The handler to remove. This must be a reference to the function passed into the addListener call.
-(optional) The scope originally specified for the handler.
-