com.haulmont.cuba.gui.components.data.value

Class ContainerValueSource<E extends Entity,V>

java.lang.Object

com.haulmont.cuba.gui.components.data.value.ContainerValueSource<E,V>

All Implemented Interfaces:

BeanLocatorAware, DataUnit, EntityDataUnit, EntityValueSource<E,V>, ValueSource<V>

public class ContainerValueSource<E extends Entity,V>
extends java.lang.Object
implements EntityValueSource<E,V>, BeanLocatorAware

Nested Class Summary

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.data.meta.EntityValueSource

EntityValueSource.InstanceChangeEvent<E extends Entity>

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.data.ValueSource

ValueSource.ValueChangeEvent<V>

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.data.DataUnit

DataUnit.StateChangeEvent

Field Summary

Fields

Modifier and Type	Field and Description
protected InstanceContainer<E>	container
protected boolean	dataModelSecurityEnabled
protected EventHub	events
protected MetaPropertyPath	metaPropertyPath
protected java.lang.String	property
protected BindingState	state

Constructor Summary

Constructors

Constructor and Description
ContainerValueSource(InstanceContainer<E> container, java.lang.String property)

Method Summary

Modifier and Type	Method and Description
Subscription	addInstanceChangeListener(java.util.function.Consumer<EntityValueSource.InstanceChangeEvent<E>> listener)
Subscription	addStateChangeListener(java.util.function.Consumer<DataUnit.StateChangeEvent> listener) Registers a new state change listener.
Subscription	addValueChangeListener(java.util.function.Consumer<ValueSource.ValueChangeEvent<V>> listener) Registers a new value change listener.
protected boolean	canUpdateMasterRefs()
protected void	containerItemChanged(InstanceContainer.ItemChangeEvent e)
protected void	containerItemPropertyChanged(InstanceContainer.ItemPropertyChangeEvent e)
protected java.util.Collection<? extends V>	copyPropertyCollection(java.util.Collection<? extends V> propertyValue)
InstanceContainer<E>	getContainer()
protected DataContext	getDataContext()
MetaClass	getEntityMetaClass()
protected MetaProperty	getInverseProperty()
E	getItem()
MetaPropertyPath	getMetaPropertyPath()
BindingState	getState()
java.lang.Class<V>	getType()
V	getValue()
boolean	isDataModelSecurityEnabled()
boolean	isReadOnly()
void	setBeanLocator(BeanLocator beanLocator)
void	setDataModelSecurityEnabled(boolean enabled) Sets data model security enabled for data binding.
protected void	setState(BindingState state)
void	setValue(V value)
protected void	updateMasterRefs(V value)

Methods inherited from class java.lang.Object

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

Field Detail

container

protected final InstanceContainer<E extends Entity> container

metaPropertyPath

protected MetaPropertyPath metaPropertyPath

property

protected java.lang.String property

state

protected BindingState state

events

protected EventHub events

dataModelSecurityEnabled

protected boolean dataModelSecurityEnabled

Constructor Detail

ContainerValueSource

public ContainerValueSource(InstanceContainer<E> container,
                            java.lang.String property)

Method Detail

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

setBeanLocator

public void setBeanLocator(BeanLocator beanLocator)

Specified by:

setBeanLocator in interface BeanLocatorAware

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 extends Entity,V>

Returns:

property path

getItem

public E getItem()

Specified by:

getItem in interface EntityValueSource<E extends Entity,V>

Returns:

entity

isDataModelSecurityEnabled

public boolean isDataModelSecurityEnabled()

Specified by:

isDataModelSecurityEnabled in interface EntityValueSource<E extends Entity,V>

Returns:

true if data model security check is required on data binding

getValue

public V getValue()

Specified by:

getValue in interface ValueSource<V>

setValue

public void setValue(V value)

Specified by:

setValue in interface ValueSource<V>

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface ValueSource<V>

getType

public java.lang.Class<V> getType()

Specified by:

getType in interface ValueSource<V>

Returns:

type of value

getState

public BindingState getState()

Specified by:

getState in interface DataUnit

Returns:

a state of this source

addInstanceChangeListener

public Subscription addInstanceChangeListener(java.util.function.Consumer<EntityValueSource.InstanceChangeEvent<E>> listener)

Specified by:

addInstanceChangeListener in interface EntityValueSource<E extends Entity,V>

addStateChangeListener

public Subscription addStateChangeListener(java.util.function.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 Subscription addValueChangeListener(java.util.function.Consumer<ValueSource.ValueChangeEvent<V>> listener)

Description copied from interface: ValueSource

Registers a new value change listener.

Specified by:

addValueChangeListener in interface ValueSource<V>

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)

containerItemPropertyChanged

protected void containerItemPropertyChanged(InstanceContainer.ItemPropertyChangeEvent e)

canUpdateMasterRefs

protected boolean canUpdateMasterRefs()

updateMasterRefs

protected void updateMasterRefs(V value)

copyPropertyCollection

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

getDataContext

@Nullable
protected DataContext getDataContext()

getInverseProperty

@Nullable
protected MetaProperty getInverseProperty()

getContainer

public InstanceContainer<E> getContainer()