com.vaadin.flow.data.provider.DataChangeEvent.DataRefreshEvent API 23.1.17 | Vaadin

You're viewing an older version of Vaadin JavaDoc. Please see version 24.7.0 for the latest.

com.vaadin.flow.data.provider.

java.lang.Object
- java.util.EventObject
- - com.vaadin.flow.data.provider.DataChangeEvent<T>
  - - com.vaadin.flow.data.provider.DataChangeEvent.DataRefreshEvent<T>

Type Parameters:

T - the data type

All Implemented Interfaces:

Serializable

Enclosing class:

DataChangeEvent<T>
```
public static class DataChangeEvent.DataRefreshEvent<T>
extends DataChangeEvent<T>
```
An event fired when a single item of a DataProvider has been updated.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class com.vaadin.flow.data.provider.DataChangeEvent
  DataChangeEvent.DataRefreshEvent<T>

Field Summary
- Fields inherited from class java.util.EventObject
  source

Constructor Summary

Constructors
Constructor	Description
`DataRefreshEvent(DataProvider<T,?> source, T item)`	Creates a new data refresh event originating from the given data provider.
`DataRefreshEvent(DataProvider<T,?> source, T item, boolean refreshChildren)`	Creates a new data refresh event originating from the given data provider.

Method Summary

All Methods
Modifier and Type	Method	Description
`T`	`getItem()`	Gets the refreshed item.
`boolean`	`isRefreshChildren()`	Gets the a boolean whether the refresh is supposed to be refreshChildren (in hierarchical data providers).

Methods inherited from class com.vaadin.flow.data.provider.DataChangeEvent
getSource, unregisterListener

Methods inherited from class java.util.EventObject
toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DataRefreshEvent
```
public DataRefreshEvent(DataProvider<T,?> source,
                        T item)
```
    Creates a new data refresh event originating from the given data provider.
    
    Parameters:
    
    source - the data provider, not null
    
    item - the updated item, not null
  - DataRefreshEvent
```
public DataRefreshEvent(DataProvider<T,?> source,
                        T item,
                        boolean refreshChildren)
```
    Creates a new data refresh event originating from the given data provider.
    
    Parameters:
    
    source - the data provider, not null
    
    item - the updated item, not null
    
    refreshChildren - whether, in hierarchical providers, subelements should be refreshed as well
- Method Detail
  - getItem
```
public T getItem()
```
    Gets the refreshed item.
    
    Returns:
    
    the refreshed item
  - isRefreshChildren
```
public boolean isRefreshChildren()
```
    Gets the a boolean whether the refresh is supposed to be refreshChildren (in hierarchical data providers).
    
    Returns:
    
    whether, in hierarchical providers, subelements should be refreshed as well