com.google.gwt.user.cellview.client

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

Type Parameters:

T - the data type of list items

All Implemented Interfaces:

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

public class CellList<T>
extends AbstractHasData<T>

A single column list of cells.

Examples

Trivial example

Handling user input with ValueUpdater

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	CellList.Resources A ClientBundle that provides images for this widget.
static interface	CellList.Style Styles used by this widget.

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
CellList(Cell<T> cell) Construct a new CellList.
CellList(Cell<T> cell, CellList.Resources resources) Construct a new CellList with the specified CellList.Resources.
CellList(Cell<T> cell, CellList.Resources resources, ProvidesKey<T> keyProvider) Construct a new CellList with the specified CellList.Resources and key provider.
CellList(Cell<T> cell, ProvidesKey<T> keyProvider) Construct a new CellList with the specified key provider.

Method Summary

Modifier and Type	Method and Description
protected boolean	dependsOnSelection() Check whether or not the cells in the view depend on the selection state.
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	fireEventToCell(Cell.Context context, Event event, Element parent, T value) Fire an event to the cell.
protected Cell<T>	getCell() Return the cell used to render each item.
protected Element	getCellParent(Element item) Get the parent element that wraps the cell from the list item.
protected Element	getChildContainer() Return the element that holds the rendered cells.
SafeHtml	getEmptyListMessage() Deprecated. as of GWT 2.3, use getEmptyListWidget() instead
Widget	getEmptyListWidget() Get the widget displayed when the list has no rows.
protected Element	getKeyboardSelectedElement() Get the element that has keyboard selection.
Widget	getLoadingIndicator() Get the widget displayed when the data is loading.
Element	getRowElement(int indexOnPage) Get the Element for the specified index.
protected boolean	isKeyboardNavigationSuppressed() Check if keyboard navigation is being suppressed, such as when the user is editing a cell.
protected void	onBrowserEvent2(Event event) Called after AbstractHasData.onBrowserEvent(Event) completes.
protected void	onLoadingStateChanged(LoadingStateChangeEvent.LoadingState state) Called when the loading state changes.
protected void	renderRowValues(SafeHtmlBuilder sb, List<T> values, int start, SelectionModel<? super T> selectionModel) Render all row values into the specified SafeHtmlBuilder.
protected boolean	resetFocusOnCell() Reset focus on the currently focused cell.
void	setEmptyListMessage(SafeHtml html) Deprecated. as of GWT 2.3, use setEmptyListWidget(com.google.gwt.user.client.ui.Widget) instead
void	setEmptyListWidget(Widget widget) Set the widget to display when the list has no rows.
protected void	setKeyboardSelected(int index, boolean selected, boolean stealFocus) Update an element to reflect its keyboard selected state.
void	setLoadingIndicator(Widget widget) Set the widget to display when the data is loading.
protected void	setSelected(Element elem, boolean selected) Deprecated. this method is never called by AbstractHasData, render the selected styles in renderRowValues(SafeHtmlBuilder, List, int, SelectionModel)
void	setValueUpdater(ValueUpdater<T> valueUpdater) Set the value updater to use when cells modify items.

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

addCellPreviewHandler, addLoadingStateChangeHandler, addRangeChangeHandler, addRedrawHandler, addRowCountChangeHandler, cellConsumesEventType, checkRowBounds, convertToElements, getAccessKey, getChildElement, getDisplayedItem, getDisplayedItems, getKeyboardPagingPolicy, getKeyboardSelectedRow, getKeyboardSelectionPolicy, getKeyProvider, getPageSize, getPageStart, getRowContainer, getRowCount, getSelectionModel, getTabIndex, getValueKey, getVisibleItem, getVisibleItemCount, getVisibleItems, getVisibleRange, isRowCountExact, isRowWithinBounds, onBlur, onBrowserEvent, onFocus, onUnload, redraw, redrawRow, replaceAllChildren, replaceChildren, setAccessKey, setFocus, setFocusable, setKeyboardPagingPolicy, setKeyboardSelectedRow, setKeyboardSelectedRow, setKeyboardSelectionHandler, setKeyboardSelectionPolicy, setPageSize, setPageStart, setRowCount, setRowCount, setRowData, setRowData, 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

CellList

public CellList(Cell<T> cell)

Construct a new CellList.

Parameters:

cell - the cell used to render each item

CellList

public CellList(Cell<T> cell,
                CellList.Resources resources)

Construct a new CellList with the specified CellList.Resources.

Parameters:

cell - the cell used to render each item

resources - the resources used for this widget

CellList

public CellList(Cell<T> cell,
                ProvidesKey<T> keyProvider)

Construct a new CellList with the specified key provider.

Parameters:

cell - the cell used to render each item

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

CellList

public CellList(Cell<T> cell,
                CellList.Resources resources,
                ProvidesKey<T> keyProvider)

Construct a new CellList with the specified CellList.Resources and key provider.

Parameters:

cell - the cell used to render each item

resources - the resources used for this widget

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

Method Detail

getEmptyListMessage

@Deprecated
public SafeHtml getEmptyListMessage()

Deprecated. as of GWT 2.3, use getEmptyListWidget() instead

Get the message that is displayed when there is no data.

Returns:

the empty message

See Also:

setEmptyListMessage(SafeHtml)

getEmptyListWidget

public Widget getEmptyListWidget()

Get the widget displayed when the list has no rows.

Returns:

the empty list widget

getLoadingIndicator

public Widget getLoadingIndicator()

Get the widget displayed when the data is loading.

Returns:

the loading indicator

getRowElement

public Element getRowElement(int indexOnPage)

Get the Element for the specified index. If the element has not been created, null is returned.

Parameters:

indexOnPage - the index on the page

Returns:

the element, or null if it doesn't exists

Throws:

IndexOutOfBoundsException - if the index is outside of the current page

setEmptyListMessage

@Deprecated
public void setEmptyListMessage(SafeHtml html)

Deprecated. as of GWT 2.3, use setEmptyListWidget(com.google.gwt.user.client.ui.Widget) instead

Set the message to display when there is no data.

Parameters:

html - the message to display when there are no results

See Also:

getEmptyListMessage()

setEmptyListWidget

public void setEmptyListWidget(Widget widget)

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

Parameters:

widget - the empty data widget

setLoadingIndicator

public void setLoadingIndicator(Widget widget)

Set the widget to display when the data is loading.

Parameters:

widget - the loading indicator

setValueUpdater

public void setValueUpdater(ValueUpdater<T> valueUpdater)

Set the value updater to use when cells modify items.

Parameters:

valueUpdater - the ValueUpdater

dependsOnSelection

protected boolean dependsOnSelection()

Description copied from class: AbstractHasData

Check whether or not the cells in the view depend on the selection state.

Specified by:

dependsOnSelection in class AbstractHasData<T>

Returns:

true if cells depend on selection, false if not

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()

fireEventToCell

protected void fireEventToCell(Cell.Context context,
                               Event event,
                               Element parent,
                               T value)

Fire an event to the cell.

Parameters:

context - the Cell.Context of the cell

event - the event that was fired

parent - the parent of the cell

value - the value of the cell

getCell

protected Cell<T> getCell()

Return the cell used to render each item.

getCellParent

protected Element getCellParent(Element item)

Get the parent element that wraps the cell from the list item. Override this method if you add structure to the element.

Parameters:

item - the row element that wraps the list item

Returns:

the parent element of the cell

getChildContainer

protected Element getChildContainer()

Description copied from class: AbstractHasData

Return the element that holds the rendered cells.

Specified by:

getChildContainer in class AbstractHasData<T>

Returns:

the container Element

getKeyboardSelectedElement

protected Element getKeyboardSelectedElement()

Description copied from class: AbstractHasData

Get the element that has keyboard selection.

Specified by:

getKeyboardSelectedElement in class AbstractHasData<T>

Returns:

the keyboard selected element

isKeyboardNavigationSuppressed

protected boolean isKeyboardNavigationSuppressed()

Description copied from class: AbstractHasData

Check if keyboard navigation is being suppressed, such as when the user is editing a cell.

Specified by:

isKeyboardNavigationSuppressed in class AbstractHasData<T>

Returns:

true if suppressed, false if not

onBrowserEvent2

protected void onBrowserEvent2(Event event)

Description copied from class: AbstractHasData

Called after AbstractHasData.onBrowserEvent(Event) completes.

Overrides:

onBrowserEvent2 in class AbstractHasData<T>

Parameters:

event - the event that was fired

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

renderRowValues

protected void renderRowValues(SafeHtmlBuilder sb,
                               List<T> values,
                               int start,
                               SelectionModel<? super T> selectionModel)

Description copied from class: AbstractHasData

Render all row values into the specified SafeHtmlBuilder.

Subclasses can optionally throw an UnsupportedOperationException if they prefer to render the rows in AbstractHasData.replaceAllChildren(List, SafeHtml) and AbstractHasData.replaceChildren(List, int, SafeHtml). In this case, the SafeHtml argument will be null. Though a bit hacky, this is designed to supported legacy widgets that use SafeHtmlBuilder, and newer widgets that use other builders, such as the ElementBuilder API.

Specified by:

renderRowValues in class AbstractHasData<T>

Parameters:

sb - the SafeHtmlBuilder to render into

values - the row values

start - the absolute start index of the values

selectionModel - the SelectionModel

resetFocusOnCell

protected boolean resetFocusOnCell()

Description copied from class: AbstractHasData

Reset focus on the currently focused cell.

Specified by:

resetFocusOnCell in class AbstractHasData<T>

Returns:

true if focus is taken, false if not

setKeyboardSelected

protected void setKeyboardSelected(int index,
                                   boolean selected,
                                   boolean stealFocus)

Description copied from class: AbstractHasData

Update an element to reflect its keyboard selected state.

Specified by:

setKeyboardSelected in class AbstractHasData<T>

Parameters:

index - the index of the element

selected - true if selected, false if not

stealFocus - true if the row should steal focus, false if not

setSelected

@Deprecated
protected void setSelected(Element elem,
                                       boolean selected)

Deprecated. this method is never called by AbstractHasData, render the selected styles in renderRowValues(SafeHtmlBuilder, List, int, SelectionModel)

Description copied from class: AbstractHasData

Update an element to reflect its selected state.

Overrides:

setSelected in class AbstractHasData<T>

Parameters:

elem - the element to update

selected - true if selected, false if not