com.haulmont.cuba.gui.components.data.tree

Class ContainerTreeItems<E extends Entity>

java.lang.Object

com.haulmont.cuba.gui.components.data.tree.ContainerTreeItems<E>

All Implemented Interfaces:

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

public class ContainerTreeItems<E extends Entity>
extends java.lang.Object
implements EntityTreeItems<E>, ContainerDataUnit<E>

Nested Class Summary

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.data.TreeItems

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

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.data.DataUnit

DataUnit.StateChangeEvent

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ContainerTreeItems(CollectionContainer<E> container, java.lang.String hierarchyProperty)
ContainerTreeItems(CollectionContainer<E> container, java.lang.String hierarchyProperty, boolean showOrphans)

Method Summary

Modifier and Type	Method and Description
Subscription	addItemSetChangeListener(java.util.function.Consumer<TreeItems.ItemSetChangeEvent<E>> listener) Registers a new item set change listener.
Subscription	addSelectedItemChangeListener(java.util.function.Consumer<TreeItems.SelectedItemChangeEvent<E>> listener) Registers a new selected item change listener.
Subscription	addStateChangeListener(java.util.function.Consumer<DataUnit.StateChangeEvent> listener) Registers a new state change listener.
Subscription	addValueChangeListener(java.util.function.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)
java.util.stream.Stream<E>	getChildren(E item)
CollectionContainer<E>	getContainer()
MetaClass	getEntityMetaClass()
java.lang.String	getHierarchyPropertyName()
E	getItem(java.lang.Object itemId)
java.lang.Object	getItemId(E item)
java.util.stream.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 Detail

container

protected final CollectionContainer<E extends Entity> container

hierarchyProperty

protected final java.lang.String hierarchyProperty

showOrphans

protected final boolean showOrphans

events

protected EventHub events

Constructor Detail

ContainerTreeItems

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

ContainerTreeItems

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

Method Detail

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

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 extends Entity>

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 extends Entity>

Parameters:

item - the item to set

getState

public BindingState getState()

Specified by:

getState in interface DataUnit

Returns:

a state of this source

getItemId

public java.lang.Object getItemId(E item)

Specified by:

getItemId in interface TreeItems<E extends Entity>

Parameters:

item - the item for obtaining the id

Returns:

the id on the given item

getItem

public E getItem(java.lang.Object itemId)

Specified by:

getItem in interface TreeItems<E extends Entity>

Parameters:

itemId - the item id

Returns:

the item by the given id

getItems

public java.util.stream.Stream<E> getItems()

Specified by:

getItems in interface TreeItems<E extends Entity>

Returns:

the stream of all items

containsItem

public boolean containsItem(E item)

Specified by:

containsItem in interface TreeItems<E extends Entity>

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 extends Entity>

Returns:

size of the underlying collection

getChildCount

public int getChildCount(E parent)

Specified by:

getChildCount in interface TreeItems<E extends Entity>

Parameters:

parent - the parent item

Returns:

child count of the given parent item

getChildren

public java.util.stream.Stream<E> getChildren(E item)

Specified by:

getChildren in interface TreeItems<E extends Entity>

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 extends Entity>

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 extends Entity>

Parameters:

item - the item to get parent

Returns:

the parent of given item or null if no parent

getHierarchyPropertyName

public java.lang.String getHierarchyPropertyName()

Specified by:

getHierarchyPropertyName in interface TreeItems<E extends Entity>

Returns:

the name of the property which forms the hierarchy

addStateChangeListener

public Subscription addStateChangeListener(java.util.function.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(java.util.function.Consumer<TreeItems.ValueChangeEvent<E>> listener)

Description copied from interface: TreeItems

Registers a new value change listener.

Specified by:

addValueChangeListener in interface TreeItems<E extends Entity>

Parameters:

listener - the listener to be added

Returns:

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

addItemSetChangeListener

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

Description copied from interface: TreeItems

Registers a new item set change listener.

Specified by:

addItemSetChangeListener in interface TreeItems<E extends Entity>

Parameters:

listener - the listener to be added

Returns:

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

addSelectedItemChangeListener

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

Description copied from interface: TreeItems

Registers a new selected item change listener.

Specified by:

addSelectedItemChangeListener in interface TreeItems<E extends Entity>

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 extends Entity>