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

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

All Implemented Interfaces:

HasAttachHandlers, HasResizeHandlers, HasHandlers, EventListener, 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 Composite

ColumnHeader Component.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	ColumnHeader.GridSplitBar
class	ColumnHeader.Group
class	ColumnHeader.Head

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(Widget container, ColumnModel<M> cm) Creates a new column header.

Method Summary

Methods

Modifier and Type	Method and Description
Widget	getContainer() Returns the header's container widget.
ColumnHeader.Head	getHead(int column)
int	getMinColumnWidth() Returns the minimum column width.
int	getSplitterWidth() Returns the splitter width.
int	indexOf(ColumnHeader.Head head) Returns the index of the given column head.
boolean	isAttached()
boolean	isEnableColumnReorder() Returns true if column reordering is enabled.
void	onBrowserEvent(Event event)
void	refresh()
void	release() Do not call.
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	setMenu(Menu menu) Sets the header's context menu.
void	setMinColumnWidth(int minColumnWidth) Sets the minimum column width.
void	setSplitterWidth(int splitterWidth) Sets the splitter width.
void	showColumnMenu(int column) Shows the column's header context menu.
void	sinkEvents(int eventBitsToAdd)
void	updateColumnHidden(int index, boolean hidden)
void	updateColumnWidth(int column, int width)
void	updateSortIcon(int colIndex, SortDir dir)
void	updateTotalWidth(int offset, int width)

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

setPixelSize

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, getStateId, getToolTip, hide, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isRendered, isStateful, isVisible, isVisible, mask, mask, removeHandler, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setPagePosition, setPosition, setShadow, setSize, setStateful, setStateId, setTabIndex, 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, removeFromParent, setLayoutData

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, unsinkEvents

Methods inherited from class java.lang.Object

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

Constructor Detail

ColumnHeader

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

Creates a new column header.

Parameters:

container - the containing widget

cm - the column model

Method Detail

getContainer

public Widget getContainer()

Returns the header's container widget.

Returns:

the container widget

getHead

public ColumnHeader.Head getHead(int column)

getMinColumnWidth

public int getMinColumnWidth()

Returns the minimum column width.

Returns:

the column width

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

isAttached

public boolean isAttached()

Specified by:

isAttached in interface HasAttachHandlers

Overrides:

isAttached in class Composite

isEnableColumnReorder

public boolean isEnableColumnReorder()

Returns true if column reordering is enabled.

Returns:

the column reorder state

onBrowserEvent

public void onBrowserEvent(Event event)

Specified by:

onBrowserEvent in interface EventListener

Overrides:

onBrowserEvent in class Composite

refresh

public void refresh()

release

public void release()

Do not call.

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

setMenu

public void setMenu(Menu menu)

Sets the header's context menu.

Parameters:

menu - the context menu

setMinColumnWidth

public void setMinColumnWidth(int minColumnWidth)

Sets the minimum column width.

Parameters:

minColumnWidth - the minimum column width

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

sinkEvents

public void sinkEvents(int eventBitsToAdd)

Overrides:

sinkEvents in class Widget

updateColumnHidden

public void updateColumnHidden(int index,
                      boolean hidden)

updateColumnWidth

public void updateColumnWidth(int column,
                     int width)

updateSortIcon

public void updateSortIcon(int colIndex,
                  SortDir dir)

updateTotalWidth

public void updateTotalWidth(int offset,
                    int width)