com.google.gwt.user.cellview.client

Class DataGrid<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.DataGrid<T>

Type Parameters:

T - the data type of each row

All Implemented Interfaces:

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

public class DataGrid<T>
extends AbstractCellTable<T>
implements RequiresResize

A tabular view with a fixed header and footer section and a scrollable data section in the middle. This widget 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 DataGrid. 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

FieldUpdater example

Key provider example

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DataGrid.Resources A ClientBundle that provides images for this widget.
static interface	DataGrid.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>

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
DataGrid() Constructs a table with a default page size of 50.
DataGrid(int pageSize) Constructs a table with the given page size.
DataGrid(int pageSize, DataGrid.Resources resources) Constructs a table with the given page size with the specified DataGrid.Resources.
DataGrid(int pageSize, DataGrid.Resources resources, ProvidesKey<T> keyProvider) Constructs a table with the given page size, the specified DataGrid.Resources, and the given key provider.
DataGrid(int pageSize, DataGrid.Resources resources, ProvidesKey<T> keyProvider, Widget loadingIndicator) Constructs a table with the given page size, the specified DataGrid.Resources, and the given key provider.
DataGrid(int pageSize, ProvidesKey<T> keyProvider) Constructs a table with the given page size and the given key provider.
DataGrid(ProvidesKey<T> keyProvider) Constructs a table with a default page size of 50, and the given key provider.

Method Summary

Methods

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.
void	clearTableWidth() Clear the width of the tables in this widget, which causes them to fill the available width.
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.
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.
protected void	onLoadingStateChanged(LoadingStateChangeEvent.LoadingState state) Called when the loading state changes.
void	onResize() This method must be called whenever the implementor's size has been modified.
protected void	refreshColumnWidths()
void	removeColumnStyleName(int index, String styleName) Remove a style from the col element at the specified index.
void	setAlwaysShowScrollBars(boolean alwaysShowScrollBars) Sets whether this grid always shows its scroll bars, or only when necessary.
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	setMinimumTableWidth(double value, Style.Unit unit) Set the minimum width of the tables in this widget.
void	setTableWidth(double value, Style.Unit unit) Set the width of the tables in this widget.

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, 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, 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, doAttachChildren, doDetachChildren, 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

DataGrid

public DataGrid()

Constructs a table with a default page size of 50.

DataGrid

public DataGrid(int pageSize)

Constructs a table with the given page size.

Parameters:

pageSize - the page size

DataGrid

public DataGrid(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

DataGrid

public DataGrid(int pageSize,
        DataGrid.Resources resources)

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

Parameters:

pageSize - the page size

resources - the resources to use for this widget

DataGrid

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

Constructs a table with the given page size, the specified DataGrid.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

DataGrid

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

Constructs a table with the given page size, the specified DataGrid.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

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

DataGrid

public DataGrid(ProvidesKey<T> keyProvider)

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

Parameters:

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

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

clearTableWidth

public void clearTableWidth()

Clear the width of the tables in this widget, which causes them to fill the available width.

The table width is not the same as the width of this widget. If the tables are narrower than this widget, there will be a gap between the table and the edge of the widget. If the tables are wider than this widget, a horizontal scrollbar will appear so the user can scroll horizontally.

See Also:

#setMinimumTableWidth(double, Unit), #setTableWidth(double, Unit)

onResize

public void onResize()

Description copied from interface: RequiresResize

This method must be called whenever the implementor's size has been modified.

Specified by:

onResize in interface RequiresResize

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

setAlwaysShowScrollBars

public void setAlwaysShowScrollBars(boolean alwaysShowScrollBars)

Sets whether this grid always shows its scroll bars, or only when necessary.

Parameters:

alwaysShowScrollBars - true to show scroll bars at all times

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

setMinimumTableWidth

public void setMinimumTableWidth(double value,
                        Style.Unit unit)

Set the minimum width of the tables in this widget. If the widget become narrower than the minimum width, a horizontal scrollbar will appear so the user can scroll horizontally.

Note that this method is not supported in IE6 and earlier versions of IE.

Parameters:

value - the width

unit - the unit of the width

See Also:

#setTableWidth(double, Unit)

setTableWidth

public void setTableWidth(double value,
                 Style.Unit unit)

Set the width of the tables in this widget. By default, the width is not set and the tables take the available width.

The table width is not the same as the width of this widget. If the tables are narrower than this widget, there will be a gap between the table and the edge of the widget. If the tables are wider than this widget, a horizontal scrollbar will appear so the user can scroll horizontally.

If your table has many columns and you want to ensure that the columns are not truncated, you probably want to use #setMinimumTableWidth(double, Unit) instead. That will ensure that the table is wide enough, but it will still allow the table to expand to 100% if the user has a wide screen.

Note that setting the width in percentages will not work on older versions of IE because it does not account for scrollbars when calculating the width.

Parameters:

value - the width

unit - the unit of the width

See Also:

#setMinimumTableWidth(double, Unit)

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>