Package com.vaadin.flow.data.provider

Interface HasDataView<T,F,V extends DataView<T>>

Type Parameters:

T - data type

F - filter type

V - DataView type

All Superinterfaces:

Serializable

All Known Implementing Classes:

CheckboxGroup, ComboBox, ComboBoxBase, CrudGrid, Grid, GridPro, ListBox, ListBoxBase, MultiSelectComboBox, MultiSelectListBox, RadioButtonGroup, Select, TreeGrid

public interface HasDataView<T,F,V extends DataView<T>>
extends Serializable

An interface for components that get items from the generic data provider types DataProvider and InMemoryDataProvider. The methods return a DataView which has the generic API for getting information on the items.

Since:

Method Summary

Modifier and Type	Method	Description
V	getGenericDataView()	Get the DataView for the component.
V	setItems(DataProvider<T,F> dataProvider)	Set a generic data provider for the component to use and returns the base DataView that provides API to get information on the items.
V	setItems(InMemoryDataProvider<T> dataProvider)	Sets an in-memory data provider for the component to use

Method Details

setItems

V setItems(DataProvider<T,F> dataProvider)

Set a generic data provider for the component to use and returns the base DataView that provides API to get information on the items.

This method should be used only when the data provider type is not either ListDataProvider or BackEndDataProvider.

Parameters:

dataProvider - DataProvider instance to use, not null

Returns:

DataView providing information on the data

setItems

V setItems(InMemoryDataProvider<T> dataProvider)

Sets an in-memory data provider for the component to use

Note! Using a ListDataProvider instead of a InMemoryDataProvider is recommended to get access to ListDataView API by using HasListDataView.setItems(ListDataProvider).

Parameters:

dataProvider - InMemoryDataProvider to use, not null

Returns:

DataView providing information on the data

getGenericDataView

V getGenericDataView()

Get the DataView for the component.

The returned DataView only contains a minimal common API. Use of HasListDataView.getListDataView() or HasLazyDataView.getLazyDataView() should be used for more targeted helper features

Returns:

DataView instance