com.google.gwt.user.cellview.client

Class CellTable<T>

java.lang.Object

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

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

com.google.gwt.user.client.ui.Composite

com.google.gwt.user.cellview.client.AbstractHasData<T>

com.google.gwt.user.cellview.client.AbstractCellTable<T>

com.google.gwt.user.cellview.client.CellTable<T>

Type Parameters:

T - the data type of each row

All Implemented Interfaces:

HasAttachHandlers, HasHandlers, AbstractCellTable.TableSectionChangeHandler, HasKeyboardPagingPolicy, HasKeyboardSelectionPolicy, EventListener, Focusable, HasVisibility, IsRenderable, IsWidget, HasCellPreviewHandlers<T>, HasData<T>, HasKeyProvider<T>, HasRows

public class CellTable<T>
extends AbstractCellTable<T>
implements AbstractCellTable.TableSectionChangeHandler

A tabular view that supports paging and columns.

Columns

The Column class defines the Cell used to render a column. Implement Column.getValue(Object) to retrieve the field value from the row object that will be rendered in the Cell.

Headers and Footers

A Header can be placed at the top (header) or bottom (footer) of the CellTable. You can specify a header as text using AbstractCellTable.addColumn(Column, String), or you can create a custom Header that can change with the value of the cells, such as a column total. The Header will be rendered every time the row data changes or the table is redrawn. If you pass the same header instance (==) into adjacent columns, the header will span the columns.

Examples

Trivial example

Handling user input with trivial FieldUpdater example

Handling user input with complex FieldUpdater example

Pushing data with List Data Provider (backed by List)

Pushing data asynchronously with Async Data Provider

Writing a custom data provider

Using a key provider to track objects as they change

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CellTable.BasicResources Resources that match the GWT standard style theme.
static interface	CellTable.Resources A ClientBundle that provides images for this widget.
static interface	CellTable.Style Styles used by this widget.

Nested classes/interfaces inherited from class com.google.gwt.user.cellview.client.AbstractCellTable

AbstractCellTable.CellTableKeyboardSelectionHandler<T>, AbstractCellTable.TableSectionChangeHandler

Nested classes/interfaces inherited from class com.google.gwt.user.cellview.client.AbstractHasData

AbstractHasData.DefaultKeyboardSelectionHandler<T>, AbstractHasData.RedrawEvent

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

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.user.cellview.client.HasKeyboardPagingPolicy

HasKeyboardPagingPolicy.KeyboardPagingPolicy

Nested classes/interfaces inherited from interface com.google.gwt.user.cellview.client.HasKeyboardSelectionPolicy

HasKeyboardSelectionPolicy.KeyboardSelectionPolicy

Field Summary

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
CellTable() Constructs a table with a default page size of 15.
CellTable(int pageSize) Constructs a table with the given page size.
CellTable(int pageSize, CellTable.Resources resources) Constructs a table with the given page size with the specified CellTable.Resources.
CellTable(int pageSize, CellTable.Resources resources, ProvidesKey<T> keyProvider) Constructs a table with the given page size, the specified CellTable.Resources, and the given key provider.
CellTable(int pageSize, CellTable.Resources resources, ProvidesKey<T> keyProvider, Widget loadingIndicator) Constructs a table with the specified page size, CellTable.Resources, key provider, and loading indicator.
CellTable(int pageSize, CellTable.Resources resources, ProvidesKey<T> keyProvider, Widget loadingIndicator, boolean enableColGroup, boolean attachLoadingPanel) Constructs a table with the specified page size, CellTable.Resources, key provider, and loading indicator.
CellTable(int pageSize, ProvidesKey<T> keyProvider) Constructs a table with the given page size and the given key provider.
CellTable(ProvidesKey<T> keyProvider) Constructs a table with a default page size of 15, and the given key provider.

Method Summary

Modifier and Type	Method and Description
void	addColumnStyleName(int index, String styleName) Add a style name to the col element at the specified index, creating it if necessary.
protected void	doAttachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call Widget.onAttach() for each of its child widgets.
protected void	doDetachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call Widget.onDetach() for each of its child widgets.
protected void	doSetColumnWidth(int column, String width) Set the width of a column.
protected void	doSetHeaderVisible(boolean isFooter, boolean isVisible) Show or hide a header section.
int	getBodyHeight() Return the height of the table body.
int	getHeaderHeight() Return the height of the table header.
protected TableSectionElement	getTableBodyElement() Get the tbody element that contains the render row values.
protected TableSectionElement	getTableFootElement() Get the tfoot element that contains the footers.
protected TableSectionElement	getTableHeadElement() Get the thead element that contains the headers.
TableSectionElement	getTableLoadingSection() Return the section that display loading indicator and the empty table widget.
protected void	onLoadingStateChanged(LoadingStateChangeEvent.LoadingState state) Called when the loading state changes.
void	onTableBodyChange(TableSectionElement newTBody) Notify that a table body section has been changed.
void	onTableFootChange(TableSectionElement newTFoot) Notify that a table body section has been changed.
void	onTableHeadChange(TableSectionElement newTHead) Notify that a table head section has been changed.
protected void	refreshColumnWidths()
void	removeColumnStyleName(int index, String styleName) Remove a style from the col element at the specified index.
void	setColumnWidth(Column<T,?> column, double width, Style.Unit unit) Set the width of a Column.
void	setColumnWidth(Column<T,?> column, String width) Set the width of a Column.
void	setEmptyTableWidget(Widget widget) Set the widget to display when the table has no rows.
void	setLoadingIndicator(Widget widget) Set the widget to display when the data is loading.
void	setRemoveColumnsOnHide(boolean removeColumnsOnHide) Configures how the colgroup is updated when a column is removed.
void	setTableLayoutFixed(boolean isFixed) Enable or disable fixed table layout.
void	setWidth(String width, boolean isFixedLayout) Set the width of the width and specify whether or not it should use fixed table layout.

Methods inherited from class com.google.gwt.user.cellview.client.AbstractCellTable

addColumn, addColumn, addColumn, addColumn, addColumn, addColumn, addColumn, addColumnSortHandler, addRowHoverHandler, clearColumnWidth, clearColumnWidth, convertToElements, dependsOnSelection, flush, getChildContainer, getChildElement, getColumn, getColumnCount, getColumnIndex, getColumnSortList, getColumnWidth, getEmptyTableWidget, getFooter, getFooterBuilder, getHeader, getHeaderBuilder, getKeyboardSelectedColumn, getKeyboardSelectedElement, getKeyboardSelectedSubRow, getLoadingIndicator, getRealColumnCount, getResources, getRowElement, getRowStyles, getSubRowElement, insertColumn, insertColumn, insertColumn, insertColumn, insertColumn, insertColumn, insertColumn, isAutoFooterRefreshDisabled, isAutoHeaderRefreshDisabled, isKeyboardNavigationSuppressed, isSkipRowHoverCheck, isSkipRowHoverFloatElementCheck, isSkipRowHoverStyleUpdate, onBlur, onBrowserEvent2, onFocus, redrawFooters, redrawHeaders, removeColumn, removeColumn, renderRowValues, renderRowValuesLegacy, replaceAllChildren, replaceChildren, resetFocusOnCell, setAutoFooterRefreshDisabled, setAutoHeaderRefreshDisabled, setColumnWidth, setColumnWidth, setFooterBuilder, setHeaderBuilder, setKeyboardSelected, setKeyboardSelectedColumn, setKeyboardSelectedColumn, setKeyboardSelectedRow, setKeyboardSelectedRow, setRowStyles, setSkipRowHoverCheck, setSkipRowHoverFloatElementCheck, setSkipRowHoverStyleUpdate, setTableBuilder

Methods inherited from class com.google.gwt.user.cellview.client.AbstractHasData

addCellPreviewHandler, addLoadingStateChangeHandler, addRangeChangeHandler, addRedrawHandler, addRowCountChangeHandler, cellConsumesEventType, checkRowBounds, getAccessKey, getDisplayedItem, getDisplayedItems, getKeyboardPagingPolicy, getKeyboardSelectedRow, getKeyboardSelectionPolicy, getKeyProvider, getPageSize, getPageStart, getRowContainer, getRowCount, getSelectionModel, getTabIndex, getValueKey, getVisibleItem, getVisibleItemCount, getVisibleItems, getVisibleRange, isRowCountExact, isRowWithinBounds, onBrowserEvent, onUnload, redraw, redrawRow, setAccessKey, setFocus, setFocusable, setKeyboardPagingPolicy, setKeyboardSelectedRow, setKeyboardSelectionHandler, setKeyboardSelectionPolicy, setPageSize, setPageStart, setRowCount, setRowCount, setRowData, setRowData, setSelected, setSelectionModel, setSelectionModel, setTabIndex, setVisibleRange, setVisibleRange, setVisibleRangeAndClearData

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

claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, onAttach, onDetach, render, render, resolvePotentialElement, setWidget

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onLoad, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

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

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Constructor Detail

CellTable

public CellTable()

Constructs a table with a default page size of 15.

CellTable

public CellTable(int pageSize)

Constructs a table with the given page size.

Parameters:

pageSize - the page size

CellTable

public CellTable(ProvidesKey<T> keyProvider)

Constructs a table with a default page size of 15, and the given key provider.

Parameters:

keyProvider - an instance of ProvidesKey, or null if the record object should act as its own key

CellTable

public CellTable(int pageSize,
                 CellTable.Resources resources)

Constructs a table with the given page size with the specified CellTable.Resources.

Parameters:

pageSize - the page size

resources - the resources to use for this widget

CellTable

public CellTable(int pageSize,
                 ProvidesKey<T> keyProvider)

Constructs a table with the given page size and the given key provider.

Parameters:

pageSize - the page size

keyProvider - an instance of ProvidesKey, or null if the record object should act as its own key

CellTable

public CellTable(int pageSize,
                 CellTable.Resources resources,
                 ProvidesKey<T> keyProvider)

Constructs a table with the given page size, the specified CellTable.Resources, and the given key provider.

Parameters:

pageSize - the page size

resources - the resources to use for this widget

keyProvider - an instance of ProvidesKey, or null if the record object should act as its own key

CellTable

public CellTable(int pageSize,
                 CellTable.Resources resources,
                 ProvidesKey<T> keyProvider,
                 Widget loadingIndicator)

Constructs a table with the specified page size, CellTable.Resources, key provider, and loading indicator.

Parameters:

pageSize - the page size

resources - the resources to use for this widget

keyProvider - an instance of ProvidesKey, or null if the record object should act as its own key

loadingIndicator - the widget to use as a loading indicator, or null to disable

CellTable

public CellTable(int pageSize,
                 CellTable.Resources resources,
                 ProvidesKey<T> keyProvider,
                 Widget loadingIndicator,
                 boolean enableColGroup,
                 boolean attachLoadingPanel)

Constructs a table with the specified page size, CellTable.Resources, key provider, and loading indicator.

Parameters:

pageSize - the page size

resources - the resources to use for this widget

keyProvider - an instance of ProvidesKey, or null if the record object should act as its own key

loadingIndicator - the widget to use as a loading indicator, or null to disable

enableColGroup - enable colgroup element. This is used when the table is using fixed layout and when column style is added. Ignoring this element will boost rendering performance. Note that when colgroup is disabled, setColumnWidth(com.google.gwt.user.cellview.client.Column<T, ?>, java.lang.String), setTableLayoutFixed and addColumnStyleName are no longer supported

attachLoadingPanel - attaching the table section that contains the empty table widget and the loading indicator. Attaching this to the table significantly improve the rendering performance in webkit based browsers but also introduces significantly larger latency in IE. If the panel is not attached to the table, it won't be displayed. But the user can call getTableLoadingSection() and attach it to other elements outside the table element

Method Detail

addColumnStyleName

public void addColumnStyleName(int index,
                               String styleName)

Description copied from class: AbstractCellTable

Add a style name to the col element at the specified index, creating it if necessary.

Specified by:

addColumnStyleName in class AbstractCellTable<T>

Parameters:

index - the column index

styleName - the style name to add

getBodyHeight

public int getBodyHeight()

Return the height of the table body.

Returns:

an int representing the body height

getHeaderHeight

public int getHeaderHeight()

Return the height of the table header.

Returns:

an int representing the header height

getTableLoadingSection

public TableSectionElement getTableLoadingSection()

Return the section that display loading indicator and the empty table widget. If attachLoadingPanel is set to false in the constructor, this section may not be attached to any element.

onTableBodyChange

public void onTableBodyChange(TableSectionElement newTBody)

Description copied from interface: AbstractCellTable.TableSectionChangeHandler

Notify that a table body section has been changed.

Specified by:

onTableBodyChange in interface AbstractCellTable.TableSectionChangeHandler

Parameters:

newTBody - the new body section

onTableFootChange

public void onTableFootChange(TableSectionElement newTFoot)

Description copied from interface: AbstractCellTable.TableSectionChangeHandler

Notify that a table body section has been changed.

Specified by:

onTableFootChange in interface AbstractCellTable.TableSectionChangeHandler

Parameters:

newTFoot - the new foot section

onTableHeadChange

public void onTableHeadChange(TableSectionElement newTHead)

Description copied from interface: AbstractCellTable.TableSectionChangeHandler

Notify that a table head section has been changed.

Specified by:

onTableHeadChange in interface AbstractCellTable.TableSectionChangeHandler

Parameters:

newTHead - the new head section

removeColumnStyleName

public void removeColumnStyleName(int index,
                                  String styleName)

Description copied from class: AbstractCellTable

Remove a style from the col element at the specified index.

Specified by:

removeColumnStyleName in class AbstractCellTable<T>

Parameters:

index - the column index

styleName - the style name to remove

setColumnWidth

public void setColumnWidth(Column<T,?> column,
                           String width)

Set the width of a Column. The width will persist with the column and takes precedence of any width set via AbstractCellTable.setColumnWidth(int, String).

The layout behavior depends on whether or not the table is using fixed layout.

Overrides:

setColumnWidth in class AbstractCellTable<T>

Parameters:

column - the column

width - the width of the column

See Also:

setTableLayoutFixed(boolean)

setColumnWidth

public void setColumnWidth(Column<T,?> column,
                           double width,
                           Style.Unit unit)

Set the width of a Column. The width will persist with the column and takes precedence of any width set via #setColumnWidth(int, double, Unit).

The layout behavior depends on whether or not the table is using fixed layout.

Overrides:

setColumnWidth in class AbstractCellTable<T>

Parameters:

column - the column

width - the width of the column

unit - the Style.Unit of measurement

See Also:

setTableLayoutFixed(boolean)

setEmptyTableWidget

public void setEmptyTableWidget(Widget widget)

Description copied from class: AbstractCellTable

Set the widget to display when the table has no rows.

Overrides:

setEmptyTableWidget in class AbstractCellTable<T>

Parameters:

widget - the empty table widget, or null to disable

setLoadingIndicator

public void setLoadingIndicator(Widget widget)

Description copied from class: AbstractCellTable

Set the widget to display when the data is loading.

Overrides:

setLoadingIndicator in class AbstractCellTable<T>

Parameters:

widget - the loading indicator, or null to disable

setTableLayoutFixed

public void setTableLayoutFixed(boolean isFixed)

Enable or disable fixed table layout.

Fixed Table Layout

When using the fixed table layout, cell contents are truncated as needed, which allows you to set the exact width of columns and the table. The default column width is 0 (invisible). In order to see all columns, you must set the width of the table (recommended 100%), or set the width of every column in the table. The following conditions are true for fixed layout tables:

• If the widths of all columns are set, the width becomes a weight and the columns are resized proportionally.
• If the widths of some columns are set using absolute values (PX), those columns are fixed and the remaining width is divided evenly over the other columns. If there is no remaining width, the other columns will not be visible.
• If the width of some columns are set in absolute values (PX) and others are set in relative values (PCT), the absolute columns will be fixed and the remaining width is divided proportionally over the PCT columns. This allows users to define how the remaining width is allocated.

Parameters:

isFixed - true to use fixed table layout, false not to

See Also:

W3C HTML Specification

setWidth

public final void setWidth(String width,
                           boolean isFixedLayout)

Set the width of the width and specify whether or not it should use fixed table layout. See setTableLayoutFixed(boolean) for more information about fixed layout tables.

Parameters:

width - the width of the table

isFixedLayout - true to use fixed width layout, false not to

See Also:

setTableLayoutFixed(boolean), W3C HTML Specification

setRemoveColumnsOnHide

public void setRemoveColumnsOnHide(boolean removeColumnsOnHide)

Configures how the colgroup is updated when a column is removed. If true, removing a column will also remove the corresponding col element from the colgroup. If false, removing a column will leave the col element on the colgroup and set it to zero width and display hidden.

For legacy reasons, the default is false even though it is known to cause some column sizing issues in Firefox.

doSetColumnWidth

protected void doSetColumnWidth(int column,
                                String width)

Description copied from class: AbstractCellTable

Set the width of a column.

Specified by:

doSetColumnWidth in class AbstractCellTable<T>

Parameters:

column - the column index

width - the width, or null to clear the width

doSetHeaderVisible

protected void doSetHeaderVisible(boolean isFooter,
                                  boolean isVisible)

Description copied from class: AbstractCellTable

Show or hide a header section.

Specified by:

doSetHeaderVisible in class AbstractCellTable<T>

Parameters:

isFooter - true for the footer, false for the header

isVisible - true to show, false to hide

getTableBodyElement

protected TableSectionElement getTableBodyElement()

Description copied from class: AbstractCellTable

Get the tbody element that contains the render row values.

Specified by:

getTableBodyElement in class AbstractCellTable<T>

getTableFootElement

protected TableSectionElement getTableFootElement()

Description copied from class: AbstractCellTable

Get the tfoot element that contains the footers.

Specified by:

getTableFootElement in class AbstractCellTable<T>

getTableHeadElement

protected TableSectionElement getTableHeadElement()

Description copied from class: AbstractCellTable

Get the thead element that contains the headers.

Specified by:

getTableHeadElement in class AbstractCellTable<T>

onLoadingStateChanged

protected void onLoadingStateChanged(LoadingStateChangeEvent.LoadingState state)

Called when the loading state changes.

Overrides:

onLoadingStateChanged in class AbstractHasData<T>

Parameters:

state - the new loading state

refreshColumnWidths

protected void refreshColumnWidths()

Overrides:

refreshColumnWidths in class AbstractCellTable<T>

doAttachChildren

protected void doAttachChildren()

Description copied from class: Widget

If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call Widget.onAttach() for each of its child widgets.

Overrides:

doAttachChildren in class Widget

See Also:

Widget.onAttach()

doDetachChildren

protected void doDetachChildren()

Description copied from class: Widget

If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call Widget.onDetach() for each of its child widgets.

Overrides:

doDetachChildren in class Widget

See Also:

Widget.onDetach()