Clear Up
SharpKit Reference

Container Class

Container which holds headers and is docked at the top or bottom of a TablePanel. The HeaderContainer drives resizing/moving/hiding of columns within the TableView. As headers are hidden, moved or resized the headercontainer is responsible for triggering changes within the view.

Namespace: Ext.grid.header


Name Description
defaultWidth Width of the header if no width or flex is specified. Defaults to: 100
sealed Specify as true to constrain column dragging so that a column cannot be dragged into or out of this column. Note that this config is only valid for column headers which contain child column headers, eg:
            sealed: true
            text: 'ExtJS',
            columns: [{
            text: '3.0.4',
            dataIndex: 'ext304'
            }, {
            text: '4.1.0',
            dataIndex: 'ext410'
Defaults to: false
sortable Provides the default sortable state for all Headers within this HeaderContainer. Also turns on or off the menus in the HeaderContainer. Note that the menu is shared across every header and therefore turning it off will remove the menu items for every header. Defaults to: true
weight HeaderContainer overrides the default weight of 0 for all docked items to 100. This is so that it has more priority over things like toolbars. Defaults to: 100


Name Description
getColumnCount() Returns the number of grid columns descended from this HeaderContainer. Group Columns are HeaderContainers. All grid columns are returned, including hidden ones.
getColumnMenu(object) Returns an array of menu CheckItems corresponding to all immediate children of the passed Container which have been configured as hideable.
getFullWidth(object) Gets the full width of all columns that are visible.
getGridColumns(bool) Returns an array of all columns which map to Store fields. This goes down to the lowest column header level, and does not return grouped headers which contain sub headers.
getHeaderAtIndex(JsNumber) Get a leaf level header by index regardless of what the nesting structure is.
getHeaderIndex(Column) Returns the index of a leaf level header regardless of what the nesting structure is. If a group header is passed, the index of the first leaf level heder within it is returned.
getMenuItems() Returns an array of menu items to be placed into the shared menu across all headers in this header container.
getVisibleGridColumns(bool) Returns an array of the visible columns in the grid. This goes down to the lowest column header level, and does not return grouped headers which contain sub headers.
getVisibleHeaderClosestToIndex(JsNumber) When passed a column index, returns the closet visible column to that. If the column at the passed index is visible, that is returned. If it is hidden, either the next visible, or the previous visible column is returned.
prepareData(object, object, object, object, object) Maps the record data to base it on the header id's. This correlates to the markup/template generated by TableChunker.


Name Description
isGroupHeader True if this HeaderContainer is in fact a group header which contains sub headers.
© Copyright 2005-2011 SharpKit. All rights reserved.