io.jmix.ui.component.data

Interface TreeItems<T>

All Superinterfaces:

DataUnit

All Known Subinterfaces:

EntityTreeItems<E>

All Known Implementing Classes:

ContainerTreeItems

public interface TreeItems<T>
extends DataUnit

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TreeItems.ItemSetChangeEvent<T> An event that is fired when TreeItems item set is changed.
static class	TreeItems.SelectedItemChangeEvent<T> An event that is fired when TreeItems selected item is changed.
static class	TreeItems.ValueChangeEvent<T> An event that is fired when TreeItems value is changed.

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

DataUnit.StateChangeEvent

Method Summary

Modifier and Type	Method and Description
io.jmix.core.common.event.Subscription	addItemSetChangeListener(java.util.function.Consumer<TreeItems.ItemSetChangeEvent<T>> listener) Registers a new item set change listener.
io.jmix.core.common.event.Subscription	addSelectedItemChangeListener(java.util.function.Consumer<TreeItems.SelectedItemChangeEvent<T>> listener) Registers a new selected item change listener.
io.jmix.core.common.event.Subscription	addValueChangeListener(java.util.function.Consumer<TreeItems.ValueChangeEvent<T>> listener) Registers a new value change listener.
boolean	containsItem(T item)
int	getChildCount(T parent)
java.util.stream.Stream<T>	getChildren(T item)
java.lang.String	getHierarchyPropertyName()
T	getItem(java.lang.Object itemId)
java.lang.Object	getItemId(T item)
java.util.stream.Stream<T>	getItems()
T	getParent(T item)
boolean	hasChildren(T item)
int	size()

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

addStateChangeListener, getState

Method Detail

getItemId

@Nullable
java.lang.Object getItemId(T item)

Parameters:

item - the item for obtaining the id

Returns:

the id on the given item

getItem

@Nullable
T getItem(@Nullable
                    java.lang.Object itemId)

Parameters:

itemId - the item id

Returns:

the item by the given id

getItems

java.util.stream.Stream<T> getItems()

Returns:

the stream of all items

containsItem

boolean containsItem(T item)

Parameters:

item - an item to check

Returns:

true if the underlying collection contains an item, false otherwise

size

int size()

Returns:

size of the underlying collection

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 given item or null if no parent

getHierarchyPropertyName

java.lang.String getHierarchyPropertyName()

Returns:

the name of the property which forms the hierarchy

addValueChangeListener

io.jmix.core.common.event.Subscription addValueChangeListener(java.util.function.Consumer<TreeItems.ValueChangeEvent<T>> listener)

Registers a new value change listener.

Parameters:

listener - the listener to be added

Returns:

a registration object for removing an event listener added to a source

addItemSetChangeListener

io.jmix.core.common.event.Subscription addItemSetChangeListener(java.util.function.Consumer<TreeItems.ItemSetChangeEvent<T>> listener)

Registers a new item set change listener.

Parameters:

listener - the listener to be added

Returns:

a registration object for removing an event listener added to a source

addSelectedItemChangeListener

io.jmix.core.common.event.Subscription addSelectedItemChangeListener(java.util.function.Consumer<TreeItems.SelectedItemChangeEvent<T>> listener)

Registers a new selected item change listener.

Parameters:

listener - the listener to be added

Returns:

a registration object for removing an event listener added to a source