Package io.jmix.flowui.model

Interface InstanceContainer<E>

All Known Subinterfaces:

CollectionContainer<E>, CollectionPropertyContainer<E>, InstancePropertyContainer<E>, KeyValueCollectionContainer, KeyValueContainer

All Known Implementing Classes:

CollectionContainerImpl, CollectionPropertyContainerImpl, InstanceContainerImpl, InstancePropertyContainerImpl, KeyValueCollectionContainerImpl, KeyValueContainerImpl

@NullMarked
public interface InstanceContainer<E>

The root interface in the data containers hierarchy. Data containers represent a thin layer between visual components and entity instances and collections.

InstanceContainer holds a single entity instance.

See Also:

• CollectionContainer

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	InstanceContainer.ItemChangeEvent<T>	Event sent when the entity instance selected in the container is replaced with another instance or null.
static class	InstanceContainer.ItemPropertyChangeEvent<T>	Event sent on changing a property value of the contained entity instance.

Method Summary

Modifier and Type	Method	Description
Subscription	addItemChangeListener(Consumer<InstanceContainer.ItemChangeEvent<E>> listener)	Adds listener to InstanceContainer.ItemChangeEvents.
Subscription	addItemPropertyChangeListener(Consumer<InstanceContainer.ItemPropertyChangeEvent<E>> listener)	Adds listener to InstanceContainer.ItemPropertyChangeEvents.
MetaClass	getEntityMetaClass()	Returns the meta-class of entities that can be stored in the container.
@Nullable FetchPlan	getFetchPlan()	Returns the view which was set by previous call to setFetchPlan(FetchPlan).
E	getItem()	Returns the contained entity instance.
@Nullable E	getItemOrNull()	Returns the contained entity instance or null if there is no entity in the container.
void	mute()	Disables all event listeners on container data change.
void	setFetchPlan(FetchPlan fetchPlan)	Sets a view to be used when loading entities for this container.
void	setItem(@Nullable E entity)	Sets the given entity instance to the container.
void	unmute()	Enables all event listeners.

Method Details

getItem

E getItem()

Returns the contained entity instance.

Throws:

IllegalStateException - if there is no entity in the container

setItem

void setItem(@Nullable E entity)

Sets the given entity instance to the container.

getItemOrNull

@Nullable E getItemOrNull()

Returns the contained entity instance or null if there is no entity in the container.

getEntityMetaClass

MetaClass getEntityMetaClass()

Returns the meta-class of entities that can be stored in the container.

getFetchPlan

@Nullable FetchPlan getFetchPlan()

Returns the view which was set by previous call to setFetchPlan(FetchPlan). The view is normally used when loading entities for this container.

setFetchPlan

void setFetchPlan(FetchPlan fetchPlan)

Sets a view to be used when loading entities for this container.

addItemPropertyChangeListener

Subscription addItemPropertyChangeListener(Consumer<InstanceContainer.ItemPropertyChangeEvent<E>> listener)

Adds listener to InstanceContainer.ItemPropertyChangeEvents.

addItemChangeListener

Subscription addItemChangeListener(Consumer<InstanceContainer.ItemChangeEvent<E>> listener)

Adds listener to InstanceContainer.ItemChangeEvents.

mute

void mute()

Disables all event listeners on container data change.
Can be used with unmute() for bulk data modification as a perfomance optimization.

unmute

void unmute()

Enables all event listeners. No events are fired on this call.