T
- the data type of each rowpublic class DataGrid<T> extends AbstractCellTable<T> implements RequiresResize
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
.
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.
public class CellTableExample implements EntryPoint { /** * A simple data type that represents a contact. */ private static class Contact { private final String address; private final Date birthday; private final String name; public Contact(String name, Date birthday, String address) { this.name = name; this.birthday = birthday; this.address = address; } } /** * The list of data to display. */ private static final List<Contact> CONTACTS = Arrays.asList( new Contact("John", new Date(80, 4, 12), "123 Fourth Avenue"), new Contact("Joe", new Date(85, 2, 22), "22 Lance Ln"), new Contact("George", new Date(46, 6, 6), "1600 Pennsylvania Avenue")); public void onModuleLoad() { // Create a CellTable. CellTable<Contact> table = new CellTable<Contact>(); table.setKeyboardSelectionPolicy(KeyboardSelectionPolicy.ENABLED); // Add a text column to show the name. TextColumn<Contact> nameColumn = new TextColumn<Contact>() { @Override public String getValue(Contact object) { return object.name; } }; table.addColumn(nameColumn, "Name"); // Add a date column to show the birthday. DateCell dateCell = new DateCell(); Column<Contact, Date> dateColumn = new Column<Contact, Date>(dateCell) { @Override public Date getValue(Contact object) { return object.birthday; } }; table.addColumn(dateColumn, "Birthday"); // Add a text column to show the address. TextColumn<Contact> addressColumn = new TextColumn<Contact>() { @Override public String getValue(Contact object) { return object.address; } }; table.addColumn(addressColumn, "Address"); // Add a selection model to handle user selection. final SingleSelectionModel<Contact> selectionModel = new SingleSelectionModel<Contact>(); table.setSelectionModel(selectionModel); selectionModel.addSelectionChangeHandler(new SelectionChangeEvent.Handler() { public void onSelectionChange(SelectionChangeEvent event) { Contact selected = selectionModel.getSelectedObject(); if (selected != null) { Window.alert("You selected: " + selected.name); } } }); // Set the total row count. This isn't strictly necessary, but it affects // paging calculations, so its good habit to keep the row count up to date. table.setRowCount(CONTACTS.size(), true); // Push the data into the widget. table.setRowData(0, CONTACTS); // Add it to the root panel. RootPanel.get().add(table); } }
public class CellTableFieldUpdaterExample implements EntryPoint { /** * A simple data type that represents a contact with a unique ID. */ private static class Contact { private static int nextId = 0; private final int id; private String name; public Contact(String name) { nextId++; this.id = nextId; this.name = name; } } /** * The list of data to display. */ private static final List<Contact> CONTACTS = Arrays.asList(new Contact("John"), new Contact( "Joe"), new Contact("George")); /** * The key provider that allows us to identify Contacts even if a field * changes. We identify contacts by their unique ID. */ private static final ProvidesKey<Contact> KEY_PROVIDER = new ProvidesKey<CellTableFieldUpdaterExample.Contact>() { @Override public Object getKey(Contact item) { return item.id; } }; @Override public void onModuleLoad() { // Create a CellTable with a key provider. final CellTable<Contact> table = new CellTable<Contact>(KEY_PROVIDER); // Add a text input column to edit the name. final TextInputCell nameCell = new TextInputCell(); Column<Contact, String> nameColumn = new Column<Contact, String>(nameCell) { @Override public String getValue(Contact object) { // Return the name as the value of this column. return object.name; } }; table.addColumn(nameColumn, "Name"); // Add a field updater to be notified when the user enters a new name. nameColumn.setFieldUpdater(new FieldUpdater<Contact, String>() { @Override public void update(int index, Contact object, String value) { // Inform the user of the change. Window.alert("You changed the name of " + object.name + " to " + value); // Push the changes into the Contact. At this point, you could send an // asynchronous request to the server to update the database. object.name = value; // Redraw the table with the new data. table.redraw(); } }); // Push the data into the widget. table.setRowData(CONTACTS); // Add it to the root panel. RootPanel.get().add(table); } }
public class KeyProviderExample implements EntryPoint { /** * A simple data type that represents a contact. */ private static class Contact { private static int nextId = 0; private final int id; private String name; public Contact(String name) { nextId++; this.id = nextId; this.name = name; } } /** * A custom {@link Cell} used to render a {@link Contact}. */ private static class ContactCell extends AbstractCell<Contact> { @Override public void render(Context context, Contact value, SafeHtmlBuilder sb) { if (value != null) { sb.appendEscaped(value.name); } } } /** * The list of data to display. */ private static final List<Contact> CONTACTS = Arrays.asList(new Contact( "John"), new Contact("Joe"), new Contact("Michael"), new Contact("Sarah"), new Contact("George")); public void onModuleLoad() { /* * Define a key provider for a Contact. We use the unique ID as the key, * which allows to maintain selection even if the name changes. */ ProvidesKey<Contact> keyProvider = new ProvidesKey<Contact>() { public Object getKey(Contact item) { // Always do a null check. return (item == null) ? null : item.id; } }; // Create a CellList using the keyProvider. CellList<Contact> cellList = new CellList<Contact>(new ContactCell(), keyProvider); // Push data into the CellList. cellList.setRowCount(CONTACTS.size(), true); cellList.setRowData(0, CONTACTS); // Add a selection model using the same keyProvider. SelectionModel<Contact> selectionModel = new SingleSelectionModel<Contact>( keyProvider); cellList.setSelectionModel(selectionModel); /* * Select a contact. The selectionModel will select based on the ID because * we used a keyProvider. */ Contact sarah = CONTACTS.get(3); selectionModel.setSelected(sarah, true); // Modify the name of the contact. sarah.name = "Sara"; /* * Redraw the CellList. Sarah/Sara will still be selected because we * identify her by ID. If we did not use a keyProvider, Sara would not be * selected. */ cellList.redraw(); // Add the widgets to the root panel. RootPanel.get().add(cellList); } }
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.
|
(package private) static class |
DataGrid.TableWidget
A simple widget wrapper around a table element.
|
AbstractCellTable.CellTableKeyboardSelectionHandler<T>, AbstractCellTable.TableSectionChangeHandler, AbstractCellTable.Template
AbstractHasData.DefaultKeyboardSelectionHandler<T>, AbstractHasData.RedrawEvent
UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled
HasKeyboardPagingPolicy.KeyboardPagingPolicy
HasKeyboardSelectionPolicy.KeyboardSelectionPolicy
Modifier and Type | Field and Description |
---|---|
(package private) DataGrid.TableWidget |
tableData |
(package private) DataGrid.TableWidget |
tableFooter |
(package private) DataGrid.TableWidget |
tableHeader |
isFocused
DEBUG_ID_PREFIX
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 . |
Modifier and Type | Method and Description |
---|---|
void |
addColumnStyleName(int index,
java.lang.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,
java.lang.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,
java.lang.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.
|
addColumn, addColumn, addColumn, addColumn, addColumn, addColumn, addColumn, addColumnSortHandler, addRowHoverHandler, clearColumnWidth, clearColumnWidth, convertToElements, dependsOnSelection, flush, getChildContainer, getChildElement, getColumn, getColumnCount, getColumnIndex, getColumnSortList, getColumnWidth, 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
addCellPreviewHandler, addLoadingStateChangeHandler, addRangeChangeHandler, addRedrawHandler, addRowCountChangeHandler, addValueChangeHandler, adopt, cellConsumesEventType, checkRowBounds, convertToElements, doAttach, doDetach, getAccessKey, getDisplayedItem, getDisplayedItems, getKeyboardPagingPolicy, getKeyboardSelectedRow, getKeyboardSelectionPolicy, getKeyProvider, getPageSize, getPageStart, getPresenter, getRowContainer, getRowCount, getSelectionModel, getTabIndex, getValueKey, getVisibleItem, getVisibleItemCount, getVisibleItems, getVisibleRange, isRowCountExact, isRowWithinBounds, onBrowserEvent, onUnload, redraw, redrawRow, replaceAllChildren, replaceChildren, setAccessKey, setFocus, setFocusable, setKeyboardPagingPolicy, setKeyboardSelectedRow, setKeyboardSelectionHandler, setKeyboardSelectionPolicy, setPageSize, setPageStart, setRowCount, setRowCount, setRowData, setRowData, setSelected, setSelectionModel, setSelectionModel, setTabIndex, setVisibleRange, setVisibleRange, setVisibleRangeAndClearData, showOrHide
claimElement, getWidget, initializeClaimedElement, initWidget, isAttached, onAttach, onDetach, render, render, resolvePotentialElement, setWidget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onLoad, removeFromParent, setLayoutData, sinkEvents, unsinkEvents
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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
fireEvent
final DataGrid.TableWidget tableData
final DataGrid.TableWidget tableFooter
final DataGrid.TableWidget tableHeader
public DataGrid()
public DataGrid(int pageSize)
pageSize
- the page sizepublic DataGrid(int pageSize, ProvidesKey<T> keyProvider)
key provider
.pageSize
- the page sizekeyProvider
- an instance of ProvidesKeypublic DataGrid(int pageSize, DataGrid.Resources resources)
DataGrid.Resources
.pageSize
- the page sizeresources
- the resources to use for this widgetpublic DataGrid(int pageSize, DataGrid.Resources resources, ProvidesKey<T> keyProvider)
DataGrid.Resources
, and the given key provider.pageSize
- the page sizeresources
- the resources to use for this widgetkeyProvider
- an instance of ProvidesKeypublic DataGrid(int pageSize, DataGrid.Resources resources, ProvidesKey<T> keyProvider, Widget loadingIndicator)
DataGrid.Resources
, and the given key provider.pageSize
- the page sizeresources
- the resources to use for this widgetkeyProvider
- an instance of ProvidesKeyloadingIndicator
- the widget to use as a loading indicator, or null
to disablepublic DataGrid(ProvidesKey<T> keyProvider)
key provider
.keyProvider
- an instance of ProvidesKeypublic void addColumnStyleName(int index, java.lang.String styleName)
AbstractCellTable
col
element at the specified index,
creating it if necessary.addColumnStyleName
in class AbstractCellTable<T>
index
- the column indexstyleName
- the style name to addpublic void clearTableWidth()
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.
#setMinimumTableWidth(double, Unit)
,
#setTableWidth(double, Unit)
public void onResize()
RequiresResize
onResize
in interface RequiresResize
public void removeColumnStyleName(int index, java.lang.String styleName)
AbstractCellTable
col
element at the specified index.removeColumnStyleName
in class AbstractCellTable<T>
index
- the column indexstyleName
- the style name to removepublic void setAlwaysShowScrollBars(boolean alwaysShowScrollBars)
alwaysShowScrollBars
- true
to show scroll bars at all timespublic void setEmptyTableWidget(Widget widget)
AbstractCellTable
setEmptyTableWidget
in class AbstractCellTable<T>
widget
- the empty table widget, or null to disablepublic void setLoadingIndicator(Widget widget)
AbstractCellTable
setLoadingIndicator
in class AbstractCellTable<T>
widget
- the loading indicator, or null to disablepublic void setMinimumTableWidth(double value, Style.Unit unit)
Note that this method is not supported in IE6 and earlier versions of IE.
value
- the widthunit
- the unit of the width#setTableWidth(double, Unit)
public void setTableWidth(double value, Style.Unit unit)
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.
value
- the widthunit
- the unit of the width#setMinimumTableWidth(double, Unit)
protected void doSetColumnWidth(int column, java.lang.String width)
AbstractCellTable
doSetColumnWidth
in class AbstractCellTable<T>
column
- the column indexwidth
- the width, or null to clear the widthprotected void doSetHeaderVisible(boolean isFooter, boolean isVisible)
AbstractCellTable
doSetHeaderVisible
in class AbstractCellTable<T>
isFooter
- true for the footer, false for the headerisVisible
- true to show, false to hideprotected TableSectionElement getTableBodyElement()
AbstractCellTable
getTableBodyElement
in class AbstractCellTable<T>
protected TableSectionElement getTableFootElement()
AbstractCellTable
getTableFootElement
in class AbstractCellTable<T>
protected TableSectionElement getTableHeadElement()
AbstractCellTable
getTableHeadElement
in class AbstractCellTable<T>
protected void onLoadingStateChanged(LoadingStateChangeEvent.LoadingState state)
onLoadingStateChanged
in class AbstractHasData<T>
state
- the new loading stateprotected void refreshColumnWidths()
refreshColumnWidths
in class AbstractCellTable<T>