com.vaadin.fluent.api

Interface FluentHasHierarchicalDataProvider<THIS extends FluentHasHierarchicalDataProvider<THIS,ITEM>,ITEM>

All Superinterfaces:

com.vaadin.server.ClientConnector, com.vaadin.ui.Component, com.vaadin.shared.Connector, FluentComponent<THIS>, FluentHasDataProvider<THIS,ITEM>, FluentHasItems<THIS,ITEM>, FluentSizeable<THIS>, com.vaadin.data.HasDataProvider<ITEM>, com.vaadin.data.HasHierarchicalDataProvider<ITEM>, com.vaadin.data.HasItems<ITEM>, Serializable, com.vaadin.server.Sizeable

All Known Subinterfaces:

FluentTree<THIS,ITEM>, FluentTreeGrid<THIS,ITEM>

All Known Implementing Classes:

FTree, FTreeGrid

public interface FluentHasHierarchicalDataProvider<THIS extends FluentHasHierarchicalDataProvider<THIS,ITEM>,ITEM>
extends com.vaadin.data.HasHierarchicalDataProvider<ITEM>, FluentHasDataProvider<THIS,ITEM>

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.fluent.api.FluentComponent

FluentComponent.FluentFocusable<C extends FluentComponent.FluentFocusable<C>>

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

com.vaadin.server.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

Modifier and Type	Method and Description
default THIS	withItems(Collection<ITEM> items) Sets the data items of this component provided as a collection.
default THIS	withItems(Collection<ITEM> rootItems, com.vaadin.data.ValueProvider<ITEM,Collection<ITEM>> childItemProvider) Sets the root data items of this component provided as a collection and recursively populates them with child items with the given value provider.
default THIS	withItems(ITEM... items) Sets the data items of this listing.
default THIS	withItems(Stream<ITEM> items) Sets the data items of this component provided as a stream.
default THIS	withItems(Stream<ITEM> rootItems, com.vaadin.data.ValueProvider<ITEM,Stream<ITEM>> childItemProvider) Sets the root data items of this component provided as a stream and recursively populates them with child items with the given value provider.
default THIS	withTreeData(com.vaadin.data.TreeData<ITEM> treeData) Sets a new TreeDataProvider wrapping the given TreeData.

Methods inherited from interface com.vaadin.data.HasHierarchicalDataProvider

getTreeData, setItems, setItems, setItems, setItems, setItems, setTreeData

Methods inherited from interface com.vaadin.fluent.api.FluentHasDataProvider

withDataProvider

Methods inherited from interface com.vaadin.data.HasDataProvider

setDataProvider

Methods inherited from interface com.vaadin.data.HasItems

getDataProvider

Methods inherited from interface com.vaadin.fluent.api.FluentComponent

withCaption, withEnabled, withIcon, withId, withParent, withPrimaryStyleName, withStyleName, withStyleName, withVisible

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, 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.fluent.api.FluentSizeable

withFullHeight, withFullSize, withFullWidth, withHeight, withHeight, withSize, withUndefinedHeight, withUndefinedSize, withUndefinedWidth, withWidth, withWidth

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUndefined

Method Detail

withTreeData

default THIS withTreeData(com.vaadin.data.TreeData<ITEM> treeData)

Sets a new TreeDataProvider wrapping the given TreeData.

Parameters:

treeData - the tree data to set

Returns:

this form method chaining

See Also:

HasHierarchicalDataProvider.setTreeData(TreeData)

withItems

default THIS withItems(Collection<ITEM> rootItems,
                       com.vaadin.data.ValueProvider<ITEM,Collection<ITEM>> childItemProvider)

Sets the root data items of this component provided as a collection and recursively populates them with child items with the given value provider.

The provided items are wrapped into a TreeDataProvider backed by a flat TreeData structure. The data provider instance is used as a parameter for the HasDataProvider.setDataProvider(DataProvider) method. It means that the items collection can be accessed later on via HasHierarchicalDataProvider.getTreeData():

 
 Collection<Person> grandParents = getGrandParents();
 HasHierarchicalDataProvider<Person> treeGrid = new TreeGrid<>();
 treeGrid.setItems(grandParents, Person::getChildren);
 ...

 TreeData<Person> data = treeGrid.getTreeData();
 
 

The returned TreeData instance may be used as-is to add, remove or modify items in the hierarchy. These modifications to the object are not automatically reflected back to the TreeGrid. Items modified should be refreshed with DataProvider.refreshItem(Object) and when adding or removing items DataProvider.refreshAll() should be called.

Parameters:

rootItems - the root items to display, not null

childItemProvider - the value provider used to recursively populate the given root items with child items, not null

Returns:

this form method chaining

See Also:

HasHierarchicalDataProvider.setItems(Collection, ValueProvider)

withItems

default THIS withItems(Stream<ITEM> rootItems,
                       com.vaadin.data.ValueProvider<ITEM,Stream<ITEM>> childItemProvider)

Sets the root data items of this component provided as a stream and recursively populates them with child items with the given value provider.

The provided items are wrapped into a TreeDataProvider backed by a flat TreeData structure. The data provider instance is used as a parameter for the HasDataProvider.setDataProvider(DataProvider) method. It means that the items collection can be accessed later on via HasHierarchicalDataProvider.getTreeData():

 
 Stream<Person> grandParents = getGrandParents();
 HasHierarchicalDataProvider<Person> treeGrid = new TreeGrid<>();
 treeGrid.setItems(grandParents, Person::getChildren);
 ...

 TreeData<Person> data = treeGrid.getTreeData();
 
 

The returned TreeData instance may be used as-is to add, remove or modify items in the hierarchy. These modifications to the object are not automatically reflected back to the TreeGrid. Items modified should be refreshed with DataProvider.refreshItem(Object) and when adding or removing items DataProvider.refreshAll() should be called.

Parameters:

rootItems - the root items to display, not null

childItemProvider - the value provider used to recursively populate the given root items with child items, not null

Returns:

this form method chaining

See Also:

HasHierarchicalDataProvider.setItems(Stream, ValueProvider)

withItems

default THIS withItems(Collection<ITEM> items)

Sets the data items of this component provided as a collection.

The provided items are wrapped into a TreeDataProvider backed by a flat TreeData structure. The data provider instance is used as a parameter for the HasDataProvider.setDataProvider(DataProvider) method. It means that the items collection can be accessed later on via HasHierarchicalDataProvider.getTreeData():

 
 HasHierarchicalDataProvider<String> treeGrid = new TreeGrid<>();
 treeGrid.setItems(Arrays.asList("a","b"));
 ...

 TreeData<String> data = treeGrid.getTreeData();
 
 

The returned TreeData instance may be used as-is to add, remove or modify items in the hierarchy. These modifications to the object are not automatically reflected back to the TreeGrid. Items modified should be refreshed with DataProvider.refreshItem(Object) and when adding or removing items DataProvider.refreshAll() should be called.

Specified by:

withItems in interface FluentHasDataProvider<THIS extends FluentHasHierarchicalDataProvider<THIS,ITEM>,ITEM>

Specified by:

withItems in interface FluentHasItems<THIS extends FluentHasHierarchicalDataProvider<THIS,ITEM>,ITEM>

Parameters:

items - the data items to display, not null

Returns:

this form method chaining

See Also:

HasHierarchicalDataProvider.setItems(Collection)

withItems

default THIS withItems(Stream<ITEM> items)

Sets the data items of this component provided as a stream.

The provided items are wrapped into a TreeDataProvider backed by a flat TreeData structure. The data provider instance is used as a parameter for the HasDataProvider.setDataProvider(DataProvider) method. It means that the items collection can be accessed later on via HasHierarchicalDataProvider.getTreeData():

 
 HasHierarchicalDataProvider<String> treeGrid = new TreeGrid<>();
 treeGrid.setItems(Stream.of("a","b"));
 ...

 TreeData<String> data = treeGrid.getTreeData();
 
 

The returned TreeData instance may be used as-is to add, remove or modify items in the hierarchy. These modifications to the object are not automatically reflected back to the TreeGrid. Items modified should be refreshed with DataProvider.refreshItem(Object) and when adding or removing items DataProvider.refreshAll() should be called.

Specified by:

withItems in interface FluentHasItems<THIS extends FluentHasHierarchicalDataProvider<THIS,ITEM>,ITEM>

Parameters:

items - the data items to display, not null

Returns:

this form method chaining

See Also:

HasHierarchicalDataProvider.setItems(Stream)

withItems

default THIS withItems(ITEM... items)

Sets the data items of this listing.

The provided items are wrapped into a TreeDataProvider backed by a flat TreeData structure. The data provider instance is used as a parameter for the HasDataProvider.setDataProvider(DataProvider) method. It means that the items collection can be accessed later on via HasHierarchicalDataProvider.getTreeData():

 
 TreeGrid<String> treeGrid = new TreeGrid<>();
 treeGrid.setItems("a","b");
 ...

 TreeData<String> data = treeGrid.getTreeData();
 
 

The returned TreeData instance may be used as-is to add, remove or modify items in the hierarchy. These modifications to the object are not automatically reflected back to the TreeGrid. Items modified should be refreshed with DataProvider.refreshItem(Object) and when adding or removing items DataProvider.refreshAll() should be called.

Specified by:

withItems in interface FluentHasItems<THIS extends FluentHasHierarchicalDataProvider<THIS,ITEM>,ITEM>

Parameters:

items - the data items to display, not null

Returns:

this form method chaining

See Also:

HasHierarchicalDataProvider.setItems(Object...)