Package com.vaadin.flow.data.provider.hierarchy

Class TreeDataProvider<T>

java.lang.Object

com.vaadin.flow.data.provider.AbstractDataProvider<T,SerializablePredicate<T>>

com.vaadin.flow.data.provider.hierarchy.AbstractHierarchicalDataProvider<T,SerializablePredicate<T>>

com.vaadin.flow.data.provider.hierarchy.InMemoryHierarchicalDataProvider<T,TreeData<T>>

com.vaadin.flow.data.provider.hierarchy.TreeDataProvider<T>

Type Parameters:

T - data type

All Implemented Interfaces:

ConfigurableFilterDataProvider<T,SerializablePredicate<T>,SerializablePredicate<T>>, DataProvider<T,SerializablePredicate<T>>, HierarchicalDataProvider<T,SerializablePredicate<T>>, InMemoryDataProvider<T>, Serializable

public class TreeDataProvider<T>
extends InMemoryHierarchicalDataProvider<T,TreeData<T>>

An in-memory data provider for listing components that display hierarchical data. Uses an instance of TreeData as its source of data.

Since:

1.2

Author:

Vaadin Ltd

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.flow.data.provider.hierarchy.HierarchicalDataProvider

HierarchicalDataProvider.HierarchyFormat

Constructor Summary

Constructors

Constructor	Description
TreeDataProvider(TreeData<T> treeData)	Constructs a new TreeDataProvider.
TreeDataProvider(TreeData<T> treeData, HierarchicalDataProvider.HierarchyFormat hierarchyFormat)	Creates a new TreeDataProvider and configures it to return the hierarchical data in the specified format: HierarchicalDataProvider.HierarchyFormat.NESTED or HierarchicalDataProvider.HierarchyFormat.FLATTENED.

Method Summary

Modifier and Type	Method	Description
TreeData<T>	getTreeData()	Deprecated, for removal: This API element is subject to removal in a future version. use InMemoryHierarchicalDataProvider.getHierarchicalData() instead.

Methods inherited from class com.vaadin.flow.data.provider.hierarchy.InMemoryHierarchicalDataProvider

fetchChildren, getChildCount, getDepth, getFilter, getHierarchicalData, getHierarchyFormat, getParent, getSortComparator, hasChildren, setFilter, setSortComparator

Methods inherited from class com.vaadin.flow.data.provider.hierarchy.AbstractHierarchicalDataProvider

refreshItem, withConfigurableFilter, withConfigurableFilter, withConvertedFilter

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

addDataProviderListener, addListener, fireEvent, refreshAll, refreshItem

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

addDataProviderListener, getId, refreshAll, refreshItem, refreshItem

Methods inherited from interface com.vaadin.flow.data.provider.hierarchy.HierarchicalDataProvider

fetch, getItemIndex, size

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

addFilter, addFilter, addFilterByValue, addSortComparator, addSortOrder, clearFilters, filteringBy, filteringBy, filteringByEquals, filteringByPrefix, filteringByPrefix, filteringBySubstring, filteringBySubstring, isInMemory, setFilter, setFilterByValue, setSortOrder

Constructor Details

TreeDataProvider

public TreeDataProvider(TreeData<T> treeData)

Constructs a new TreeDataProvider.

The data provider should be refreshed after making changes to the underlying TreeData instance.

Parameters:

treeData - the backing TreeData for this provider, not null

TreeDataProvider

public TreeDataProvider(TreeData<T> treeData,
 HierarchicalDataProvider.HierarchyFormat hierarchyFormat)

Creates a new TreeDataProvider and configures it to return the hierarchical data in the specified format: HierarchicalDataProvider.HierarchyFormat.NESTED or HierarchicalDataProvider.HierarchyFormat.FLATTENED.

The data provider should be refreshed after making changes to the underlying TreeData instance.

Parameters:

treeData - the backing TreeData for this provider, not null

hierarchyFormat - the hierarchy format to return data in, not null

Method Details

getTreeData

@Deprecated(forRemoval=true,
            since="25.2")
public TreeData<T> getTreeData()

Deprecated, for removal: This API element is subject to removal in a future version.

use InMemoryHierarchicalDataProvider.getHierarchicalData() instead.

Return the underlying TreeData of this provider.

Returns:

the underlying data of this provider