Package io.jmix.groupgridflowui.kit.vaadin.grid.dataview

Class GridLazyDataView<T>

java.lang.Object
com.vaadin.flow.data.provider.AbstractDataView<T>
com.vaadin.flow.data.provider.AbstractLazyDataView<T>
io.jmix.groupgridflowui.kit.vaadin.grid.dataview.GridLazyDataView<T>
Type Parameters:
T - the type of the items in grid
All Implemented Interfaces:
com.vaadin.flow.data.provider.DataView<T>, com.vaadin.flow.data.provider.LazyDataView<T>, Serializable
public class GridLazyDataView<T> extends com.vaadin.flow.data.provider.AbstractLazyDataView<T>
Data view implementation for Grid with lazy data fetching. Provides information on the data and allows operations on it.
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
    Constructor
    Description
    GridLazyDataView(com.vaadin.flow.data.provider.DataCommunicator<T> dataCommunicator, Grid<T> component)
    Creates a new lazy data view for grid and verifies the passed data provider is compatible with this data view implementation.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    setItemCountCallback(com.vaadin.flow.data.provider.CallbackDataProvider.CountCallback<T,Void> callback)
    Sets a callback that the Grid uses to get the exact item count in the backend.
    void
    setItemCountEstimate(int itemCountEstimate)
    void
    setItemCountFromDataProvider()
    void
    setItemCountUnknown()

    Methods inherited from class com.vaadin.flow.data.provider.AbstractLazyDataView

    getDataCommunicator, getItem, getItemCountEstimate, getItemCountEstimateIncrease, getItemIndex, getItemIndexProvider, getItems, getSupportedDataProviderType, setItemCountEstimateIncrease, setItemIndexProvider

    Methods inherited from class com.vaadin.flow.data.provider.AbstractDataView

    addIdentifierProviderChangeListener, addItemCountChangeListener, equals, getIdentifierProvider, getItemIndex, refreshAll, refreshItem, setIdentifierProvider, verifyDataProviderType, verifyDataProviderType

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.vaadin.flow.data.provider.DataView

    addItemCountChangeListener, refreshAll, refreshItem, setIdentifierProvider

  • Constructor Details

    • GridLazyDataView

      public GridLazyDataView(com.vaadin.flow.data.provider.DataCommunicator<T> dataCommunicator, Grid<T> component)
      Creates a new lazy data view for grid and verifies the passed data provider is compatible with this data view implementation.
      Parameters:
      dataCommunicator - the data communicator of the component
      component - the grid

  • Method Details

    • setItemCountCallback

      public void setItemCountCallback(com.vaadin.flow.data.provider.CallbackDataProvider.CountCallback<T,Void> callback)
      Sets a callback that the Grid uses to get the exact item count in the backend. Use this when it is cheap to get the exact item count and it is desired that the user sees the "full scrollbar size".

      The given callback will be queried for the count instead of the data provider DataProvider.size(Query) method when the component has a distinct data provider set with HasLazyDataView.setItems(BackEndDataProvider).

      Parameters:
      callback - the callback to use for determining item count in the backend, not null
      See Also:

    • setItemCountFromDataProvider

      public void setItemCountFromDataProvider()

      Calling this method will clear any previously set count callback with the setItemCountCallback(CallbackDataProvider.CountCallback) method.

      Specified by:
      setItemCountFromDataProvider in interface com.vaadin.flow.data.provider.LazyDataView<T>
      Overrides:
      setItemCountFromDataProvider in class com.vaadin.flow.data.provider.AbstractLazyDataView<T>

    • setItemCountEstimate

      public void setItemCountEstimate(int itemCountEstimate)

      Calling this method will clear any previously set count callback setItemCountCallback(CallbackDataProvider.CountCallback).

      Specified by:
      setItemCountEstimate in interface com.vaadin.flow.data.provider.LazyDataView<T>
      Overrides:
      setItemCountEstimate in class com.vaadin.flow.data.provider.AbstractLazyDataView<T>

    • setItemCountUnknown

      public void setItemCountUnknown()

      Calling this method will clear any previously set count callback setItemCountCallback(CallbackDataProvider.CountCallback).

      Specified by:
      setItemCountUnknown in interface com.vaadin.flow.data.provider.LazyDataView<T>
      Overrides:
      setItemCountUnknown in class com.vaadin.flow.data.provider.AbstractLazyDataView<T>