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

Class ListEntityOptions<E>

java.lang.Object

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

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

Type Parameters:

E - entity type

All Implemented Interfaces:

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

public class ListEntityOptions<E>
extends ListOptions<E>
implements Options<E>, EntityOptions<E>

Options based on a simple collection that contains entities.

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 Metadata	metadata
protected E	selectedItem

Fields inherited from class io.jmix.ui.component.data.options.ListOptions

options

Constructor Summary

Constructors

Constructor	Description
ListEntityOptions(List<E> options, Metadata metadata)

Method Summary

Modifier and Type	Method	Description
Subscription	addValueChangeListener(Consumer<EntityOptions.ValueChangeEvent<E>> listener)
boolean	containsItem(E item)
MetaClass	getEntityMetaClass()
List<E>	getItemsCollection()
E	getSelectedItem()
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 io.jmix.ui.component.data.options.ListOptions

addOptionsChangeListener, addStateChangeListener, empty, getOptions, getState, of

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.ui.component.data.DataUnit

addStateChangeListener, getState

Methods inherited from interface io.jmix.ui.component.data.Options

addOptionsChangeListener, getOptions

Field Details

metadata

protected Metadata metadata

selectedItem

protected E selectedItem

Constructor Details

ListEntityOptions

public ListEntityOptions(List<E> options,
 Metadata metadata)

Method Details

getItemsCollection

public List<E> getItemsCollection()

Overrides:

getItemsCollection in class ListOptions<E>

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

getSelectedItem

@Nullable
public E getSelectedItem()

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>

addValueChangeListener

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

Specified by:

addValueChangeListener in interface EntityOptions<E>

getEntityMetaClass

@Nullable
public MetaClass getEntityMetaClass()

Specified by:

getEntityMetaClass in interface EntityDataUnit

Returns:

MetaClass of an entity contained in the source