com.extjs.gxt.ui.client.widget.grid
Class ColumnHeader

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.extjs.gxt.ui.client.widget.Component
              extended by com.extjs.gxt.ui.client.widget.BoxComponent
                  extended by com.extjs.gxt.ui.client.widget.grid.ColumnHeader
All Implemented Interfaces:
Observable, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.IsWidget

public class ColumnHeader
extends BoxComponent

ColumnHeader Component.


Nested Class Summary
 class ColumnHeader.GridSplitBar
           
 class ColumnHeader.Group
           
 class ColumnHeader.Head
           
 
Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled
 
Field Summary
protected  ColumnHeader.GridSplitBar bar
           
protected  ColumnModel cm
           
protected  BoxComponent container
           
protected  java.util.List<ColumnHeader.Group> groups
           
protected  boolean headerDisabled
           
protected  java.util.List<ColumnHeader.Head> heads
           
protected  Menu menu
           
protected  int minColumnWidth
           
protected  Draggable reorderer
           
protected  int rows
           
protected  int splitterWidth
           
protected  com.google.gwt.user.client.ui.FlexTable table
           
 
Fields inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
adjustSize, cacheSizes, ensureVisibilityOnSizing, height, lastSize, layer, shim, width
 
Fields inherited from class com.extjs.gxt.ui.client.widget.Component
afterRender, attachables, baseStyle, disabled, disabledStyle, disableTextSelection, dummy, focusable, hidden, mask, maskMessage, maskMessageStyleName, monitorWindowResize, rendered, resizeHandler, setElementRender, stateId, swallowEvents, toolTip, windowResizeDelay, windowResizeTask
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
ColumnHeader(BoxComponent container, ColumnModel cm)
          Creates a new column header.
 
Method Summary
protected  void adjustHeights()
           
protected  void cleanCells()
           
protected  ComponentEvent createColumnEvent(ColumnHeader header, int column, Menu menu)
           
protected  ColumnHeader.Group createNewGroup(HeaderGroupConfig config)
           
protected  ColumnHeader.Head createNewHead(ColumnConfig config)
           
protected  void doAttachChildren()
           
protected  void doDetachChildren()
           
 void enableColumnResizing()
          Deprecated. See setEnableColumnResizing(boolean)
protected  int getColumnWidths(int start, int end)
           
 BoxComponent getContainer()
          Returns the header's container component.
protected  Menu getContextMenu(int column)
           
 com.google.gwt.user.client.Element getElement()
           
 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()
           
protected  void onAttach()
           
 void onBrowserEvent(com.google.gwt.user.client.Event event)
          Components delegate event handling to Component.onComponentEvent(ComponentEvent).
protected  void onColumnSplitterMoved(int colIndex, int width)
           
protected  void onDetach()
           
protected  void onDropDownClick(ComponentEvent ce, int column)
           
protected  void onHeaderClick(ComponentEvent ce, int column)
           
protected  void onHeaderDoubleClick(ComponentEvent ce, int column)
           
protected  void onHeaderMouseDown(ComponentEvent ce, int column)
           
protected  void onKeyDown(ComponentEvent ce, int index)
           
protected  void onRender(com.google.gwt.user.client.Element target, int index)
          Subclasses must override and ensure setElement is called for lazy rendered components.
 void refresh()
           
 void release()
          Do not call.
protected  void selectHeader(int index)
           
 void setEnableColumnReorder(boolean enable)
           
 void setEnableColumnResizing(boolean enable)
          True to enable column resizing.
 void setHeader(int column, java.lang.String 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, Style.SortDir dir)
           
 void updateTotalWidth(int offset, int width)
           
 
Methods inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
adjustPosition, adjustSize, afterRender, createComponentEvent, getBounds, getHeight, getHeight, getPosition, getPositionEl, getResizeEl, getShadow, getShadowOffset, getShadowPosition, getSize, getWidth, getWidth, hideShadow, hideShim, hideUnders, isAutoHeight, isAutoWidth, isDeferHeight, isShim, onHide, onPosition, onResize, onShow, onUnload, setAutoHeight, setAutoWidth, setBounds, setBounds, setDeferHeight, setHeight, setHeight, setPagePosition, setPagePosition, setPixelSize, setPosition, setShadow, setShadowOffset, setShadowPosition, setShim, setSize, setSize, setWidth, setWidth, sync, syncSize
 
Methods inherited from class com.extjs.gxt.ui.client.widget.Component
addAttachable, addListener, addPlugin, addStyleName, addStyleOnOver, addWidgetListener, applyState, assertAfterRender, assertPreRender, beforeRender, blur, clearState, createObservable, createStyles, disable, disableContextMenu, disableEvents, disableTextSelection, el, enable, enableEvents, fireEvent, fireEvent, fireEvent, fly, focus, frame, getAriaSupport, getBaseStyle, getBorders, getContextMenu, getData, getFocusEl, getFocusSupport, getHideMode, getId, getItemId, getListeners, getModel, getObservable, getPlugins, getState, getStateId, getTabIndex, getTitle, getToolTip, getWindowResizeDelay, hasListeners, hasListeners, hide, hideToolTip, initState, isDisabledEvents, isDisableTextSelection, isEnabled, isMasked, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, mask, notifyHide, notifyShow, onComponentEvent, onDetachHelper, onDisable, onEnable, onEnsureDebugId, onHideContextMenu, onLoad, onRightClick, onShowContextMenu, onWindowResize, previewEvent, recalculate, removeAllListeners, removeAttachagle, removeFromParent, removeListener, removeStyleName, removeStyleOnOver, removeSwallow, removeToolTip, removeWidgetListener, render, render, repaint, saveState, setAriaRole, setAriaState, setAriaSupport, setBorders, setContextMenu, setData, setEl, setElement, setElement, setEnabled, setFiresEvents, setHideMode, setId, setIntStyleAttribute, setItemId, setModel, setMonitorWindowResize, setParent, setStateful, setStateId, setStyleAttribute, setStyleName, setTabIndex, setTitle, setToolTip, setToolTip, setVisible, setWindowResizeDelay, setZIndex, show, swallowEvent, swallowEvent, toString, unframe, unmask
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, setLayoutData
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, removeStyleDependentName, setElement, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

bar

protected ColumnHeader.GridSplitBar bar

cm

protected ColumnModel cm

container

protected BoxComponent container

groups

protected java.util.List<ColumnHeader.Group> groups

headerDisabled

protected boolean headerDisabled

heads

protected java.util.List<ColumnHeader.Head> heads

menu

protected Menu menu

minColumnWidth

protected int minColumnWidth

reorderer

protected Draggable reorderer

rows

protected int rows

splitterWidth

protected int splitterWidth

table

protected com.google.gwt.user.client.ui.FlexTable table
Constructor Detail

ColumnHeader

public ColumnHeader(BoxComponent container,
                    ColumnModel cm)
Creates a new column header.

Parameters:
container - the containing component
cm - the column model
Method Detail

enableColumnResizing

public void enableColumnResizing()
Deprecated. See setEnableColumnResizing(boolean)

Enables column resizing.


getContainer

public BoxComponent getContainer()
Returns the header's container component.

Returns:
the container component

getElement

public com.google.gwt.user.client.Element getElement()
Overrides:
getElement in class Component

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()
Overrides:
isAttached in class com.google.gwt.user.client.ui.Widget

onBrowserEvent

public void onBrowserEvent(com.google.gwt.user.client.Event event)
Description copied from class: Component
Components delegate event handling to Component.onComponentEvent(ComponentEvent). Subclasses should not override.

Specified by:
onBrowserEvent in interface com.google.gwt.user.client.EventListener
Overrides:
onBrowserEvent in class Component
Parameters:
event - the dom event

refresh

public void refresh()

release

public void release()
Do not call.


setEnableColumnReorder

public void setEnableColumnReorder(boolean 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,
                      java.lang.String 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 Component

updateColumnHidden

public void updateColumnHidden(int index,
                               boolean hidden)

updateColumnWidth

public void updateColumnWidth(int column,
                              int width)

updateSortIcon

public void updateSortIcon(int colIndex,
                           Style.SortDir dir)

updateTotalWidth

public void updateTotalWidth(int offset,
                             int width)

adjustHeights

protected void adjustHeights()

cleanCells

protected void cleanCells()

createColumnEvent

protected ComponentEvent createColumnEvent(ColumnHeader header,
                                           int column,
                                           Menu menu)

createNewGroup

protected ColumnHeader.Group createNewGroup(HeaderGroupConfig config)

createNewHead

protected ColumnHeader.Head createNewHead(ColumnConfig config)

doAttachChildren

protected void doAttachChildren()
Overrides:
doAttachChildren in class Component

doDetachChildren

protected void doDetachChildren()
Overrides:
doDetachChildren in class Component

getColumnWidths

protected int getColumnWidths(int start,
                              int end)

getContextMenu

protected Menu getContextMenu(int column)

onAttach

protected void onAttach()
Overrides:
onAttach in class Component

onColumnSplitterMoved

protected void onColumnSplitterMoved(int colIndex,
                                     int width)

onDetach

protected void onDetach()
Overrides:
onDetach in class Component

onDropDownClick

protected void onDropDownClick(ComponentEvent ce,
                               int column)

onHeaderClick

protected void onHeaderClick(ComponentEvent ce,
                             int column)

onHeaderDoubleClick

protected void onHeaderDoubleClick(ComponentEvent ce,
                                   int column)

onHeaderMouseDown

protected void onHeaderMouseDown(ComponentEvent ce,
                                 int column)

onKeyDown

protected void onKeyDown(ComponentEvent ce,
                         int index)

onRender

protected void onRender(com.google.gwt.user.client.Element target,
                        int index)
Description copied from class: Component
Subclasses must override and ensure setElement is called for lazy rendered components.

Overrides:
onRender in class Component
Parameters:
target - the target element
index - the insert location

selectHeader

protected void selectHeader(int index)