Package io.jmix.flowui.data.value

Class ContainerValueSource<E,V>

java.lang.Object
io.jmix.flowui.data.value.ContainerValueSource<E,V>
Type Parameters:
E - the type of entity contained in the InstanceContainer
V - the type of the bound property value
All Implemented Interfaces:
DataUnit, EntityDataUnit, EntityValueSource<E,V>, HasType<V>, ValueSource<V>, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware
Direct Known Subclasses:
BufferedContainerValueSource
public class ContainerValueSource<E,V> extends Object implements EntityValueSource<E,V>, org.springframework.context.ApplicationContextAware
Provides a value source implementation powered by an InstanceContainer. It binds a container's property with a value source that reflects changes to the property or its individual elements, and allows bidirectional updates.

  • Field Details

    • container

      protected final InstanceContainer<E> container

    • metaPropertyPath

      protected MetaPropertyPath metaPropertyPath

    • property

      protected String property

    • state

      protected BindingState state

    • events

      protected EventBus events

    • dataModelSecurityEnabled

      protected boolean dataModelSecurityEnabled

  • Constructor Details

  • Method Details

    • setDataModelSecurityEnabled

      public void setDataModelSecurityEnabled(boolean enabled)
      Sets data model security enabled for data binding.
      Caller may set false in order to disable built-in security check on data binding.
      Parameters:
      enabled - enabled flag

    • setApplicationContext

      public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
      Specified by:
      setApplicationContext in interface org.springframework.context.ApplicationContextAware

    • getEntityMetaClass

      public MetaClass getEntityMetaClass()
      Specified by:
      getEntityMetaClass in interface EntityDataUnit
      Returns:
      MetaClass of an entity contained in the source

    • getMetaPropertyPath

      public MetaPropertyPath getMetaPropertyPath()
      Specified by:
      getMetaPropertyPath in interface EntityValueSource<E,V>
      Returns:
      property path

    • getItem

      public @Nullable E getItem()
      Description copied from interface: EntityValueSource
      Returns the current item associated with the source.
      Specified by:
      getItem in interface EntityValueSource<E,V>
      Returns:
      the current item if available, or null if not set

    • isDataModelSecurityEnabled

      public boolean isDataModelSecurityEnabled()
      Specified by:
      isDataModelSecurityEnabled in interface EntityValueSource<E,V>
      Returns:
      true if data model security check is required on data binding

    • getValue

      public @Nullable V getValue()
      Description copied from interface: ValueSource
      Returns the current value stored in the value source.
      Specified by:
      getValue in interface ValueSource<E>
      Returns:
      the current value, or null if no value is set

    • setValue

      public void setValue(@Nullable V value)
      Description copied from interface: ValueSource
      Sets the given value to this value source.
      Specified by:
      setValue in interface ValueSource<E>
      Parameters:
      value - the value to be set

    • isReadOnly

      public boolean isReadOnly()
      Description copied from interface: ValueSource
      Checks whether the value source is read-only.
      Specified by:
      isReadOnly in interface ValueSource<E>
      Returns:
      true if the value source is read-only, false otherwise

    • getType

      public Class<V> getType()
      Specified by:
      getType in interface HasType<E>
      Returns:
      type of value

    • getState

      public BindingState getState()
      Specified by:
      getState in interface DataUnit
      Returns:
      a state of this source

    • addInstanceChangeListener

      public com.vaadin.flow.shared.Registration addInstanceChangeListener(Consumer<EntityValueSource.InstanceChangeEvent<E>> listener)
      Description copied from interface: EntityValueSource
      Registers a listener that will be notified when the related entity instance is changed.
      Specified by:
      addInstanceChangeListener in interface EntityValueSource<E,V>
      Parameters:
      listener - the listener to add
      Returns:
      a Registration instance that allows the removal of the listener

    • addStateChangeListener

      public com.vaadin.flow.shared.Registration 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 com.vaadin.flow.shared.Registration addValueChangeListener(Consumer<ValueSource.ValueChangeEvent<V>> listener)
      Description copied from interface: ValueSource
      Registers a new value change listener.
      Specified by:
      addValueChangeListener in interface ValueSource<E>
      Parameters:
      listener - the listener to be added
      Returns:
      a registration object for removing an event listener added to a source

    • setState

      protected void setState(BindingState state)

    • containerItemChanged

      protected void containerItemChanged(InstanceContainer.ItemChangeEvent<E> e)

    • containerItemPropertyChanged

      protected void containerItemPropertyChanged(InstanceContainer.ItemPropertyChangeEvent<E> e)

    • canUpdateMasterRefs

      protected boolean canUpdateMasterRefs()

    • updateMasterRefs

      protected void updateMasterRefs(@Nullable V value)

    • copyPropertyCollection

      protected @Nullable Collection<? extends V> copyPropertyCollection(@Nullable Collection<? extends V> propertyValue)

    • getDataContext

      protected @Nullable DataContext getDataContext()

    • getInverseProperty

      protected @Nullable MetaProperty getInverseProperty()

    • getContainer

      public InstanceContainer<E> getContainer()
      Returns the InstanceContainer associated with this value source.
      Returns:
      the associated instance container

    • isCollectionPropertyType

      protected boolean isCollectionPropertyType()

    • isEqualCollectionValue

      protected boolean isEqualCollectionValue(@Nullable V a)

    • setCollectionValue

      protected void setCollectionValue(E item, @Nullable V value)