io.jmix.ui.component.data

Interface TreeDataGridItems<T>

Type Parameters:

T - items type

All Superinterfaces:

DataGridItems<T>, DataGridItems.Sortable<T>, DataUnit

All Known Implementing Classes:

ContainerTreeDataGridItems, EmptyTreeDataGridItems

public interface TreeDataGridItems<T>
extends DataGridItems.Sortable<T>

A common interface for providing data for the TreeDataGrid component.

Nested Class Summary

Nested classes/interfaces inherited from interface io.jmix.ui.component.data.DataGridItems

DataGridItems.ItemSetChangeEvent<T>, DataGridItems.SelectedItemChangeEvent<T>, DataGridItems.Sortable<T>, DataGridItems.ValueChangeEvent<T>

Nested classes/interfaces inherited from interface io.jmix.ui.component.data.DataUnit

DataUnit.StateChangeEvent

Method Summary

Modifier and Type	Method and Description
int	getChildCount(T parent)
java.util.stream.Stream<T>	getChildren(T item)
java.lang.String	getHierarchyPropertyName() Returns the property of entity which forms the hierarchy.
T	getParent(T item)
boolean	hasChildren(T item)

Methods inherited from interface io.jmix.ui.component.data.DataGridItems.Sortable

enableSorting, resetSortOrder, sort, suppressSorting

Methods inherited from interface io.jmix.ui.component.data.DataGridItems

addItemSetChangeListener, addSelectedItemChangeListener, addValueChangeListener, containsItem, getItem, getItemByIndex, getItemId, getItems, getItems, getItemValue, getSelectedItem, indexOfItem, setSelectedItem, size

Methods inherited from interface io.jmix.ui.component.data.DataUnit

addStateChangeListener, getState

Method Detail

getChildCount

int getChildCount(T parent)

Parameters:

parent - the parent item

Returns:

child count of the given parent item

getChildren

java.util.stream.Stream<T> getChildren(@Nullable
                                       T item)

Parameters:

item - the item to obtain children or null to get root items

Returns:

children of the given item

hasChildren

boolean hasChildren(T item)

Parameters:

item - the item to check

Returns:

true if the item has children, false otherwise

getParent

@Nullable
T getParent(T item)

Parameters:

item - the item to get parent

Returns:

the parent of the given item or null if no parent

getHierarchyPropertyName

java.lang.String getHierarchyPropertyName()

Returns the property of entity which forms the hierarchy.

Returns:

hierarchy property name