com.vaadin.data.HasFilterableDataProvider API 8.6.1 | Vaadin

You're viewing an older version of Framework JavaDoc. Please see version 8.27.7 for the latest.

com.vaadin.data.

Type Parameters:

T - the item data type

F - the filter type

All Superinterfaces:

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

All Known Implementing Classes:

ComboBox
```
public interface HasFilterableDataProvider<T,F>
extends HasItems<T>
```
A generic interface for listing components that use a filterable data provider for showing data.
A listing component should implement either this interface or HasDataProvider, but not both.

Since:

8.0

Author:

Vaadin Ltd.

See Also:

HasDataProvider

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

All Methods
Modifier and Type	Method and Description
`<C> void`	`setDataProvider(DataProvider<T,C> dataProvider, SerializableFunction<F,C> filterConverter)` Sets the data provider and filter converter for this listing.
`default void`	`setDataProvider(DataProvider<T,F> dataProvider)` Sets the data provider for this listing.

Methods inherited from interface com.vaadin.data.HasItems
getDataProvider, setItems, 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, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUndefined

- Method Detail
  - setDataProvider
```
default void setDataProvider(DataProvider<T,F> 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
  - setDataProvider
```
<C> void setDataProvider(DataProvider<T,C> dataProvider,
                         SerializableFunction<F,C> filterConverter)
```
    Sets the data provider and filter converter for this listing. The data provider is queried for displayed items as needed.
    
    Parameters:
    
    dataProvider - the data provider, not null
    
    filterConverter - a function that converts filter values produced by this listing into filter values expected by the provided data provider, not null