Package io.jmix.ui.component.data.tree

Class ContainerTreeItems<E>

java.lang.Object

io.jmix.ui.component.data.tree.ContainerTreeItems<E>

All Implemented Interfaces:

DataUnit, ContainerDataUnit<E>, EntityDataUnit, EntityTreeItems<E>, TreeItems<E>

public class ContainerTreeItems<E>
extends Object
implements EntityTreeItems<E>, ContainerDataUnit<E>

Nested Class Summary

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

DataUnit.StateChangeEvent

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

TreeItems.ItemSetChangeEvent<T>, TreeItems.SelectedItemChangeEvent<T>, TreeItems.ValueChangeEvent<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected final CollectionContainer<E>	container
protected EventHub	events
protected final String	hierarchyProperty
protected final boolean	showOrphans

Constructor Summary

Constructors

Constructor	Description
ContainerTreeItems(CollectionContainer<E> container, String hierarchyProperty)
ContainerTreeItems(CollectionContainer<E> container, String hierarchyProperty, boolean showOrphans)

Method Summary

Modifier and Type	Method	Description
Subscription	addItemSetChangeListener(Consumer<TreeItems.ItemSetChangeEvent<E>> listener)	Registers a new item set change listener.
Subscription	addSelectedItemChangeListener(Consumer<TreeItems.SelectedItemChangeEvent<E>> listener)	Registers a new selected item change listener.
Subscription	addStateChangeListener(Consumer<DataUnit.StateChangeEvent> listener)	Registers a new state change listener.
Subscription	addValueChangeListener(Consumer<TreeItems.ValueChangeEvent<E>> listener)	Registers a new value change listener.
protected void	containerCollectionChanged(CollectionContainer.CollectionChangeEvent<E> e)
protected void	containerItemChanged(InstanceContainer.ItemChangeEvent<E> event)
protected void	containerItemPropertyChanged(InstanceContainer.ItemPropertyChangeEvent<E> e)
boolean	containsItem(E item)
int	getChildCount(E parent)
Stream<E>	getChildren(E item)
CollectionContainer<E>	getContainer()
MetaClass	getEntityMetaClass()
String	getHierarchyPropertyName()
E	getItem(Object itemId)
Object	getItemId(E item)
Stream<E>	getItems()
E	getParent(E item)
E	getSelectedItem()
BindingState	getState()
boolean	hasChildren(E item)
void	setSelectedItem(E item)	Set current item in the source.
int	size()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

container

protected final CollectionContainer<E> container

hierarchyProperty

protected final String hierarchyProperty

showOrphans

protected final boolean showOrphans

events

protected EventHub events

Constructor Details

ContainerTreeItems

public ContainerTreeItems(CollectionContainer<E> container,
 String hierarchyProperty,
 boolean showOrphans)

ContainerTreeItems

public ContainerTreeItems(CollectionContainer<E> container,
 String hierarchyProperty)

Method Details

containerItemChanged

protected void containerItemChanged(InstanceContainer.ItemChangeEvent<E> event)

containerCollectionChanged

protected void containerCollectionChanged(CollectionContainer.CollectionChangeEvent<E> e)

containerItemPropertyChanged

protected void containerItemPropertyChanged(InstanceContainer.ItemPropertyChangeEvent<E> e)

getEntityMetaClass

@Nullable
public MetaClass getEntityMetaClass()

Specified by:

getEntityMetaClass in interface EntityDataUnit

Returns:

MetaClass of an entity contained in the source

getSelectedItem

@Nullable
public E getSelectedItem()

Specified by:

getSelectedItem in interface EntityTreeItems<E>

Returns:

the current item contained in the source

setSelectedItem

public void setSelectedItem(@Nullable
 E item)

Description copied from interface: EntityTreeItems

Set current item in the source.

Specified by:

setSelectedItem in interface EntityTreeItems<E>

Parameters:

item - the item to set

getState

public BindingState getState()

Specified by:

getState in interface DataUnit

Returns:

a state of this source

getItemId

@Nullable
public Object getItemId(E item)

Specified by:

getItemId in interface TreeItems<E>

Parameters:

item - the item for obtaining the id

Returns:

the id on the given item

getItem

@Nullable
public E getItem(@Nullable
 Object itemId)

Specified by:

getItem in interface TreeItems<E>

Parameters:

itemId - the item id

Returns:

the item by the given id

getItems

public Stream<E> getItems()

Specified by:

getItems in interface TreeItems<E>

Returns:

the stream of all items

containsItem

public boolean containsItem(E item)

Specified by:

containsItem in interface TreeItems<E>

Parameters:

item - an item to check

Returns:

true if the underlying collection contains an item, false otherwise

size

public int size()

Specified by:

size in interface TreeItems<E>

Returns:

size of the underlying collection

getChildCount

public int getChildCount(E parent)

Specified by:

getChildCount in interface TreeItems<E>

Parameters:

parent - the parent item

Returns:

child count of the given parent item

getChildren

public Stream<E> getChildren(@Nullable
 E item)

Specified by:

getChildren in interface TreeItems<E>

Parameters:

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

Returns:

children of the given item

hasChildren

public boolean hasChildren(E item)

Specified by:

hasChildren in interface TreeItems<E>

Parameters:

item - the item to check

Returns:

true if the item has children, false otherwise

getParent

@Nullable
public E getParent(E item)

Specified by:

getParent in interface TreeItems<E>

Parameters:

item - the item to get parent

Returns:

the parent of given item or null if no parent

getHierarchyPropertyName

public String getHierarchyPropertyName()

Specified by:

getHierarchyPropertyName in interface TreeItems<E>

Returns:

the name of the property which forms the hierarchy

addStateChangeListener

public Subscription addStateChangeListener(Consumer<DataUnit.StateChangeEvent> listener)

Description copied from interface: DataUnit

Registers a new state change listener.

Specified by:

addStateChangeListener in interface DataUnit

Parameters:

listener - the listener to be added

Returns:

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

addValueChangeListener

public Subscription addValueChangeListener(Consumer<TreeItems.ValueChangeEvent<E>> listener)

Description copied from interface: TreeItems

Registers a new value change listener.

Specified by:

addValueChangeListener in interface TreeItems<E>

Parameters:

listener - the listener to be added

Returns:

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

addItemSetChangeListener

public Subscription addItemSetChangeListener(Consumer<TreeItems.ItemSetChangeEvent<E>> listener)

Description copied from interface: TreeItems

Registers a new item set change listener.

Specified by:

addItemSetChangeListener in interface TreeItems<E>

Parameters:

listener - the listener to be added

Returns:

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

addSelectedItemChangeListener

public Subscription addSelectedItemChangeListener(Consumer<TreeItems.SelectedItemChangeEvent<E>> listener)

Description copied from interface: TreeItems

Registers a new selected item change listener.

Specified by:

addSelectedItemChangeListener in interface TreeItems<E>

Parameters:

listener - the listener to be added

Returns:

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

getContainer

public CollectionContainer<E> getContainer()

Specified by:

getContainer in interface ContainerDataUnit<E>