VALUE - is the generic type of the value.public class UiWidgetCustomFormEditor<VALUE> extends UiWidgetCustomEditor<VALUE>
custom editor that (re-)uses a
custom form panel to view and edit the value.AbstractUiWidget.AccessHelper, AbstractUiWidget.EventSender, AbstractUiWidget.HandlerContainer| Modifier and Type | Field and Description |
|---|---|
private UiWidgetCustomComposite<VALUE,?,?> |
formPanel
The form panel to view and edit the
value. |
PRIMARY_STYLESTYLE_HEADERHTML_ATTRIBUTE_ID, ID_SEPARATOR, PROPERTY_IDPROPERTY_STYLES, STYLE_PATTERN_MULTIPLE, STYLE_PATTERN_SINGLEWAI_ARIA| Constructor and Description |
|---|
UiWidgetCustomFormEditor(UiContext context,
UiHandlerObjectSave<VALUE> handlerSaveObject,
UiWidgetCustomComposite<VALUE,?,?> formPanel)
The constructor.
|
| Modifier and Type | Method and Description |
|---|---|
protected VALUE |
doGetValue(VALUE template,
ValidationState state)
This method is called from the
data-binding triggered by API methods such as
AbstractUiFeatureValueAndValidation.getValue(). |
protected void |
doSetValue(VALUE value,
boolean forUser)
This method is called from the
data-binding triggered by API methods such as
AbstractUiWidget.setValue(Object, boolean). |
addChild, createButtonPanel, doInitialize, setParentgetChild, getChild, getChildCount, getChildIndexaddStyle, clearMessages, clearValidity, dispose, doSetMode, doValidate, getAriaRole, getDelegate, getDelegate, getId, getMode, getModeFixed, getParent, getPrimaryStyle, getSize, getSource, getStyles, getTooltip, getValueClass, getVisibleFlag, getWidgetAdapter, hasStyle, hasWidgetAdapter, initialize, isDisposed, isEnabled, isModifiedRecursive, isVisible, isVisibleRecursive, removeFromParent, removeStyle, setEnabled, setFocused, setId, setMode, setMode, setModeFixed, setPrimaryStyle, setStyles, setTooltip, setVisible, setVisibleaddChangeHandler, addEventHandler, addValidator, clearMessagesLocal, clearValidationFailure, convertValueToString, fireEvent, fireValueChange, getBasicUtil, getContext, getDataBinding, getDataBinding, getDataBindingForWidget, getEventSender, getFactory, getLogger, getObserverSource, getOriginalValue, getRecentValue, getValueDirect, getValueOrException, getWidgetAdapter, hasEventSender, isMandatory, isModified, removeChangeHandler, removeEventHandler, removeFromParent, removeValidator, setMandatory, setModified, setParent, setValue, toStringaddValidatorMandatory, createValidationFailure, getValue, getValueAndValidate, handleGetValueError, resetValue, setValue, setValueForUser, validateclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitgetContext, getParent, getSizeclearMessagesaddEventHandler, removeEventHandlersetModegetModesetModeFixedgetModeFixedsetIdgetIdsetTooltipgetTooltipgetVisibleFlag, isVisible, setVisible, setVisibleisVisibleRecursivesetEnabledisEnabledaddStyle, removeStylehasStylesetStylesgetStylessetPrimaryStylegetPrimaryStyledisposeisDisposedisModifiedgetAriaRolevalidategetValuegetValueAndValidate, getValueDirectaddChangeHandler, removeChangeHandlerresetValue, setValue, setValue, setValueForUsergetOriginalValue, getValueOrExceptionaddValidatorMandatory, isMandatoryaddValidator, removeValidatorprivate UiWidgetCustomComposite<VALUE,?,?> formPanel
value.public UiWidgetCustomFormEditor(UiContext context, UiHandlerObjectSave<VALUE> handlerSaveObject, UiWidgetCustomComposite<VALUE,?,?> formPanel)
context - is the context.handlerSaveObject - is the UiHandlerObjectSave
invoked if the
end-user clicked "save" and the value has been validated successfully.formPanel - is theprotected VALUE doGetValue(VALUE template, ValidationState state) throws RuntimeException
data-binding triggered by API methods such as
AbstractUiFeatureValueAndValidation.getValue(). In many cases the data-binding already performs the
required work to do. However, here is the place to implemented the custom logic to get the value from the
actual widget. The following cases have to be distinguished:
native
fields this method has to get the actual
value from the underlying native widget (text-box, password-field, etc.).custom fields this
method will be responsible to convert from the delegates value (see
UiWidgetCustom.getDelegate()) to the proper value type. E.g. if you want to create a custom
widget to edit your own datatype such as CustomerNumber based on a
UiWidgetTextField you need to convert from String
to CustomerNumber.custom composite widgets
you should use AbstractUiWidget.getDataBinding().
UiDataBinding.createAndBind(net.sf.mmm.util.pojo.path.api.TypedProperty)
that gives you high-level support and makes your live easy. Then there is no need to override this
method.Void, there is nothing to do here.AbstractUiWidget.doSetValue(Object, boolean) .
data-binding you could override this
method and manually implement the binding like in the following example:protected Person doGetValue(Person template,You may also mix the advanced data-binding with custom logic implemented in this method.ValidationStatestate) { Person result = super.doGetValue(template, state); // if the attribute is a datatype we can supply null (instead of result.getFirstName()) result.setFirstName(this.widgetFirstName.getValueDirect(null, state)); result.setLastName(this.widgetLastName.getValueDirect(null, state)); Address address = this.widgetAddressPanel.getValueDirect(result.getAddress(), state); this.widgetAddressExtraPanel.getValueDirect(address, state); result.setAddress(address); ... return result; }
doGetValue in class UiWidgetCustomComposite<VALUE,UiWidgetRegular,UiWidgetVerticalPanel>template - is the object where the data is filled in. May only be null if according to
data-binding (e.g. if <VALUE> is an (immutable)
Datatype).state - is the ValidationState. May be null (if the validation is omitted).
Should only be used to propagate to AbstractUiWidget.getValueDirect(Object, ValidationState) of children.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) the template is NOT
null and is to be returned by this method after the value(s) of this widget have
been assigned. For immutable datatypes
template will be null and this method has to create a new instance of
<VALUE> based on the end-users input in the widget.RuntimeExceptionAbstractUiWidget.doSetValue(Object, boolean)protected void doSetValue(VALUE value, boolean forUser)
data-binding triggered by API methods such as
AbstractUiWidget.setValue(Object, boolean). In many cases the data-binding already
performs the required work to do. However, here is the place to implemented the custom logic to get the
value from the actual widget. For details see AbstractUiWidget.doGetValue(Object, ValidationState).
data-binding you could override this
method and manually implement the binding like in the following example:
protected void doSetValue(Person value) {
this.widgetFirstName.setValue(value?.getFirstName());
this.widgetLastName.setValue(value?.getLastName());
...
}
doSetValue in class UiWidgetCustomComposite<VALUE,UiWidgetRegular,UiWidgetVerticalPanel>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).AbstractUiWidget.doGetValue(Object, ValidationState)Copyright © 2001–2016 mmm-Team. All rights reserved.