net.sf.mmm.client.ui.base.binding

Class UiDataBindingPojoComposite<VALUE>

java.lang.Object

net.sf.mmm.client.ui.base.feature.AbstractUiFeatureValueAndValidation<VALUE>

net.sf.mmm.client.ui.base.feature.AbstractUiFeatureValueAndValidationWithValidators<VALUE>

net.sf.mmm.client.ui.base.binding.AbstractUiDataBinding<VALUE>

net.sf.mmm.client.ui.base.binding.UiDataBindingPojo<VALUE>

net.sf.mmm.client.ui.base.binding.UiDataBindingPojoComposite<VALUE>

Type Parameters:

VALUE - is the generic type of the value.

All Implemented Interfaces:

AttributeReadModified, AttributeReadValueAdvanced<VALUE>, AttributeWriteModified, AttributeWriteValueAdvanced<VALUE>, UiFeature, UiFeatureValidation<VALUE>, UiFeatureValue<VALUE>, UiFeatureValueAndValidation<VALUE>, UiDataBinding<VALUE>, AttributeReadValue<VALUE>, AttributeWriteValue<VALUE>, AbstractValidatableObject, HasValueValidators<VALUE>, ValidatableObject<VALUE>

public class UiDataBindingPojoComposite<VALUE>
extends UiDataBindingPojo<VALUE>

This is the implementation of UiDataBinding for composite custom widgets.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private Map<TypedProperty<?>,List<UiWidgetWithValue<?>>>	property2widgetMap

Constructor Summary

Constructors

Constructor and Description
UiDataBindingPojoComposite(AbstractUiWidget<VALUE> widget, UiDataBindingAdapter<VALUE> adapter) The constructor.

Method Summary

Modifier and Type	Method and Description
<P> void	bind(TypedProperty<P> property, UiWidgetWithValue<P> widget) This method binds the given widget to the given property.
<P> UiWidgetWithValue<P>	createAndBind(TypedProperty<P> property, String label) This method is like UiDataBinding.createAndBind(TypedProperty) but using the given label instead of deriving it automatically.
protected <P> UiWidgetWithValue<P>	createWidget(TypedProperty<P> property, String label) Creates the UiWidgetWithValue for the given property using the given label.
protected VALUE	doGetValue(VALUE template, ValidationState state) This method is called from AbstractUiFeatureValueAndValidation.getValueOrException(Object).
protected void	doSetValue(VALUE value, boolean forUser) This method is called from AbstractUiDataBinding.setValue(Object, boolean).
private boolean	verifyNotInList(List<UiWidgetWithValue<?>> list, UiWidgetWithValue<?> widget, TypedProperty<?> property) Verifies that the given widget is NOT already contained in the given list.

Methods inherited from class net.sf.mmm.client.ui.base.binding.UiDataBindingPojo

createCopyOfValue, createNewValue, createPropertyAccessor, createPropertyAccessor, getAdapter

Methods inherited from class net.sf.mmm.client.ui.base.binding.AbstractUiDataBinding

addChangeHandler, createAndBind, createValidationFailure, getLabel, getLogger, getOriginalValue, getRecentValue, getSource, getValidity, getValueDirect, getWidget, isModified, removeChangeHandler, setMandatory, setModified, setValidity, setValue, toString

Methods inherited from class net.sf.mmm.client.ui.base.feature.AbstractUiFeatureValueAndValidationWithValidators

addValidator, doValidate, isMandatory, isMandatory, removeValidator

Methods inherited from class net.sf.mmm.client.ui.base.feature.AbstractUiFeatureValueAndValidation

addValidatorMandatory, clearValidity, getValue, getValueAndValidate, getValueOrException, handleGetValueError, resetValue, setValue, setValueForUser, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sf.mmm.client.ui.base.binding.UiDataBinding

doValidate

Methods inherited from interface net.sf.mmm.client.ui.api.feature.UiFeatureValueAndValidation

getValueAndValidate

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeWriteValueAdvanced

resetValue, setValue, setValueForUser

Methods inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadValueAdvanced

getValue, getValueOrException

Methods inherited from interface net.sf.mmm.client.ui.api.feature.UiFeatureValidation

addValidatorMandatory, isMandatory

Methods inherited from interface net.sf.mmm.util.validation.api.HasValueValidators

addValidator, removeValidator

Methods inherited from interface net.sf.mmm.util.validation.api.AbstractValidatableObject

validate

Field Detail

property2widgetMap

private final Map<TypedProperty<?>,List<UiWidgetWithValue<?>>> property2widgetMap

See Also:

bind(TypedProperty, UiWidgetWithValue)

Constructor Detail

UiDataBindingPojoComposite

public UiDataBindingPojoComposite(AbstractUiWidget<VALUE> widget,
                                  UiDataBindingAdapter<VALUE> adapter)

The constructor.

Parameters:

widget - is the widget to bind.

adapter - is the UiDataBindingAdapter.

Method Detail

bind

public <P> void bind(TypedProperty<P> property,
                     UiWidgetWithValue<P> widget)

This method binds the given widget to the given property. This will have to following effects:

• UiFeatureValueAndValidation.getValueDirect(Object, net.sf.mmm.util.validation.api.ValidationState) and therefore all other getValue* methods will automatically read the value of the given widget and set it to the given property of the <VALUE> to return.
• AttributeWriteValueAdvanced.setValue(Object, boolean) and therefore all other setValue* methods will automatically get the property-value of the given property from the <VALUE>-object and set that property-value to the given widget.

Specified by:

bind in interface UiDataBinding<VALUE>

Overrides:

bind in class AbstractUiDataBinding<VALUE>

Type Parameters:

P - is the generic type of the property value.

Parameters:

property - is the TypedProperty representing the property to bind. It has to be a property of <VALUE>.

widget - is the value based widget to bind to the given property.

See Also:

UiDataBinding.createAndBind(TypedProperty)

verifyNotInList

private boolean verifyNotInList(List<UiWidgetWithValue<?>> list,
                                UiWidgetWithValue<?> widget,
                                TypedProperty<?> property)

Verifies that the given widget is NOT already contained in the given list.

Parameters:

list - is the List to check.

widget - is the UiWidgetWithValue to check.

property - is the TypedProperty used for the potential error mesasage.

Returns:

true.

createAndBind

public <P> UiWidgetWithValue<P> createAndBind(TypedProperty<P> property,
                                              String label)

This method is like UiDataBinding.createAndBind(TypedProperty) but using the given label instead of deriving it automatically.

Specified by:

createAndBind in interface UiDataBinding<VALUE>

Overrides:

createAndBind in class AbstractUiDataBinding<VALUE>

Type Parameters:

P - is the generic type of the property value.

Parameters:

property - is the TypedProperty representing the property to bind. It has to be a property of <VALUE> and contain its property type.

label - is the label to use for the widget. See UiWidgetField.getLabel().

Returns:

a new widget to view and edit the given property. It will already been bound.

createWidget

protected <P> UiWidgetWithValue<P> createWidget(TypedProperty<P> property,
                                                String label)

Creates the UiWidgetWithValue for the given property using the given label.

Type Parameters:

P - is the generic property type.

Parameters:

property - is the TypedProperty.

label - is the label for the widget or null to determine automatically.

Returns:

the new UiWidgetWithValue for the given input.

doGetValue

protected VALUE doGetValue(VALUE template,
                           ValidationState state)

This method is called from AbstractUiFeatureValueAndValidation.getValueOrException(Object). It has to be implemented with the custom logic to get the value from the view. The implementation of this method has to correspond with the implementation of AbstractUiDataBinding.doSetValue(Object, boolean). A typical implementation of this method for a composite widget should look like this:

Overrides:

doGetValue in class AbstractUiDataBinding<VALUE>

Parameters:

template - is the object where the data is filled in. May only be null if AbstractUiDataBinding.createNewValue() does.

state - is the ValidationState. May be null (if the validation is omitted). Should only be used to propagate to AbstractUiDataBinding.getValueDirect(Object, ValidationState) of children.

Returns:

the current value of this widget. May be null if empty. If <VALUE> is String the empty String has to be returned if no value has been entered. In case <VALUE> is a mutable object (java bean) and template is NOT null, this method is supposed to return template after the value(s) of this object have been assigned. If template is null this method has to create a new instance of <VALUE>. It is forbidden and an explicit bug-pattern to modify the original value. This is required to support operations such as AbstractUiFeatureValueAndValidation.resetValue().

See Also:

AbstractUiDataBinding.doSetValue(Object, boolean)

doSetValue

protected void doSetValue(VALUE value,
                          boolean forUser)

This method is called from AbstractUiDataBinding.setValue(Object, boolean). It has to be implemented with the custom logic to set the value in the view. The implementation of this method has to correspond with the implementation of AbstractUiDataBinding.doGetValue(Object, ValidationState).

Overrides:

doSetValue in class AbstractUiDataBinding<VALUE>

Parameters:

value - is the value to set. Typically a composite object (e.g. java bean) so its attributes are set to fields (see UiWidgetField).

forUser - true if called from AbstractUiFeatureValueAndValidation.setValueForUser(Object), false if set from AbstractUiFeatureValueAndValidation.setValue(Object).

See Also:

AbstractUiDataBinding.doGetValue(Object, ValidationState)