com.extjs.gxt.ui.client.widget.treetable
Class TreeTable

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.extjs.gxt.ui.client.widget.Component
              com.extjs.gxt.ui.client.widget.BoxComponent
                  com.extjs.gxt.ui.client.widget.Container<TreeItem>
                      com.extjs.gxt.ui.client.widget.tree.Tree
                          com.extjs.gxt.ui.client.widget.treetable.TreeTable

All Implemented Interfaces:

Observable, Selectable<TreeItem>, BaseTable, com.google.gwt.user.client.EventListener

public class TreeTable
extends Tree
implements BaseTable

A hierarchical tree widget with support for additional columns. The tree contains a hierarchy of TreeTableItems that the user can open, close, and select.

Events:

CellClick : TreeTableEvent(treeTable, item, index)

Fires after a cell has been clicked.

• treeTable : tree table
• item : item represented by the cell
• index : cell column index

CellDoubleClick : TreeTableEvent(treeTable, item, index)

Fires after a cell has been double clicked.

• treeTable : tree table
• item : item represented by the cell
• index : cell column index

RowClick : TreeTableEvent(treeTable, item, index)

Fires after a cell has been clicked.

• treeTable : tree table
• item : item that represents the row
• index : cell column index

RowDoubleClick : TreeTableEvent(treeTable, item, index)

Fires after a cell has been double clicked.

• treeTable : tree table
• item : item that represents the row
• index : cell column index

Nested Class Summary

Nested classes/interfaces inherited from class com.extjs.gxt.ui.client.widget.tree.Tree

Tree.CheckCascade, Tree.CheckNodes

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

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

DEBUG_ID_PREFIX

Constructor Summary

TreeTable()
Creates a new single select tree table.

TreeTable(TreeTableColumnModel cm)
Creates a new tree table with the given column model.

Method Summary

TableColumn	getColumn(int index) Returns the column at the specified index.
TableColumn	getColumn(java.lang.String id) Returns the column with the given id.
boolean	getColumnContextMenu() Returns the column context menu enabed state.
int	getColumnCount() Returns the number of columns contained in the table.
TableColumnModel	getColumnModel() Returns the table's column model.
boolean	getHorizontalScroll() Returns true if horizontal scrolling is enabled
TableHeader	getTableHeader() Returns the tree table's header.
void	onBrowserEvent(com.google.gwt.user.client.Event event) Components delegate event handling to Component.onComponentEvent(ComponentEvent).
void	recalculate() Called when the component is in a LayoutContainer and the container's layout executes.
void	scrollIntoView(TreeTableItem item) Scrolls the item into view.
void	setColumnContextMenu(boolean columnContextMenu) Sets whether the table header context menu is displayed (defaults to true).
void	setHorizontalScroll(boolean horizontalScroll) True to display a horizonatal scroll bar when needed (defaults to true).
void	setTableHeader(TreeTableHeader header) Sets the tree table's header.
void	setView(TreeTableView view) Sets the tree table's view.
void	sort(int index, Style.SortDir direction) Sorts the tree table using the specified column index.

Methods inherited from class com.extjs.gxt.ui.client.widget.tree.Tree

collapseAll, expandAll, expandPath, findItem, getAllItems, getAnimate, getCheckable, getChecked, getCheckNodes, getCheckStyle, getContextMenu, getIndentWidth, getItem, getItemById, getItemIconStyle, getNodeIconStyle, getOpenNodeIconStyle, getRootItem, getSelectedItem, getSelectedItems, getSelectionMode, getSelectionModel, onComponentEvent, onSelectChange, removeAll, setAnimate, setCheckable, setCheckNodes, setCheckStyle, setContextMenu, setIndentWidth, setItemIconStyle, setNodeIconStyle, setOpenNodeIconStyle, setSelectedItem, setSelectedItems, setSelectionMode, setSelectionModel

Methods inherited from class com.extjs.gxt.ui.client.widget.Container

getItemByItemId, getItemCount, getItems, getWidget, indexOf, iterator, scrollIntoView

Methods inherited from class com.extjs.gxt.ui.client.widget.BoxComponent

getBounds, getHeight, getHeight, getPosition, getShadow, getSize, getWidth, getWidth, isAutoHeight, isAutoWidth, isDeferHeight, isShim, setAutoHeight, setAutoWidth, setBounds, setBounds, setDeferHeight, setHeight, setHeight, setPagePosition, setPagePosition, setPixelSize, setPosition, setShadow, setShim, setSize, setSize, setWidth, setWidth

Methods inherited from class com.extjs.gxt.ui.client.widget.Component

addListener, addStyleName, addWidgetListener, disable, disableEvents, disableTextSelection, el, enable, enableEvents, fireEvent, fireEvent, fireEvent, fly, focus, getBaseStyle, getBorders, getData, getData, getElement, getId, getItemId, getModel, getState, getToolTip, hide, hideToolTip, isEnabled, isRendered, isVisible, removeAllListeners, removeFromParent, removeListener, removeStyleName, removeWidgetListener, render, render, saveState, setBorders, setData, setData, setElement, setEnabled, setEnableState, setId, setIntStyleAttribute, setItemId, setStyleAttribute, setStyleName, setTitle, setToolTip, setToolTip, setVisible, show, toString

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

getParent, isAttached

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

addStyleDependentName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, setStylePrimaryName, setVisible, sinkEvents, unsinkEvents

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeTable

public TreeTable()

Creates a new single select tree table. A column model must be set before the table is rendered.

TreeTable

public TreeTable(TreeTableColumnModel cm)

Creates a new tree table with the given column model.

Parameters:

cm - the tree table column model

Method Detail

setColumnContextMenu

public void setColumnContextMenu(boolean columnContextMenu)

Sets whether the table header context menu is displayed (defaults to true).

Parameters:

columnContextMenu - the column context menu sate

getColumnContextMenu

public boolean getColumnContextMenu()

Returns the column context menu enabed state.

Specified by:

getColumnContextMenu in interface BaseTable

Returns:

true if enabled, false otherwise.

getColumn

public TableColumn getColumn(int index)

Returns the column at the specified index.

Specified by:

getColumn in interface BaseTable

Parameters:

index - the column index

Returns:

the column

getColumn

public TableColumn getColumn(java.lang.String id)

Returns the column with the given id.

Parameters:

id - the column id

Returns:

the column

getColumnCount

public int getColumnCount()

Returns the number of columns contained in the table.

Returns:

the number of columns

getColumnModel

public TableColumnModel getColumnModel()

Returns the table's column model.

Specified by:

getColumnModel in interface BaseTable

Returns:

the column model

getHorizontalScroll

public boolean getHorizontalScroll()

Returns true if horizontal scrolling is enabled

Returns:

the horizontal scroll state

getTableHeader

public TableHeader getTableHeader()

Returns the tree table's header.

Specified by:

getTableHeader in interface BaseTable

Returns:

the table header

onBrowserEvent

public void onBrowserEvent(com.google.gwt.user.client.Event event)

Description copied from class: Component

Components delegate event handling to Component.onComponentEvent(ComponentEvent). Sublcasses should not override.

Specified by:

onBrowserEvent in interface com.google.gwt.user.client.EventListener

Overrides:

onBrowserEvent in class Component

Parameters:

event - the dom event

recalculate

public void recalculate()

Description copied from class: Component

Called when the component is in a LayoutContainer and the container's layout executes. This method will not be called on container instances. Default implementation does nothing.

Overrides:

recalculate in class Component

scrollIntoView

public void scrollIntoView(TreeTableItem item)

Scrolls the item into view.

Parameters:

item - the item

setHorizontalScroll

public void setHorizontalScroll(boolean horizontalScroll)

True to display a horizonatal scroll bar when needed (defaults to true).

Parameters:

horizontalScroll - the horizontal scroll state

setTableHeader

public void setTableHeader(TreeTableHeader header)

Sets the tree table's header. Should only be called when providing a custom tree table header. Has no effect if called after the table has been rendered.

Parameters:

header - the table header

setView

public void setView(TreeTableView view)

Sets the tree table's view. Provides a way to provide specialized views. table views.

Parameters:

view - the view

sort

public void sort(int index,
                 Style.SortDir direction)

Sorts the tree table using the specified column index.

Specified by:

sort in interface BaseTable

Parameters:

index - the column index

direction - the direction to sort (NONE, ASC, DESC)