public class

CellList

extends AbstractHasData<T>

java.lang.Object
↳	com.google.gwt.user.client.ui.UIObject
	↳	com.google.gwt.user.client.ui.Widget
		↳	com.google.gwt.user.cellview.client.AbstractHasData<T>
			↳	com.google.gwt.user.cellview.client.CellList<T>

Class Overview

A single column list of cells.

Examples

Trivial example: {@example com.google.gwt.examples.cellview.CellListExample}
ValueUpdater example: {@example com.google.gwt.examples.cellview.CellListValueUpdaterExample}
Key provider example: {@example com.google.gwt.examples.view.KeyProviderExample}

Summary

Nested Classes
interface	CellList.Resources	A ClientBundle that provides images for this widget.
interface	CellList.Style	Styles used by this widget.

[Expand]

Inherited Constants

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

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

Public Methods
SafeHtml	getEmptyListMessage() Get the message that is displayed when there is no data.
Element	getRowElement(int indexOnPage) Get the `Element` for the specified index.
void	setEmptyListMessage(SafeHtml html) Set the message to display when there is no data.
void	setValueUpdater(ValueUpdater<T> valueUpdater) Set the value updater to use when cells modify items.

Protected Methods
boolean	dependsOnSelection() Check whether or not the cells in the view depend on the selection state.
void	doSelection(Event event, T value, int indexOnPage) This method is deprecated. use `addCellPreviewHandler(com.google.gwt.view.client.CellPreviewEvent.Handler)` instead
void	fireEventToCell(Cell.Context context, Event event, Element parent, T value) Fire an event to the cell.
Cell<T>	getCell() Return the cell used to render each item.
Element	getCellParent(Element item) Get the parent element that wraps the cell from the list item.
Element	getChildContainer() Return the element that holds the rendered cells.
Element	getKeyboardSelectedElement() Get the element that has keyboard selection.
boolean	isKeyboardNavigationSuppressed() Check if keyboard navigation is being suppressed, such as when the user is editing a cell.
void	onBlur() Called when the widget is blurred.
void	onBrowserEvent2(Event event) Called after `onBrowserEvent(Event)` completes.
void	onFocus() Called when the widget is focused.
void	renderRowValues(SafeHtmlBuilder sb, List<T> values, int start, SelectionModel<? super T> selectionModel) Render all row values into the specified `SafeHtmlBuilder`.
boolean	resetFocusOnCell() Reset focus on the currently focused cell.
void	setKeyboardSelected(int index, boolean selected, boolean stealFocus) Update an element to reflect its keyboard selected state.
void	setSelected(Element elem, boolean selected) This method is deprecated. this method is never called by AbstractHasData, render the selected styles in `renderRowValues(SafeHtmlBuilder, List, int, SelectionModel)`

[Expand]

Inherited Methods

From class com.google.gwt.user.cellview.client.AbstractHasData

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

HandlerRegistration	addAttachHandler(AttachEvent.Handler handler) Adds an `AttachEvent` handler.
final <H extends EventHandler> HandlerRegistration	addDomHandler(H handler, Type<H> type) Adds a native event handler to the widget and sinks the corresponding native event.
final <H extends EventHandler> HandlerRegistration	addHandler(H handler, Type<H> type) Adds this handler to the widget.
Widget	asWidget() Returns the `Widget` aspect of the receiver.
static Widget	asWidgetOrNull(IsWidget w) This convenience method makes a null-safe call to `asWidget()`.
HandlerManager	createHandlerManager() Creates the `HandlerManager` used by this Widget.
void	delegateEvent(Widget target, GwtEvent<?> event) Fires an event on a child widget.
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 `onAttach()` for each of its child widgets.
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 `onDetach()` for each of its child widgets.
void	fireEvent(GwtEvent<?> event) Fires the given event to the handlers listening to the event's type.
int	getHandlerCount(Type<?> type) Gets the number of handlers listening to the event type.
Object	getLayoutData() Gets the panel-defined layout data associated with this widget.
Widget	getParent() Gets this widget's parent panel.
boolean	isAttached() Determines whether this widget is currently attached to the browser's document (i.e., there is an unbroken chain of widgets between this widget and the underlying browser document).
final boolean	isOrWasAttached() Has this widget ever been attached?
void	onAttach() This method is called when a widget is attached to the browser's document.
void	onBrowserEvent(Event event) Fired whenever a browser event is received.
void	onDetach() This method is called when a widget is detached from the browser's document.
void	onLoad() This method is called immediately after a widget becomes attached to the browser's document.
void	onUnload() This method is called immediately before a widget will be detached from the browser's document.
void	removeFromParent() Removes this widget from its parent widget, if one exists.
void	setLayoutData(Object layoutData) Sets the panel-defined layout data associated with this widget.
void	sinkEvents(int eventBitsToAdd) Overridden to defer the call to super.sinkEvents until the first time this widget is attached to the dom, as a performance enhancement.

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

void	addStyleDependentName(String styleSuffix) Adds a dependent style name by specifying the style name's suffix.
void	addStyleName(String style) Adds a secondary or dependent style name to this object.
static void	ensureDebugId(Element elem, String baseID, String id) Set the debug id of a specific element.
final void	ensureDebugId(String id) Ensure that the main `Element` for this `UIObject` has an ID property set, which allows it to integrate with third-party libraries and test tools.
static void	ensureDebugId(Element elem, String id) Ensure that elem has an ID property set, which allows it to integrate with third-party libraries and test tools.
int	getAbsoluteLeft() Gets the object's absolute left position in pixels, as measured from the browser window's client area.
int	getAbsoluteTop() Gets the object's absolute top position in pixels, as measured from the browser window's client area.
Element	getElement() Gets a handle to the object's underlying DOM element.
int	getOffsetHeight() Gets the object's offset height in pixels.
int	getOffsetWidth() Gets the object's offset width in pixels.
Element	getStyleElement() Template method that returns the element to which style names will be applied.
String	getStyleName() Gets all of the object's style names, as a space-separated list.
static String	getStyleName(Element elem) Gets all of the element's style names, as a space-separated list.
String	getStylePrimaryName() Gets the primary style name associated with the object.
static String	getStylePrimaryName(Element elem) Gets the element's primary style name.
String	getTitle() Gets the title associated with this object.
boolean	isVisible() Determines whether or not this object is visible.
static boolean	isVisible(Element elem)
void	onEnsureDebugId(String baseID) Called when the user sets the id using the `ensureDebugId(String)` method.
void	removeStyleDependentName(String styleSuffix) Removes a dependent style name by specifying the style name's suffix.
void	removeStyleName(String style) Removes a style name.
final void	setElement(Element elem) Sets this object's browser element.
void	setElement(Element elem) Sets this object's browser element.
void	setHeight(String height) Sets the object's height.
void	setPixelSize(int width, int height) Sets the object's size, in pixels, not including decorations such as border, margin, and padding.
void	setSize(String width, String height) Sets the object's size.
void	setStyleDependentName(String styleSuffix, boolean add) Adds or removes a dependent style name by specifying the style name's suffix.
static void	setStyleName(Element elem, String styleName) Clears all of the element's style names and sets it to the given style.
static void	setStyleName(Element elem, String style, boolean add) This convenience method adds or removes a style name for a given element.
void	setStyleName(String style) Clears all of the object's style names and sets it to the given style.
void	setStyleName(String style, boolean add) Adds or removes a style name.
void	setStylePrimaryName(String style) Sets the object's primary style name and updates all dependent style names.
static void	setStylePrimaryName(Element elem, String style) Sets the element's primary style name and updates all dependent style names.
void	setTitle(String title) Sets the title associated with this object.
void	setVisible(boolean visible) Sets whether this object is visible.
static void	setVisible(Element elem, boolean visible)
void	setWidth(String width) Sets the object's width.
void	sinkEvents(int eventBitsToAdd) Adds a set of events to be sunk by this object.
String	toString() This method is overridden so that any object can be viewed in the debugger as an HTML snippet.
void	unsinkEvents(int eventBitsToRemove) Removes a set of events from this object's event list.

From class java.lang.Object

From interface com.google.gwt.event.logical.shared.HasAttachHandlers

From interface com.google.gwt.event.shared.HasHandlers

From interface com.google.gwt.user.cellview.client.HasKeyboardPagingPolicy

From interface com.google.gwt.user.cellview.client.HasKeyboardSelectionPolicy

From interface com.google.gwt.user.client.EventListener

From interface com.google.gwt.user.client.ui.Focusable

From interface com.google.gwt.user.client.ui.IsWidget

From interface com.google.gwt.view.client.HasCellPreviewHandlers

From interface com.google.gwt.view.client.HasData

From interface com.google.gwt.view.client.HasKeyProvider

From interface com.google.gwt.view.client.HasRows

Public Constructors

public CellList (Cell<T> cell)

Construct a new CellList.

Parameters

cell	the cell used to render each item

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

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

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

Public Methods

public SafeHtml getEmptyListMessage ()

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

Returns

the empty message

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

public void setEmptyListMessage (SafeHtml html)

Set the message to display when there is no data.

Parameters

html	the message to display when there are no results

public void setValueUpdater (ValueUpdater<T> valueUpdater)

Set the value updater to use when cells modify items.

Parameters

valueUpdater	the `ValueUpdater`

Protected Methods

protected boolean dependsOnSelection ()

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

Returns

true if cells depend on selection, false if not

protected void doSelection (Event event, T value, int indexOnPage)

This method is deprecated.
use addCellPreviewHandler(com.google.gwt.view.client.CellPreviewEvent.Handler) instead

Called when a user action triggers selection.

Parameters

event	the event that triggered selection
value	the value that was selected
indexOnPage	the index of the value on the page

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

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. 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

protected Element getChildContainer ()

Return the element that holds the rendered cells.

Returns

the container Element

protected Element getKeyboardSelectedElement ()

Get the element that has keyboard selection.

Returns

the keyboard selected element

protected boolean isKeyboardNavigationSuppressed ()

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

Returns

true if suppressed, false if not

protected void onBlur ()

Called when the widget is blurred.

protected void onBrowserEvent2 (Event event)

Called after onBrowserEvent(Event) completes.

Parameters

event	the event that was fired

protected void onFocus ()

Called when the widget is focused.

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

Render all row values into the specified SafeHtmlBuilder.

Parameters

sb	the `SafeHtmlBuilder` to render into
values	the row values
start	the absolute start index of the values
selectionModel	the `SelectionModel`

protected boolean resetFocusOnCell ()

Reset focus on the currently focused cell.

Returns

true if focus is taken, false if not

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

Update an element to reflect its keyboard selected state.

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

protected void setSelected (Element elem, boolean selected)

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

Update an element to reflect its selected state.

Parameters

elem	the element to update
selected	true if selected, false if not

Interfaces

Classes

Enums

CellList

Class Overview

Examples

Summary

Public Constructors

public CellList (Cell<T> cell)

Parameters

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

Parameters

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

Parameters

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

Parameters

Public Methods

public SafeHtml getEmptyListMessage ()

Returns

See Also

public Element getRowElement (int indexOnPage)

Parameters

Returns

Throws

public void setEmptyListMessage (SafeHtml html)

Parameters

See Also

public void setValueUpdater (ValueUpdater<T> valueUpdater)

Parameters

Protected Methods

protected boolean dependsOnSelection ()

Returns

protected void doSelection (Event event, T value, int indexOnPage)

Parameters

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

Parameters

protected Cell<T> getCell ()

protected Element getCellParent (Element item)

Parameters

Returns

protected Element getChildContainer ()

Returns

protected Element getKeyboardSelectedElement ()

Returns

protected boolean isKeyboardNavigationSuppressed ()

Returns

protected void onBlur ()

protected void onBrowserEvent2 (Event event)

Parameters

protected void onFocus ()

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

Parameters

protected boolean resetFocusOnCell ()

Returns

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

Parameters

protected void setSelected (Element elem, boolean selected)

Parameters