net.sf.mmm.client.ui.api.attribute

Interface AttributeReadValueAdvanced<VALUE>

Type Parameters:

VALUE - is the generic type of the value.

All Superinterfaces:

AttributeReadValue<VALUE>

All Known Subinterfaces:

AttributeWriteValueAdvanced<VALUE>, UiDataBinding<VALUE>, UiFeatureValue<VALUE>, UiFeatureValueAndValidation<VALUE>, UiWidgetAbstractListTable<ROW>, UiWidgetAbstractTree<NODE>, UiWidgetAbstractWithValue<VALUE>, 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 AttributeReadValueAdvanced<VALUE>
extends AttributeReadValue<VALUE>

This interface gives advanced read access to the value of an object.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Method Summary

Modifier and Type	Method and Description
VALUE	getOriginalValue() This method gets the last value that has been set.
VALUE	getValue() This method gets the value of this object.
VALUE	getValueOrException(VALUE template) This method is like getValue() but does NOT catch exceptions while parsing the value from the user input.

Method Detail

getValue

VALUE getValue()

This method gets the value of this object. This will typically be a newly created object.
ATTENTION:
If the current value entered by the user can NOT be parsed, this method will catch and ignore the exception and return null instead. If you want to do validation and give feedback to the user please use getValueOrException(Object) instead. However, there are higher-level ways to do this such as getValueAndValidate.

Specified by:

getValue in interface AttributeReadValue<VALUE>

Returns:

the value of this object. May be null unless otherwise stated.

getValueOrException

VALUE getValueOrException(VALUE template)
                   throws RuntimeException

This method is like getValue() but does NOT catch exceptions while parsing the value from the user input. Additionally it allows to provide a template object that gets populated. This allows advanced features with polymorphism as you can also provide a sub-class of <VALUE>.

Parameters:

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

Returns:

the current value of this widget. May be null if empty. If the value type 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.

Throws:

RuntimeException - if the entered value is invalid (e.g. paring caused a NumberFormatException).

getOriginalValue

VALUE getOriginalValue()

This method gets the last value that has been set. After calling AttributeWriteValueAdvanced.setValue(Object) the value can be modified (by the user in case of a widget). Then calls to getValue() will return the current value with its potential modifications (as a new object). This method will ensure to get the value that was set before by the program.
ATTENTION:
The original value shall never be modified to avoid undesired side effects. Various features such as AttributeWriteValueAdvanced.resetValue() rely on this fact. Therefore getValue() will always return a new instance.

Returns:

the original value.