DatasourceTreeItems (CUBA 7.2 API)

java.lang.Object
- com.haulmont.cuba.gui.components.data.tree.DatasourceTreeItems<E,K>

All Implemented Interfaces:: DataUnit, EntityDataUnit, EntityTreeItems<E>, TreeItems<E>

public class DatasourceTreeItems<E extends Entity<K>,K>
extends java.lang.Object
implements EntityTreeItems<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 HierarchicalDatasource<E,K> datasource

protected EventHub events

protected BindingState state

Fields
Modifier and Type	Field and Description
`protected HierarchicalDatasource<E,K>`	`datasource`
`protected EventHub`	`events`
`protected BindingState`	`state`

Constructor Summary

Constructors
Constructor and Description

DatasourceTreeItems(HierarchicalDatasource<E,K> datasource)

Constructors
Constructor and Description
`DatasourceTreeItems(HierarchicalDatasource<E,K> datasource)`

Method Summary

All Methods Instance Methods Concrete Methods
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.
`boolean`	`containsItem(E item)`
`protected void`	`datasourceCollectionChanged(CollectionDatasource.CollectionChangeEvent<E,K> e)`
`protected void`	`datasourceItemChanged(Datasource.ItemChangeEvent<E> e)`
`protected void`	`datasourceItemPropertyChanged(Datasource.ItemPropertyChangeEvent<E> e)`
`protected void`	`datasourceStateChanged(Datasource.StateChangeEvent<E> e)`
`int`	`getChildCount(E parent)`
`java.util.stream.Stream<E>`	`getChildren(E item)`
`HierarchicalDatasource<E,K>`	`getDatasource()`
`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.
`void`	`setState(BindingState state)`
`int`	`size()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - datasource
```
protected HierarchicalDatasource<E extends Entity<K>,K> datasource
```
  - events
```
protected EventHub events
```
  - state
```
protected BindingState state
```
- Constructor Detail
  - DatasourceTreeItems
```
public DatasourceTreeItems(HierarchicalDatasource<E,K> datasource)
```
- Method Detail
  - datasourceItemChanged
```
protected void datasourceItemChanged(Datasource.ItemChangeEvent<E> e)
```
  - datasourceCollectionChanged
```
protected void datasourceCollectionChanged(CollectionDatasource.CollectionChangeEvent<E,K> e)
```
  - datasourceItemPropertyChanged
```
protected void datasourceItemPropertyChanged(Datasource.ItemPropertyChangeEvent<E> e)
```
  - datasourceStateChanged
```
protected void datasourceStateChanged(Datasource.StateChangeEvent<E> e)
```
  - getDatasource
```
public HierarchicalDatasource<E,K> getDatasource()
```
  - getEntityMetaClass
```
public MetaClass getEntityMetaClass()
```
    Specified by:
    
    getEntityMetaClass in interface EntityDataUnit
    
    Returns:
    
    MetaClass of an entity contained in the source
  - getState
```
public BindingState getState()
```
    Specified by:
    
    getState in interface DataUnit
    
    Returns:
    
    a state of this source
  - setState
```
public void setState(BindingState state)
```
  - getItemId
```
public java.lang.Object getItemId(E item)
```
    Specified by:
    
    getItemId in interface TreeItems<E extends Entity<K>>
    
    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<K>>
    
    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<K>>
    
    Returns:
    
    the stream of all items
  - containsItem
```
public boolean containsItem(E item)
```
    Specified by:
    
    containsItem in interface TreeItems<E extends Entity<K>>
    
    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<K>>
    
    Returns:
    
    size of the underlying collection
  - getSelectedItem
```
public E getSelectedItem()
```
    Specified by:
    
    getSelectedItem in interface EntityTreeItems<E extends Entity<K>>
    
    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<K>>
    
    Parameters:
    
    item - the item to set
  - getChildCount
```
public int getChildCount(E parent)
```
    Specified by:
    
    getChildCount in interface TreeItems<E extends Entity<K>>
    
    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<K>>
    
    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<K>>
    
    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<K>>
    
    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<K>>
    
    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<K>>
    
    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<K>>
    
    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<K>>
    
    Parameters:
    
    listener - the listener to be added
    
    Returns:
    
    a registration object for removing an event listener added to a source

Class DatasourceTreeItems<E extends Entity<K>,K>

Nested Class Summary

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

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

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

datasource

events

state

Constructor Detail

DatasourceTreeItems

Method Detail

datasourceItemChanged

datasourceCollectionChanged

datasourceItemPropertyChanged

datasourceStateChanged

getDatasource

getEntityMetaClass

getState

setState

getItemId

getItem

getItems

containsItem

size

getSelectedItem

setSelectedItem

getChildCount

getChildren

hasChildren

getParent

getHierarchyPropertyName

addStateChangeListener

addValueChangeListener

addItemSetChangeListener

addSelectedItemChangeListener