com.vaadin.flow.component.grid.dataview.
Class GridDataView<T>
Type Parameters:
T
- the item type
All Implemented Interfaces:
DataView<T>
, Serializable
Implementation of generic data view for grid.
Since:
See Also:
-
Field Summary
Fields inherited from class com.vaadin.flow.data.provider.AbstractDataView
component, dataProviderSupplier, NULL_IDENTIFIER_ERROR_MESSAGE, NULL_ITEM_ERROR_MESSAGE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetItem
(int index) Gets the item at the given index from the data available to the component.
getItems()
Get the full data available to the component.
protected Class<?>
Returns supported
DataProvider
type for thisDataView
.void
setIdentifierProvider
(IdentifierProvider<T> identifierProvider) Sets an identifier provider, which returns an identifier for the given item.
Methods inherited from class com.vaadin.flow.data.provider.AbstractDataView
addIdentifierProviderChangeListener, addItemCountChangeListener, equals, getIdentifierProvider, getItemIndex, getItemIndex, refreshAll, refreshItem, verifyDataProviderType, verifyDataProviderType
-
Constructor Details
-
GridDataView
-
-
Method Details
-
getItem
Description copied from interface:
DataView
Gets the item at the given index from the data available to the component. Data is filtered and sorted the same way as in the component.
Parameters:
index
- item index numberReturns:
item on index
-
getSupportedDataProviderType
Description copied from class:
AbstractDataView
Returns supported
DataProvider
type for thisDataView
.Specified by:
getSupportedDataProviderType
in classAbstractDataView<T>
Returns:
supported data provider type
-
getItems
Description copied from interface:
DataView
Get the full data available to the component. Data is filtered and sorted the same way as in the component.
Consumers of the returned stream are responsible for closing it when all the stream operations are done to ensure that any resources feeding the stream are properly released. Failure to close the stream might lead to resource leaks.
It is strongly recommended to use a try-with-resources block to automatically close the stream after its terminal operation has been executed. Below is an example of how to properly use and close the stream:
try (Stream<T> stream = dataView.getItems()) { stream.forEach(System.out::println); // Example terminal operation }
-
setIdentifierProvider
Description copied from interface:
DataView
Sets an identifier provider, which returns an identifier for the given item. The identifier is used for comparing the equality of items. Usage example:
dataView.setIdentifiedProvider(Item::getId);
.Specified by:
setIdentifierProvider
in interfaceDataView<T>
Overrides:
setIdentifierProvider
in classAbstractDataView<T>
Parameters:
identifierProvider
- function that returns the non-null identifier for a given item
-