com.haulmont.cuba.gui.model

Interface InstanceContainer<E extends Entity>

All Known Subinterfaces:

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

All Known Implementing Classes:

CollectionContainerImpl, CollectionPropertyContainerImpl, InstanceContainerImpl, InstancePropertyContainerImpl, KeyValueCollectionContainerImpl, KeyValueContainerImpl

public interface InstanceContainer<E extends Entity>

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 and Description
static class	InstanceContainer.ItemChangeEvent<T extends Entity> Event sent when the entity instance selected in the container is replaced with another instance or null.
static class	InstanceContainer.ItemPropertyChangeEvent<T extends Entity> Event sent on changing a property value of the contained entity instance.

Method Summary

Modifier and Type	Method and Description
Subscription	addItemChangeListener(java.util.function.Consumer<InstanceContainer.ItemChangeEvent<E>> listener) Adds listener to InstanceContainer.ItemChangeEvents.
Subscription	addItemPropertyChangeListener(java.util.function.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.
E	getItem() Returns the contained entity instance.
E	getItemOrNull() Returns the contained entity instance or null if there is no entity in the container.
View	getView() Returns the view which was set by previous call to setView(View).
void	mute() Disables all event listeners on container data change.
void	setItem(E entity) Sets the given entity instance to the container.
void	setView(View view) Sets a view to be used when loading entities for this container.
void	unmute() Enables all event listeners.

Method Detail

getItem

@Nonnull
E getItem()

Returns the contained entity instance.

Throws:

java.lang.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.

getView

@Nullable
View getView()

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

setView

void setView(View view)

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

addItemPropertyChangeListener

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

Adds listener to InstanceContainer.ItemPropertyChangeEvents.

addItemChangeListener

Subscription addItemChangeListener(java.util.function.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.