ContainerOptions (CUBA 7.2 API)

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

Type Parameters:

E - entity type

K - entity key type

All Implemented Interfaces:

DataUnit, ContainerDataUnit<E>, EntityDataUnit, EntityOptions<E>, Options<E>
```
public class ContainerOptions<E extends Entity<K>,K>
extends java.lang.Object
implements Options<E>, EntityOptions<E>, ContainerDataUnit<E>
```
Options based on a data container.

Nested Class Summary
- Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.data.meta.EntityOptions
  EntityOptions.ValueChangeEvent<T>
- Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.data.Options
  Options.OptionsChangeEvent<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 E deferredSelectedItem

protected EventHub events

protected DataLoader loader

Fields
Modifier and Type	Field and Description
`protected CollectionContainer<E>`	`container`
`protected E`	`deferredSelectedItem`
`protected EventHub`	`events`
`protected DataLoader`	`loader`

Constructor Summary

Constructors
Constructor and Description

ContainerOptions(CollectionContainer<E> container)

Constructors
Constructor and Description
`ContainerOptions(CollectionContainer<E> container)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Subscription`	`addOptionsChangeListener(java.util.function.Consumer<Options.OptionsChangeEvent<E>> listener)`
`Subscription`	`addStateChangeListener(java.util.function.Consumer<DataUnit.StateChangeEvent> listener)` Registers a new state change listener.
`Subscription`	`addValueChangeListener(java.util.function.Consumer<EntityOptions.ValueChangeEvent<E>> listener)`
`protected void`	`containerCollectionChanged(CollectionContainer.CollectionChangeEvent<E> e)`
`protected void`	`containerItemPropertyChanged(InstanceContainer.ItemPropertyChangeEvent<E> e)`
`boolean`	`containsItem(E item)`
`CollectionContainer<E>`	`getContainer()`
`MetaClass`	`getEntityMetaClass()`
`java.util.stream.Stream<E>`	`getOptions()`
`BindingState`	`getState()`
`void`	`refresh()` Refreshes the source moving it to the `BindingState.ACTIVE` state
`void`	`setSelectedItem(E item)` Set current item in the source.
`void`	`updateItem(E item)` Update an item in the collection if it is already there.

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

- Field Detail
  - container
```
protected CollectionContainer<E extends Entity<K>> container
```
  - loader
```
protected DataLoader loader
```
  - events
```
protected EventHub events
```
  - deferredSelectedItem
```
protected E extends Entity<K> deferredSelectedItem
```
- Constructor Detail
  - ContainerOptions
```
public ContainerOptions(CollectionContainer<E> container)
```
- Method Detail
  - 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
  - setSelectedItem
```
public void setSelectedItem(E item)
```
    Description copied from interface: EntityOptions
    
    Set current item in the source.
    
    Specified by:
    
    setSelectedItem in interface EntityOptions<E extends Entity<K>>
    
    Parameters:
    
    item - the item to set
  - containsItem
```
public boolean containsItem(E item)
```
    Specified by:
    
    containsItem in interface EntityOptions<E extends Entity<K>>
    
    Returns:
    
    true if the underlying collection contains an item with the specified ID
  - updateItem
```
public void updateItem(E item)
```
    Description copied from interface: EntityOptions
    
    Update an item in the collection if it is already there.
    
    Specified by:
    
    updateItem in interface EntityOptions<E extends Entity<K>>
  - refresh
```
public void refresh()
```
    Description copied from interface: EntityOptions
    
    Refreshes the source moving it to the BindingState.ACTIVE state
    
    Specified by:
    
    refresh in interface EntityOptions<E extends Entity<K>>
  - getOptions
```
public java.util.stream.Stream<E> getOptions()
```
    Specified by:
    
    getOptions in interface Options<E extends Entity<K>>
  - getState
```
public BindingState getState()
```
    Specified by:
    
    getState in interface DataUnit
    
    Returns:
    
    a state of this source
  - 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<EntityOptions.ValueChangeEvent<E>> listener)
```
    Specified by:
    
    addValueChangeListener in interface EntityOptions<E extends Entity<K>>
  - addOptionsChangeListener
```
public Subscription addOptionsChangeListener(java.util.function.Consumer<Options.OptionsChangeEvent<E>> listener)
```
    Specified by:
    
    addOptionsChangeListener in interface Options<E extends Entity<K>>
  - getContainer
```
public CollectionContainer<E> getContainer()
```
    Specified by:
    
    getContainer in interface ContainerDataUnit<E extends Entity<K>>

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

Nested Class Summary

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

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

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

container

loader

events

deferredSelectedItem

Constructor Detail

ContainerOptions

Method Detail

containerCollectionChanged

containerItemPropertyChanged

getEntityMetaClass

setSelectedItem

containsItem

updateItem

refresh

getOptions

getState

addStateChangeListener

addValueChangeListener

addOptionsChangeListener

getContainer