We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.data.provider.
Class AbstractDataProvider<T,F>
- java.lang.Object
-
- com.vaadin.flow.data.provider.AbstractDataProvider<T,F>
-
Type Parameters:
T- data typeF- filter typeAll Implemented Interfaces:
DataProvider<T,F>, Serializable
Direct Known Subclasses:
AbstractBackEndDataProvider, AbstractHierarchicalDataProvider, ListDataProvider
public abstract class AbstractDataProvider<T,F> extends Object implements DataProvider<T,F>Abstract data provider implementation which takes care of refreshing data from the underlying data provider.
Since:
1.0
Author:
Vaadin Ltd
See Also:
-
-
Constructor Summary
Constructors Constructor and Description AbstractDataProvider()
-
Method Summary
All Methods Modifier and Type Method and Description RegistrationaddDataProviderListener(DataProviderListener<T> listener)Adds a data provider listener.
protected <E> RegistrationaddListener(Class<E> eventType, SerializableConsumer<E> method)Registers a new listener with the specified activation method to listen events generated by this component.
protected voidfireEvent(EventObject event)Sends the event to all listeners.
voidrefreshAll()Refreshes all data based on currently available data in the underlying provider.
voidrefreshItem(T item)Refreshes the given item.
voidrefreshItem(T item, boolean refreshChildren)Refreshes the given item and all of the children of the item as well.
-
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.DataProvider
fetch, fromCallbacks, fromFilteringCallbacks, fromStream, getId, isInMemory, ofCollection, ofItems, size, withConfigurableFilter, withConfigurableFilter, withConvertedFilter
-
-
-
-
Method Detail
-
addDataProviderListener
public Registration addDataProviderListener(DataProviderListener<T> listener)Description copied from interface:
DataProviderAdds a data provider listener. The listener is called when some piece of data is updated.
The
DataProvider.refreshAll()method firesDataChangeEventeach time when it's called. It allows to update UI components when user changes something in the underlying data.Specified by:
addDataProviderListenerin interfaceDataProvider<T,F>Parameters:
listener- the data change listener, not nullReturns:
a registration for the listener
See Also:
-
refreshAll
public void refreshAll()Description copied from interface:
DataProviderRefreshes all data based on currently available data in the underlying provider.
Specified by:
refreshAllin interfaceDataProvider<T,F>
-
refreshItem
public void refreshItem(T item, boolean refreshChildren)Description copied from interface:
DataProviderRefreshes the given item and all of the children of the item as well.
Specified by:
refreshItemin interfaceDataProvider<T,F>Parameters:
item- the item to refreshrefreshChildren- whether or not to refresh child itemsSee Also:
-
refreshItem
public void refreshItem(T item)Description copied from interface:
DataProviderRefreshes the given item. This method should be used to inform all
DataProviderListenersthat an item has been updated or replaced with a new instance.For this to work properly, the item must either implement
Object.equals(Object)andObject.hashCode()to consider both the old and the new item instances to be equal, or alternativelyDataProvider.getId(Object)should be implemented to return an appropriate identifier.Specified by:
refreshItemin interfaceDataProvider<T,F>Parameters:
item- the item to refreshSee Also:
-
addListener
protected <E> Registration addListener(Class<E> eventType, SerializableConsumer<E> method)Registers a new listener with the specified activation method to listen events generated by this component. If the activation method does not have any arguments the event object will not be passed to it when it's called.
Type Parameters:
E- the event typeParameters:
eventType- the type of the listened event. Events of this type or its subclasses activate the listener.method- the consumer to receive the event.Returns:
a registration for the listener
-
fireEvent
protected void fireEvent(EventObject event)Sends the event to all listeners.
Parameters:
event- the Event to be sent to all listeners.
-
-