Package io.jmix.flowui.data

Interface EntityValueSource<E,V>

Type Parameters:

E - the type of the entity tied to this value source

V - the type of the value provided by this value source

All Superinterfaces:

DataUnit, EntityDataUnit, HasType<V>, ValueSource<V>

All Known Implementing Classes:

BufferedContainerValueSource, ContainerValueSource

@NullMarked
public interface EntityValueSource<E,V>
extends ValueSource<V>, EntityDataUnit

A specialized ValueSource that represents a data source tied to an entity instance and its properties within a data-aware context.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	EntityValueSource.InstanceChangeEvent<E>	An event fired when related entity instance is changed.

Nested classes/interfaces inherited from interface io.jmix.flowui.data.DataUnit

DataUnit.StateChangeEvent

Nested classes/interfaces inherited from interface io.jmix.flowui.data.ValueSource

ValueSource.ValueChangeEvent<V>

Method Summary

Modifier and Type	Method	Description
com.vaadin.flow.shared.Registration	addInstanceChangeListener(Consumer<EntityValueSource.InstanceChangeEvent<E>> listener)	Registers a listener that will be notified when the related entity instance is changed.
@Nullable E	getItem()	Returns the current item associated with the source.
MetaPropertyPath	getMetaPropertyPath()
boolean	isDataModelSecurityEnabled()

Methods inherited from interface io.jmix.flowui.data.DataUnit

addStateChangeListener, getState

Methods inherited from interface io.jmix.flowui.data.EntityDataUnit

getEntityMetaClass

Methods inherited from interface io.jmix.flowui.data.HasType

getType

Methods inherited from interface io.jmix.flowui.data.ValueSource

addValueChangeListener, getValue, isReadOnly, setValue

Method Details

getItem

@Nullable E getItem()

Returns the current item associated with the source.

Returns:

the current item if available, or null if not set

getMetaPropertyPath

MetaPropertyPath getMetaPropertyPath()

Returns:

property path

isDataModelSecurityEnabled

boolean isDataModelSecurityEnabled()

Returns:

true if data model security check is required on data binding

addInstanceChangeListener

com.vaadin.flow.shared.Registration addInstanceChangeListener(Consumer<EntityValueSource.InstanceChangeEvent<E>> listener)

Registers a listener that will be notified when the related entity instance is changed.

Parameters:

listener - the listener to add

Returns:

a Registration instance that allows the removal of the listener