2 * @class Ext.grid.header.Container
3 * @extends Ext.container.Container
6 * Container which holds headers and is docked at the top or bottom of a TablePanel.
7 * The HeaderContainer drives resizing/moving/hiding of columns within the TableView.
8 * As headers are hidden, moved or resized the headercontainer is responsible for
9 * triggering changes within the view.
11 * @xtype headercontainer
13 Ext.define('Ext.grid.header.Container', {
14 extend: 'Ext.container.Container',
16 'Ext.grid.ColumnLayout',
17 'Ext.grid.column.Column',
21 'Ext.grid.plugin.HeaderResizer',
22 'Ext.grid.plugin.HeaderReorderer'
26 alias: 'widget.headercontainer',
28 baseCls: Ext.baseCSSPrefix + 'grid-header-ct',
32 * @cfg {Number} weight
33 * HeaderContainer overrides the default weight of 0 for all docked items to 100.
34 * This is so that it has more priority over things like toolbars.
37 defaultType: 'gridcolumn',
39 * @cfg {Number} defaultWidth
40 * Width of the header if no width or flex is specified. Defaults to 100.
45 sortAscText: 'Sort Ascending',
46 sortDescText: 'Sort Descending',
47 sortClearText: 'Clear Sort',
48 columnsText: 'Columns',
50 lastHeaderCls: Ext.baseCSSPrefix + 'column-header-last',
51 firstHeaderCls: Ext.baseCSSPrefix + 'column-header-first',
52 headerOpenCls: Ext.baseCSSPrefix + 'column-header-open',
54 // private; will probably be removed by 4.0
62 * <code>true</code> if this HeaderContainer is in fact a group header which contains sub headers.
64 * @property isGroupHeader
68 * @cfg {Boolean} sortable
69 * Provides the default sortable state for all Headers within this HeaderContainer.
70 * Also turns on or off the menus in the HeaderContainer. Note that the menu is
71 * shared across every header and therefore turning it off will remove the menu
72 * items for every header.
76 initComponent: function() {
80 me.plugins = me.plugins || [];
82 // TODO: Pass in configurations to turn on/off dynamic
83 // resizing and disable resizing all together
85 // Only set up a Resizer and Reorderer for the topmost HeaderContainer.
86 // Nested Group Headers are themselves HeaderContainers
88 me.resizer = Ext.create('Ext.grid.plugin.HeaderResizer');
89 me.reorderer = Ext.create('Ext.grid.plugin.HeaderReorderer');
90 if (!me.enableColumnResize) {
93 if (!me.enableColumnMove) {
94 me.reorderer.disable();
96 me.plugins.push(me.reorderer, me.resizer);
99 // Base headers do not need a box layout
100 if (me.isHeader && !me.items) {
103 // HeaderContainer and Group header needs a gridcolumn layout.
107 availableSpaceOffset: me.availableSpaceOffset,
112 me.defaults = me.defaults || {};
113 Ext.applyIf(me.defaults, {
114 width: me.defaultWidth,
115 triStateSort: me.triStateSort,
116 sortable: me.sortable
121 * @event columnresize
122 * @param {Ext.grid.header.Container} ct The grid's header Container which encapsulates all column headers.
123 * @param {Ext.grid.column.Column} column The Column header Component which provides the column definition
124 * @param {Number} width
130 * @param {Ext.grid.header.Container} ct The grid's header Container which encapsulates all column headers.
131 * @param {Ext.grid.column.Column} column The Column header Component which provides the column definition
132 * @param {Ext.EventObject} e
133 * @param {HTMLElement} t
138 * @event headertriggerclick
139 * @param {Ext.grid.header.Container} ct The grid's header Container which encapsulates all column headers.
140 * @param {Ext.grid.column.Column} column The Column header Component which provides the column definition
141 * @param {Ext.EventObject} e
142 * @param {HTMLElement} t
144 'headertriggerclick',
148 * @param {Ext.grid.header.Container} ct The grid's header Container which encapsulates all column headers.
149 * @param {Ext.grid.column.Column} column The Column header Component which provides the column definition
150 * @param {Number} fromIdx
151 * @param {Number} toIdx
156 * @param {Ext.grid.header.Container} ct The grid's header Container which encapsulates all column headers.
157 * @param {Ext.grid.column.Column} column The Column header Component which provides the column definition
162 * @param {Ext.grid.header.Container} ct The grid's header Container which encapsulates all column headers.
163 * @param {Ext.grid.column.Column} column The Column header Component which provides the column definition
168 * @param {Ext.grid.header.Container} ct The grid's header Container which encapsulates all column headers.
169 * @param {Ext.grid.column.Column} column The Column header Component which provides the column definition
170 * @param {String} direction
175 * Fired immediately after the column header menu is created.
176 * @param {Ext.grid.header.Container} ct This instance
177 * @param {Ext.menu.Menu} menu The Menu that was created
183 onDestroy: function() {
184 Ext.destroy(this.resizer, this.reorderer);
188 // Invalidate column cache on add
189 // We cannot refresh the View on every add because this method is called
190 // when the HeaderDropZone moves Headers around, that will also refresh the view
194 c.headerId = 'h' + (++me.headerCounter);
196 me.callParent(arguments);
200 // Invalidate column cache on remove
201 // We cannot refresh the View on every remove because this method is called
202 // when the HeaderDropZone moves Headers around, that will also refresh the view
203 onRemove: function(c) {
205 me.callParent(arguments);
209 afterRender: function() {
211 var store = this.up('[store]').store,
212 sorters = store.sorters,
213 first = sorters.first(),
217 hd = this.down('gridcolumn[dataIndex=' + first.property +']');
219 hd.setSortState(first.direction, false, true);
224 afterLayout: function() {
225 if (!this.isHeader) {
227 topHeaders = me.query('>gridcolumn:not([hidden])'),
230 me.callParent(arguments);
232 if (topHeaders.length) {
233 topHeaders[0].el.radioCls(me.firstHeaderCls);
234 topHeaders[topHeaders.length - 1].el.radioCls(me.lastHeaderCls);
239 onHeaderShow: function(header) {
240 // Pass up to the GridSection
242 gridSection = me.ownerCt,
244 topItems, topItemsVisible,
251 colCheckItem = menu.down('menucheckitem[headerId=' + header.id + ']');
253 colCheckItem.setChecked(true, true);
256 // There's more than one header visible, and we've disabled some checked items... re-enable them
257 topItems = menu.query('#columnItem>menucheckitem[checked]');
258 topItemsVisible = topItems.length;
259 if ((me.getVisibleGridColumns().length > 1) && me.disabledMenuItems && me.disabledMenuItems.length) {
260 if (topItemsVisible == 1) {
261 Ext.Array.remove(me.disabledMenuItems, topItems[0]);
263 for (i = 0, len = me.disabledMenuItems.length; i < len; i++) {
264 itemToEnable = me.disabledMenuItems[i];
265 if (!itemToEnable.isDestroyed) {
266 itemToEnable[itemToEnable.menu ? 'enableCheckChange' : 'enable']();
269 if (topItemsVisible == 1) {
270 me.disabledMenuItems = topItems;
272 me.disabledMenuItems = [];
277 // Only update the grid UI when we are notified about base level Header shows;
278 // Group header shows just cause a layout of the HeaderContainer
279 if (!header.isGroupHeader) {
281 me.view.onHeaderShow(me, header, true);
284 gridSection.onHeaderShow(me, header);
287 me.fireEvent('columnshow', me, header);
289 // The header's own hide suppresses cascading layouts, so lay the headers out now
293 onHeaderHide: function(header, suppressLayout) {
294 // Pass up to the GridSection
296 gridSection = me.ownerCt,
302 // If the header was hidden programmatically, sync the Menu state
303 colCheckItem = menu.down('menucheckitem[headerId=' + header.id + ']');
305 colCheckItem.setChecked(false, true);
307 me.setDisabledItems();
310 // Only update the UI when we are notified about base level Header hides;
311 if (!header.isGroupHeader) {
313 me.view.onHeaderHide(me, header, true);
316 gridSection.onHeaderHide(me, header);
319 // The header's own hide suppresses cascading layouts, so lay the headers out now
320 if (!suppressLayout) {
324 me.fireEvent('columnhide', me, header);
327 setDisabledItems: function(){
335 // Find what to disable. If only one top level item remaining checked, we have to disable stuff.
336 itemsToDisable = menu.query('#columnItem>menucheckitem[checked]');
337 if ((itemsToDisable.length === 1)) {
338 if (!me.disabledMenuItems) {
339 me.disabledMenuItems = [];
342 // If down to only one column visible, also disable any descendant checkitems
343 if ((me.getVisibleGridColumns().length === 1) && itemsToDisable[0].menu) {
344 itemsToDisable = itemsToDisable.concat(itemsToDisable[0].menu.query('menucheckitem[checked]'));
347 len = itemsToDisable.length;
348 // Disable any further unchecking at any level.
349 for (i = 0; i < len; i++) {
350 itemToDisable = itemsToDisable[i];
351 if (!Ext.Array.contains(me.disabledMenuItems, itemToDisable)) {
352 itemToDisable[itemToDisable.menu ? 'disableCheckChange' : 'disable']();
353 me.disabledMenuItems.push(itemToDisable);
360 * Temporarily lock the headerCt. This makes it so that clicking on headers
361 * don't trigger actions like sorting or opening of the header menu. This is
362 * done because extraneous events may be fired on the headers after interacting
363 * with a drag drop operation.
366 tempLock: function() {
368 Ext.Function.defer(function() {
373 onHeaderResize: function(header, w, suppressFocus) {
375 if (this.view && this.view.rendered) {
376 this.view.onHeaderResize(header, w, suppressFocus);
378 this.fireEvent('columnresize', this, header, w);
381 onHeaderClick: function(header, e, t) {
382 this.fireEvent("headerclick", this, header, e, t);
385 onHeaderTriggerClick: function(header, e, t) {
386 // generate and cache menu, provide ability to cancel/etc
387 if (this.fireEvent("headertriggerclick", this, header, e, t) !== false) {
388 this.showMenuBy(t, header);
392 showMenuBy: function(t, header) {
393 var menu = this.getMenu(),
394 ascItem = menu.down('#ascItem'),
395 descItem = menu.down('#descItem'),
398 menu.activeHeader = menu.ownerCt = header;
399 menu.setFloatParent(header);
400 // TODO: remove coupling to Header's titleContainer el
401 header.titleContainer.addCls(this.headerOpenCls);
403 // enable or disable asc & desc menu items based on header being sortable
404 sortableMth = header.sortable ? 'enable' : 'disable';
406 ascItem[sortableMth]();
409 descItem[sortableMth]();
414 // remove the trigger open class when the menu is hidden
415 onMenuDeactivate: function() {
416 var menu = this.getMenu();
417 // TODO: remove coupling to Header's titleContainer el
418 menu.activeHeader.titleContainer.removeCls(this.headerOpenCls);
421 moveHeader: function(fromIdx, toIdx) {
423 // An automatically expiring lock
425 this.onHeaderMoved(this.move(fromIdx, toIdx), fromIdx, toIdx);
428 purgeCache: function() {
430 // Delete column cache - column order has changed.
431 delete me.gridDataColumns;
433 // Menu changes when columns are moved. It will be recreated.
440 onHeaderMoved: function(header, fromIdx, toIdx) {
442 gridSection = me.ownerCt;
445 gridSection.onHeaderMove(me, header, fromIdx, toIdx);
447 me.fireEvent("columnmove", me, header, fromIdx, toIdx);
451 * Gets the menu (and will create it if it doesn't already exist)
454 getMenu: function() {
458 me.menu = Ext.create('Ext.menu.Menu', {
459 items: me.getMenuItems(),
461 deactivate: me.onMenuDeactivate,
465 me.setDisabledItems();
466 me.fireEvent('menucreate', me, me.menu);
472 * Returns an array of menu items to be placed into the shared menu
473 * across all headers in this header container.
474 * @returns {Array} menuItems
476 getMenuItems: function() {
479 itemId: 'columnItem',
480 text: me.columnsText,
481 cls: Ext.baseCSSPrefix + 'cols-icon',
482 menu: me.getColumnMenu(me)
488 text: me.sortAscText,
489 cls: 'xg-hmenu-sort-asc',
490 handler: me.onSortAscClick,
494 text: me.sortDescText,
495 cls: 'xg-hmenu-sort-desc',
496 handler: me.onSortDescClick,
503 // sort asc when clicking on item in menu
504 onSortAscClick: function() {
505 var menu = this.getMenu(),
506 activeHeader = menu.activeHeader;
508 activeHeader.setSortState('ASC');
511 // sort desc when clicking on item in menu
512 onSortDescClick: function() {
513 var menu = this.getMenu(),
514 activeHeader = menu.activeHeader;
516 activeHeader.setSortState('DESC');
520 * Returns an array of menu CheckItems corresponding to all immediate children of the passed Container which have been configured as hideable.
522 getColumnMenu: function(headerContainer) {
526 items = headerContainer.query('>gridcolumn[hideable]'),
527 itemsLn = items.length,
530 for (; i < itemsLn; i++) {
532 menuItem = Ext.create('Ext.menu.CheckItem', {
534 checked: !item.hidden,
537 menu: item.isGroupHeader ? this.getColumnMenu(item) : undefined,
538 checkHandler: this.onColumnCheckChange,
542 menuItem.disabled = true;
544 menuItems.push(menuItem);
546 // If the header is ever destroyed - for instance by dragging out the last remaining sub header,
547 // then the associated menu item must also be destroyed.
549 destroy: Ext.Function.bind(menuItem.destroy, menuItem)
555 onColumnCheckChange: function(checkItem, checked) {
556 var header = Ext.getCmp(checkItem.headerId);
557 header[checked ? 'show' : 'hide']();
561 * Get the columns used for generating a template via TableChunker.
562 * Returns an array of all columns and their
567 * - columnId - used to create an identifying CSS class
568 * - cls The tdCls configuration from the Column object
571 getColumnsForTpl: function(flushCache) {
573 headers = this.getGridColumns(flushCache),
574 headersLn = headers.length,
578 for (; i < headersLn; i++) {
581 dataIndex: header.dataIndex,
583 width: header.hidden ? 0 : header.getDesiredWidth(),
586 columnId: header.getItemId()
593 * Returns the number of <b>grid columns</b> descended from this HeaderContainer.
594 * Group Columns are HeaderContainers. All grid columns are returned, including hidden ones.
596 getColumnCount: function() {
597 return this.getGridColumns().length;
601 * Gets the full width of all columns that are visible.
603 getFullWidth: function(flushCache) {
605 headers = this.getVisibleGridColumns(flushCache),
606 headersLn = headers.length,
609 for (; i < headersLn; i++) {
610 if (!isNaN(headers[i].width)) {
611 // use headers getDesiredWidth if its there
612 if (headers[i].getDesiredWidth) {
613 fullWidth += headers[i].getDesiredWidth();
614 // if injected a diff cmp use getWidth
616 fullWidth += headers[i].getWidth();
623 // invoked internally by a header when not using triStateSorting
624 clearOtherSortStates: function(activeHeader) {
625 var headers = this.getGridColumns(),
626 headersLn = headers.length,
630 for (; i < headersLn; i++) {
631 if (headers[i] !== activeHeader) {
632 oldSortState = headers[i].sortState;
633 // unset the sortstate and dont recurse
634 headers[i].setSortState(null, true);
635 //if (!silent && oldSortState !== null) {
636 // this.fireEvent('sortchange', this, headers[i], null);
643 * Returns an array of the <b>visible<b> columns in the grid. This goes down to the lowest column header
644 * level, and does not return <i>grouped</i> headers which contain sub headers.
645 * @param {Boolean} refreshCache If omitted, the cached set of columns will be returned. Pass true to refresh the cache.
648 getVisibleGridColumns: function(refreshCache) {
649 return Ext.ComponentQuery.query(':not([hidden])', this.getGridColumns(refreshCache));
653 * Returns an array of all columns which map to Store fields. This goes down to the lowest column header
654 * level, and does not return <i>grouped</i> headers which contain sub headers.
655 * @param {Boolean} refreshCache If omitted, the cached set of columns will be returned. Pass true to refresh the cache.
658 getGridColumns: function(refreshCache) {
660 result = refreshCache ? null : me.gridDataColumns;
662 // Not already got the column cache, so collect the base columns
664 me.gridDataColumns = result = [];
665 me.cascade(function(c) {
666 if ((c !== me) && !c.isGroupHeader) {
676 * Get the index of a leaf level header regardless of what the nesting
679 getHeaderIndex: function(header) {
680 var columns = this.getGridColumns();
681 return Ext.Array.indexOf(columns, header);
685 * Get a leaf level header by index regardless of what the nesting
688 getHeaderAtIndex: function(index) {
689 var columns = this.getGridColumns();
690 return columns[index];
694 * Maps the record data to base it on the header id's.
695 * This correlates to the markup/template generated by
698 prepareData: function(data, rowIdx, record, view) {
700 headers = this.getGridColumns(),
701 headersLn = headers.length,
705 g = this.up('tablepanel'),
708 for (; colIdx < headersLn; colIdx++) {
713 header = headers[colIdx];
714 value = data[header.dataIndex];
716 // When specifying a renderer as a string, it always resolves
717 // to Ext.util.Format
718 if (Ext.isString(header.renderer)) {
719 header.renderer = Ext.util.Format[header.renderer];
722 if (Ext.isFunction(header.renderer)) {
723 value = header.renderer.call(
724 header.scope || this.ownerCt,
726 // metadata per cell passing an obj by reference so that
727 // it can be manipulated inside the renderer
739 // This warning attribute is used by the compat layer
740 obj.cssWarning = true;
741 metaData.tdCls = metaData.css;
745 obj[header.id+'-modified'] = record.isModified(header.dataIndex) ? Ext.baseCSSPrefix + 'grid-dirty-cell' : Ext.baseCSSPrefix + 'grid-clean-cell';
746 obj[header.id+'-tdCls'] = metaData.tdCls;
747 obj[header.id+'-tdAttr'] = metaData.tdAttr;
748 obj[header.id+'-style'] = metaData.style;
749 if (value === undefined || value === null || value === '') {
752 obj[header.id] = value;
757 expandToFit: function(header) {
759 this.view.expandToFit(header);