com.sencha.gxt.widget.core.client.grid

Class ColumnHeader<M>

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.sencha.gxt.widget.core.client.Component

com.sencha.gxt.widget.core.client.grid.ColumnHeader<M>

All Implemented Interfaces:

HasAttachHandlers, HasResizeHandlers, HasHandlers, EventListener, HasEnabled, HasVisibility, IsWidget, BeforeHideEvent.HasBeforeHideHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, MoveEvent.HasMoveHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, HasFocusSupport, HasItemId

public class ColumnHeader<M>
extends Component

A column header component.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ColumnHeader.ColumnHeaderAppearance
static interface	ColumnHeader.ColumnHeaderStyles
class	ColumnHeader.GridSplitBar
class	ColumnHeader.Group
class	ColumnHeader.Head
static interface	ColumnHeader.HeaderContextMenuFactory Delegate for external code to define what menu any given column should use
class	ColumnHeader.HiddenHeaderGroupConfig

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
ColumnHeader(Grid<M> container, ColumnModel<M> cm) Creates a new column header.
ColumnHeader(Grid<M> container, ColumnModel<M> cm, ColumnHeader.ColumnHeaderAppearance appearance) Creates a new column header.

Method Summary

Methods

Modifier and Type	Method and Description
ColumnHeader.ColumnHeaderAppearance	getAppearance() Returns the column header appearance.
Widget	getContainer() Returns the header's container widget.
ColumnHeader.Head	getHead(int column) Returns the head at the current index.
int	getMinColumnWidth() Returns the minimum column width.
int	getRightAlignOffset() Returns the amount of padding in pixels for right aligned columns (defaults to 16).
int	getSplitterWidth() Returns the splitter width.
int	indexOf(ColumnHeader.Head head) Returns the index of the given column head.
boolean	isDisableSortIcon() Returns the state of the sort icon.
boolean	isEnableColumnReorder() Returns true if column reordering is enabled.
void	refresh() Refreshes the columns.
void	release() Do not call.
void	setColumnModel(ColumnModel<M> columnModel) Assigns a new set of columns to the header, but does not yet rebuild the headers.
void	setDisableSortIcon(boolean disableSortIcon) True to disable the column sort icon (defaults to false).
void	setEnableColumnReorder(boolean enable) True to enable column reordering.
void	setEnableColumnResizing(boolean enable) True to enable column resizing.
void	setHeader(int column, SafeHtml header) Sets the column's header text.
void	setMenuFactory(ColumnHeader.HeaderContextMenuFactory menuFactory) Specifies which menu to use for any given column
void	setMinColumnWidth(int minColumnWidth) Sets the minimum column width (defaults to 25px).
void	setRightAlignOffset(int rightAlignOffset) Sets the amount of padding in pixels for right aligned columns (defaults to 16).
void	setSplitterWidth(int splitterWidth) Sets the splitter width.
void	showColumnMenu(int column) Shows the column's header context menu.
void	updateColumnHidden(int index, boolean hidden) Updates the visibility of a column.
void	updateColumnWidth(int column, int width) Updates the column width.
void	updateSortIcon(int colIndex, SortDir dir) Updates the sort icon of a column.
void	updateTotalWidth(int offset, int width) Updates the total width of the header.

Methods inherited from class com.sencha.gxt.widget.core.client.Component

addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleOnOver, clearSizeCache, disable, disableEvents, enable, enableEvents, fireEvent, focus, getData, getElement, getFocusSupport, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hide, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isRendered, isStateful, isVisible, isVisible, mask, mask, onBrowserEvent, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setPagePosition, setPixelSize, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setTabIndex, setToolTip, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, getLayoutData, getParent, isAttached, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, removeStyleName, setStyleDependentName, setStyleName, setStyleName, setStylePrimaryName, setTitle, setVisible, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ColumnHeader

public ColumnHeader(Grid<M> container,
            ColumnModel<M> cm)

Creates a new column header.

Parameters:

container - the containing widget

cm - the column model

ColumnHeader

public ColumnHeader(Grid<M> container,
            ColumnModel<M> cm,
            ColumnHeader.ColumnHeaderAppearance appearance)

Creates a new column header.

Parameters:

container - the containing widget

cm - the column model

appearance - the column header appearance

Method Detail

getAppearance

public ColumnHeader.ColumnHeaderAppearance getAppearance()

Returns the column header appearance.

Returns:

the column header appearance

getContainer

public Widget getContainer()

Returns the header's container widget.

Returns:

the container widget

getHead

public ColumnHeader.Head getHead(int column)

Returns the head at the current index.

Parameters:

column - the column index

Returns:

the column or null if no match

getMinColumnWidth

public int getMinColumnWidth()

Returns the minimum column width.

Returns:

the column width in pixels

getRightAlignOffset

public int getRightAlignOffset()

Returns the amount of padding in pixels for right aligned columns (defaults to 16).

Returns:

the right align offset

getSplitterWidth

public int getSplitterWidth()

Returns the splitter width.

Returns:

the splitter width in pixels.

indexOf

public int indexOf(ColumnHeader.Head head)

Returns the index of the given column head.

Parameters:

head - the column head

Returns:

the index

isDisableSortIcon

public boolean isDisableSortIcon()

Returns the state of the sort icon.

isEnableColumnReorder

public boolean isEnableColumnReorder()

Returns true if column reordering is enabled.

Returns:

the column reorder state

refresh

public void refresh()

Refreshes the columns.

release

public void release()

Do not call.

setColumnModel

public void setColumnModel(ColumnModel<M> columnModel)

Assigns a new set of columns to the header, but does not yet rebuild the headers. The refresh() method must be called to achieve that.

Parameters:

columnModel - the new set of columns to use

setDisableSortIcon

public void setDisableSortIcon(boolean disableSortIcon)

True to disable the column sort icon (defaults to false).

setEnableColumnReorder

public void setEnableColumnReorder(boolean enable)

True to enable column reordering.

Parameters:

enable - true to enable

setEnableColumnResizing

public void setEnableColumnResizing(boolean enable)

True to enable column resizing.

Parameters:

enable - true to enable, otherwise false

setHeader

public void setHeader(int column,
             SafeHtml header)

Sets the column's header text.

Parameters:

column - the column index

header - the header text

setMenuFactory

public void setMenuFactory(ColumnHeader.HeaderContextMenuFactory menuFactory)

Specifies which menu to use for any given column

Parameters:

menuFactory - the instance to use when requesting a menu

setMinColumnWidth

public void setMinColumnWidth(int minColumnWidth)

Sets the minimum column width (defaults to 25px).

Parameters:

minColumnWidth - the minimum column width in pixels

setRightAlignOffset

public void setRightAlignOffset(int rightAlignOffset)

Sets the amount of padding in pixels for right aligned columns (defaults to 16).

Parameters:

rightAlignOffset - the right align offset

setSplitterWidth

public void setSplitterWidth(int splitterWidth)

Sets the splitter width.

Parameters:

splitterWidth - the splitter width

showColumnMenu

public void showColumnMenu(int column)

Shows the column's header context menu.

Parameters:

column - the column index

updateColumnHidden

public void updateColumnHidden(int index,
                      boolean hidden)

Updates the visibility of a column.

Parameters:

index - the column index

hidden - true to hide, otherwise false

updateColumnWidth

public void updateColumnWidth(int column,
                     int width)

Updates the column width.

Parameters:

column - the column index

width - the new width

updateSortIcon

public void updateSortIcon(int colIndex,
                  SortDir dir)

Updates the sort icon of a column.

Parameters:

colIndex - the column index

dir - the sort direction

updateTotalWidth

public void updateTotalWidth(int offset,
                    int width)

Updates the total width of the header.

Parameters:

offset - the offset

width - the new width