net.sf.mmm.client.ui.api.feature

Interface UiFeatureValueAndValidation<VALUE>

Type Parameters:

VALUE - is the generic type of the value.

All Superinterfaces:

AbstractValidatableObject, AttributeReadValue<VALUE>, AttributeReadValueAdvanced<VALUE>, AttributeWriteValue<VALUE>, AttributeWriteValueAdvanced<VALUE>, HasValueValidators<VALUE>, UiFeature, UiFeatureValidation<VALUE>, UiFeatureValue<VALUE>, ValidatableObject<VALUE>

All Known Subinterfaces:

UiDataBinding<VALUE>, UiWidgetAbstractListTable<ROW>, UiWidgetAbstractTree<NODE>, UiWidgetCheckboxesField<VALUE>, UiWidgetCheckboxField, UiWidgetCodeAreaField, UiWidgetColorField, UiWidgetComboboxField<VALUE>, UiWidgetDateField, UiWidgetDoubleField, UiWidgetField<VALUE>, UiWidgetFileField, UiWidgetInstantField, UiWidgetIntegerField, UiWidgetIntegerSliderField, UiWidgetListBase<ROW>, UiWidgetListBoxField<VALUE>, UiWidgetListContainer<ITEM>, UiWidgetListTable<ROW>, UiWidgetLocalDateField, UiWidgetLocalTimeField, UiWidgetLongField, UiWidgetOptionListTable<ROW>, UiWidgetOptionsField<VALUE>, UiWidgetPasswordField, UiWidgetRadioButtonsField<VALUE>, UiWidgetRadioButtonsVerticalField<VALUE>, UiWidgetRangeField<VALUE>, UiWidgetRichTextField, UiWidgetTextAreaField, UiWidgetTextField, UiWidgetTextualInputField<VALUE>, UiWidgetToggleButton, UiWidgetTree<NODE>, UiWidgetTreeTable<NODE>, UiWidgetWithValue<VALUE>

All Known Implementing Classes:

AbstractUiDataBinding, AbstractUiFeatureValueAndValidation, AbstractUiFeatureValueAndValidationWithValidators, AbstractUiWidget, AbstractUiWidgetAbstractBorderPanel, AbstractUiWidgetAbstractButton, AbstractUiWidgetAbstractButtonContainer, AbstractUiWidgetAbstractDataSet, AbstractUiWidgetAbstractDataTable, AbstractUiWidgetAbstractDialogWindow, AbstractUiWidgetAbstractListTable, AbstractUiWidgetAbstractWindow, AbstractUiWidgetActive, AbstractUiWidgetBorderPanel, AbstractUiWidgetButton, AbstractUiWidgetButtonGroup, AbstractUiWidgetButtonPanel, AbstractUiWidgetCheckboxField, AbstractUiWidgetClickable, AbstractUiWidgetCodeAreaField, AbstractUiWidgetCollapsableBorderPanel, AbstractUiWidgetCollapsableSection, AbstractUiWidgetColorField, AbstractUiWidgetComboboxField, AbstractUiWidgetComposite, AbstractUiWidgetCustomMasterDetail, AbstractUiWidgetCustomTwoListSelection, AbstractUiWidgetDateField, AbstractUiWidgetDoubleField, AbstractUiWidgetDynamicComposite, AbstractUiWidgetDynamicPanel, AbstractUiWidgetField, AbstractUiWidgetFileField, AbstractUiWidgetGridCell, AbstractUiWidgetGridPanel, AbstractUiWidgetGridRow, AbstractUiWidgetHorizontalPanel, AbstractUiWidgetHorizontalSplitPanel, AbstractUiWidgetImage, AbstractUiWidgetInstantField, AbstractUiWidgetIntegerField, AbstractUiWidgetIntegerSliderField, AbstractUiWidgetLabel, AbstractUiWidgetLink, AbstractUiWidgetListBoxField, AbstractUiWidgetListTable, AbstractUiWidgetLocalDateField, AbstractUiWidgetLocalTimeField, AbstractUiWidgetLongField, AbstractUiWidgetMainWindow, AbstractUiWidgetMenu, AbstractUiWidgetMenuBar, AbstractUiWidgetMenuItemClickable, AbstractUiWidgetMenuItemSeparator, AbstractUiWidgetNative, AbstractUiWidgetNumberField, AbstractUiWidgetOptionsField, AbstractUiWidgetPasswordField, AbstractUiWidgetPopup, AbstractUiWidgetRadioButtonsField, AbstractUiWidgetRadioButtonsVerticalField, AbstractUiWidgetRangeField, AbstractUiWidgetRegularAtomic, AbstractUiWidgetRichTextField, AbstractUiWidgetSection, AbstractUiWidgetSingleComposite, AbstractUiWidgetSingleMutableComposite, AbstractUiWidgetSlot, AbstractUiWidgetSplitPanel, AbstractUiWidgetSwitchComposite, AbstractUiWidgetTab, AbstractUiWidgetTableColumn, AbstractUiWidgetTabPanel, AbstractUiWidgetTextAreaField, AbstractUiWidgetTextAreaFieldBase, AbstractUiWidgetTextField, AbstractUiWidgetTextFieldBase, AbstractUiWidgetTextualInputField, AbstractUiWidgetToggleButton, AbstractUiWidgetToolbar, AbstractUiWidgetTree, AbstractUiWidgetVerticalPanel, AbstractUiWidgetVerticalSplitPanel, AbstractUiWidgetWindow, AbstractUiWidgetWithLabel, UiDataBindingDatatype, UiDataBindingList, UiDataBindingNone, UiDataBindingPojo, UiDataBindingPojoComposite, UiWidgetBorderPanelGwt, UiWidgetBorderPanelTestImpl, UiWidgetButtonGroupGwt, UiWidgetButtonGwt, UiWidgetButtonPanelGwt, UiWidgetButtonTestImpl, UiWidgetCheckboxFieldGwt, UiWidgetCheckboxFieldTestImpl, UiWidgetCodeAreaFieldTestImpl, UiWidgetCollapsableBorderPanelGwt, UiWidgetCollapsableSectionGwt, UiWidgetCollapsableSectionTestImpl, UiWidgetColorFieldGwt, UiWidgetColorFieldTestImpl, UiWidgetComboboxFieldGwt, UiWidgetComboboxFieldTestImpl, UiWidgetCustom, UiWidgetCustomAbstractDialogWindow, UiWidgetCustomAbstractListTable, UiWidgetCustomAbstractWindow, UiWidgetCustomAtomicNoValue, UiWidgetCustomButton, UiWidgetCustomButtonSave, UiWidgetCustomComposite, UiWidgetCustomCompositeNoValue, UiWidgetCustomDynamicComposite, UiWidgetCustomEditor, UiWidgetCustomField, UiWidgetCustomFieldAtomic, UiWidgetCustomFieldComposite, UiWidgetCustomFormEditor, UiWidgetCustomGridPanel, UiWidgetCustomListTable, UiWidgetCustomMasterDetail, UiWidgetCustomPanel, UiWidgetCustomPopup, UiWidgetCustomVerticalPanel, UiWidgetDateFieldGwt, UiWidgetDateFieldTestImpl, UiWidgetDoubleFieldGwt, UiWidgetDoubleFieldTestImpl, UiWidgetFileFieldGwt, UiWidgetFileFieldTestImpl, UiWidgetGridCellGwt, UiWidgetGridCellTestImpl, UiWidgetGridPanelGwt, UiWidgetGridPanelTestImpl, UiWidgetGridRowGwt, UiWidgetGridRowTestImpl, UiWidgetHorizontalPanelGwt, UiWidgetHorizontalPanelTestImpl, UiWidgetHorizontalSplitPanelGwt, UiWidgetImageGwt, UiWidgetImageTestImpl, UiWidgetIntegerFieldGwt, UiWidgetIntegerFieldTestImpl, UiWidgetIntegerSliderFieldGwt, UiWidgetIntegerSliderFieldTestImpl, UiWidgetLabelGwt, UiWidgetLabelTestImpl, UiWidgetLinkGwt, UiWidgetLinkTestImpl, UiWidgetListTableGwt, UiWidgetLocalDateFieldGwt, UiWidgetLocalDateFieldTestImpl, UiWidgetLocalTimeFieldGwt, UiWidgetLocalTimeFieldTestImpl, UiWidgetLongFieldGwt, UiWidgetLongFieldTestImpl, UiWidgetMainWindowGwt, UiWidgetMainWindowTestImpl, UiWidgetMenuBarGwt, UiWidgetMenuBarTestImpl, UiWidgetMenuGwt, UiWidgetMenuItemClickableGwt, UiWidgetMenuItemClickableTestImpl, UiWidgetMenuItemSeparatorGwt, UiWidgetMenuItemSeparatorTestImpl, UiWidgetMenuTestImpl, UiWidgetPasswordFieldGwt, UiWidgetPasswordFieldTestImpl, UiWidgetPopupGwt, UiWidgetPopupTestImpl, UiWidgetRadioButtonsFieldGwt, UiWidgetRadioButtonsTestImpl, UiWidgetRadioButtonsVerticalFieldGwt, UiWidgetRadioButtonsVerticalFieldTestImpl, UiWidgetRichTextFieldGwt, UiWidgetRichTextFieldTestImpl, UiWidgetSectionGwt, UiWidgetSectionTestImpl, UiWidgetSlotGwt, UiWidgetSlotTestImpl, UiWidgetTabGwt, UiWidgetTableColumnImpl, UiWidgetTabPanelGwt, UiWidgetTabPanelTestImpl, UiWidgetTabTestImpl, UiWidgetTextAreaFieldGwt, UiWidgetTextAreaFieldTestImpl, UiWidgetTextFieldGwt, UiWidgetTextFieldTestImpl, UiWidgetToggleButtonGwt, UiWidgetToolbarGwt, UiWidgetTreeGwt, UiWidgetTreeTestImpl, UiWidgetVerticalPanelGwt, UiWidgetVerticalPanelTestImpl, UiWidgetVerticalSplitPanelGwt, UiWidgetWindowGwt

public interface UiFeatureValueAndValidation<VALUE>
extends UiFeatureValue<VALUE>, UiFeatureValidation<VALUE>

This is the interface for the combination of UiFeatureValue and UiFeatureValidation.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
VALUE	getValueAndValidate(ValidationState state) This method is a combination of AttributeReadValueAdvanced.getValue() and AbstractValidatableObject.validate(ValidationState).
VALUE	getValueDirect(VALUE template, ValidationState state) This method is a combination of AttributeReadValueAdvanced.getValueOrException(Object) and AbstractValidatableObject.validate(ValidationState).

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

addChangeHandler, removeChangeHandler

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

resetValue, setValue, setValue, setValueForUser

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

getOriginalValue, 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

Method Detail

getValueAndValidate

VALUE getValueAndValidate(ValidationState state)

This method is a combination of AttributeReadValueAdvanced.getValue() and AbstractValidatableObject.validate(ValidationState). It is designed for API users implementing higher level dialog logic and is therefore easy to use. It performs a validation and only on success it returns the value.
ATTENTION:
The method design assumes that null is not a valid value. Never call this method with null as argument if <VALUE> is Void or anything else that considers null as a valid value. It should be used for high-level UI nodes such as entire input forms or (sub-)dialogs.

Parameters:

state - is the ValidationState. Shall initially be created as new instance and passed on in case of recursive validations. May also be null and will then be created internally (in case you do not need the validation result).

Returns:

the actual value or null if the validation failed or null is the actual (valid) value.

getValueDirect

VALUE getValueDirect(VALUE template,
                     ValidationState state)
              throws RuntimeException

This method is a combination of AttributeReadValueAdvanced.getValueOrException(Object) and AbstractValidatableObject.validate(ValidationState). It allows more efficient implementations as determining and creating the value can be expensive. Saving changes requires validation AND on success getting the value, while already validation requires getting the value. For composite UI objects this effect would reinforce to multiply the number of calls to AttributeReadValueAdvanced.getValueOrException(Object).
NOTE:
This method is designed for implementors of composite UI objects. API users should only use getValueAndValidate(ValidationState).

Parameters:

template - is the object where the data is filled in. May also be null - then this method will create a new instance.

state - is the ValidationState. If null the validation will be omitted, otherwise an implicit validation is performed.

Returns:

the current value. May be null (esp. if invalid).

Throws:

RuntimeException - if state is null no validation is performed and input errors are directly thrown causing a fast fail. Otherwise if validation is performed all RuntimeException are catched and according validation failures are collected and visualized by the UI.