com.vaadin.data

Interface HasDataProvider<T>

Type Parameters:

T - the item data type

All Superinterfaces:

ClientConnector, Component, Connector, HasItems<T>, Serializable, Sizeable

All Known Subinterfaces:

HasHierarchicalDataProvider<T>

All Known Implementing Classes:

CheckBoxGroup, Grid, ListSelect, NativeSelect, RadioButtonGroup, Tree, TreeGrid, TwinColSelect

public interface HasDataProvider<T>
extends HasItems<T>

A generic interface for listing components that use a data provider for showing data.

A listing component should implement either this interface or HasFilterableDataProvider, but not both.

Since:

8.0

Author:

Vaadin Ltd.

See Also:

HasFilterableDataProvider

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

Component.ErrorEvent, Component.Event, Component.Focusable, Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

ClientConnector.AttachEvent, ClientConnector.AttachListener, ClientConnector.ConnectorErrorEvent, ClientConnector.DetachEvent, ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

Sizeable.Unit

Field Summary

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Method Summary

Modifier and Type	Method and Description
void	setDataProvider(DataProvider<T,?> dataProvider) Sets the data provider for this listing.
default void	setItems(Collection<T> items) Sets the data items of this component provided as a collection.

Methods inherited from interface com.vaadin.data.HasItems

getDataProvider, setItems, setItems

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, addStyleNames, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, readDesign, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setStyleName, setVisible, writeDesign

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightFull, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull, setWidthUndefined

Method Detail

setDataProvider

void setDataProvider(DataProvider<T,?> dataProvider)

Sets the data provider for this listing. The data provider is queried for displayed items as needed.

Parameters:

dataProvider - the data provider, not null

setItems

default void setItems(Collection<T> items)

Description copied from interface: HasItems

Sets the data items of this component provided as a collection.

The provided items are wrapped into a ListDataProvider and this instance is used as a data provider for the #setDataProvider(DataProvider) method. It means that the items collection can be accessed later on via ListDataProvider.getItems():

 
 HasDataProvider<String> listing = new CheckBoxGroup<>();
 listing.setItems(Arrays.asList("a","b"));
 ...

 Collection collection = ((ListDataProvider)listing.getDataProvider()).getItems();
 
 

The provided collection instance may be used as-is. Subsequent modification of the collection might cause inconsistent data to be shown in the component unless it is explicitly instructed to read the data again.

Specified by:

setItems in interface HasItems<T>

Parameters:

items - the data items to display, not null