Package io.jmix.ui.component.data.options

Class ContainerOptions<E>

java.lang.Object

io.jmix.ui.component.data.options.ContainerOptions<E>

Type Parameters:

E - entity type

All Implemented Interfaces:

DataUnit, ContainerDataUnit<E>, EntityDataUnit, EntityOptions<E>, Options<E>

public class ContainerOptions<E>
extends Object
implements Options<E>, EntityOptions<E>, ContainerDataUnit<E>

Options based on a data container.

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.meta.EntityOptions

EntityOptions.ValueChangeEvent<T>

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

Options.OptionsChangeEvent<T>

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
ContainerOptions(CollectionContainer<E> container)

Method Summary

Modifier and Type	Method	Description
Subscription	addOptionsChangeListener(Consumer<Options.OptionsChangeEvent<E>> listener)
Subscription	addStateChangeListener(Consumer<DataUnit.StateChangeEvent> listener)	Registers a new state change listener.
Subscription	addValueChangeListener(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()
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 Details

container

protected CollectionContainer<E> container

loader

protected DataLoader loader

events

protected EventHub events

deferredSelectedItem

protected E deferredSelectedItem

Constructor Details

ContainerOptions

public ContainerOptions(CollectionContainer<E> container)

Method Details

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

setSelectedItem

public void setSelectedItem(@Nullable
 E item)

Description copied from interface: EntityOptions

Set current item in the source.

Specified by:

setSelectedItem in interface EntityOptions<E>

Parameters:

item - the item to set

containsItem

public boolean containsItem(@Nullable
 E item)

Specified by:

containsItem in interface EntityOptions<E>

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>

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>

getOptions

public Stream<E> getOptions()

Specified by:

getOptions in interface Options<E>

getState

public BindingState getState()

Specified by:

getState in interface DataUnit

Returns:

a state of this source

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<EntityOptions.ValueChangeEvent<E>> listener)

Specified by:

addValueChangeListener in interface EntityOptions<E>

addOptionsChangeListener

public Subscription addOptionsChangeListener(Consumer<Options.OptionsChangeEvent<E>> listener)

Specified by:

addOptionsChangeListener in interface Options<E>

getContainer

public CollectionContainer<E> getContainer()

Specified by:

getContainer in interface ContainerDataUnit<E>