net.sf.mmm.client.ui.base.widget.field

Class AbstractUiWidgetField<ADAPTER extends UiWidgetAdapterField<VALUE,ADAPTER_VALUE>,VALUE,ADAPTER_VALUE>

java.lang.Object

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

net.sf.mmm.client.ui.base.widget.AbstractUiWidget<VALUE>

net.sf.mmm.client.ui.base.widget.AbstractUiWidgetNative<ADAPTER,VALUE>

net.sf.mmm.client.ui.base.widget.AbstractUiWidgetActive<ADAPTER,VALUE>

net.sf.mmm.client.ui.base.widget.field.AbstractUiWidgetField<ADAPTER,VALUE,ADAPTER_VALUE>

Type Parameters:

ADAPTER - is the generic type of AbstractUiWidgetNative.getWidgetAdapter().

VALUE - is the generic type of the value.

ADAPTER_VALUE - is the generic type of the adapter value.

All Implemented Interfaces:

AttributeReadAccessKey, AttributeReadAriaRole, AttributeReadEnabled, AttributeReadFocused, AttributeReadHtmlId, AttributeReadLabel, AttributeReadMode, AttributeReadModeFixed, AttributeReadModified, AttributeReadPrimaryStyle, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadTooltip, AttributeReadTrimValue, AttributeReadValidationFailure, AttributeReadValueAdvanced<VALUE>, AttributeReadValueAsString, AttributeReadVisible, AttributeReadVisibleRecursive, AttributeWriteAccessKey, AttributeWriteAriaRole, AttributeWriteEnabled, AttributeWriteFocused, AttributeWriteHtmlId, AttributeWriteLabel, AttributeWriteMode, AttributeWriteModeFixed, AttributeWriteModified, AttributeWriteOnlyFocused, AttributeWritePrimaryStyle, AttributeWriteStyles, AttributeWriteStylesAdvanced, AttributeWriteTooltip, AttributeWriteTrimValue, AttributeWriteValidationFailure, AttributeWriteValueAdvanced<VALUE>, AttributeWriteValueAsString, AttributeWriteVisible, AttributeWriteVisibleAdvanced, UiFeature, UiFeatureEvent, UiFeatureFocus, UiFeatureMessages, UiFeatureMode, UiFeatureValidation<VALUE>, UiFeatureValue<VALUE>, UiFeatureValueAndValidation<VALUE>, UiWidgetField<VALUE>, UiWidget, UiWidgetAbstractComposite, UiWidgetAbstractWithValue<VALUE>, UiWidgetActive, UiWidgetComposite<UiWidget>, UiWidgetRegular, UiWidgetRegularComposite<UiWidget>, UiWidgetWithValue<VALUE>, AttributeReadDisposed, AttributeReadId<String>, AttributeReadValue<VALUE>, AttributeWriteDisposed, AttributeWriteId<String>, AttributeWriteValue<VALUE>, Accessibility, AbstractValidatableObject, HasValueValidators<VALUE>, ValidatableObject<VALUE>

Direct Known Subclasses:

AbstractUiWidgetCheckboxField, AbstractUiWidgetColorField, AbstractUiWidgetFileField, AbstractUiWidgetOptionsField, AbstractUiWidgetRangeField, AbstractUiWidgetTextualInputField

public abstract class AbstractUiWidgetField<ADAPTER extends UiWidgetAdapterField<VALUE,ADAPTER_VALUE>,VALUE,ADAPTER_VALUE>
extends AbstractUiWidgetActive<ADAPTER,VALUE>
implements UiWidgetField<VALUE>

This is the abstract base implementation of UiWidgetField.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.mmm.client.ui.base.widget.AbstractUiWidgetNative

AbstractUiWidgetNative.SizeImpl

Nested classes/interfaces inherited from class net.sf.mmm.client.ui.base.widget.AbstractUiWidget

AbstractUiWidget.AccessHelper, AbstractUiWidget.EventSender, AbstractUiWidget.HandlerContainer

Field Summary

Fields

Modifier and Type	Field and Description
private String	fieldLabel
private AbstractUiWidgetLabel<?>	fieldLabelWidget
private boolean	trimValue
private String	validationFailure
private String	valueAsString

Fields inherited from interface net.sf.mmm.client.ui.api.widget.field.UiWidgetField

STYLE_FIELD, STYLE_LABEL, STYLE_MANDATORY, STYLE_VIEW

Fields inherited from interface net.sf.mmm.client.ui.api.widget.UiWidget

STYLE_HEADER

Fields inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadHtmlId

HTML_ATTRIBUTE_ID, ID_SEPARATOR, PROPERTY_ID

Fields inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadStyles

PROPERTY_STYLES, STYLE_PATTERN_MULTIPLE, STYLE_PATTERN_SINGLE

Fields inherited from interface net.sf.mmm.util.lang.api.concern.Accessibility

WAI_ARIA

Fields inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadLabel

PROPERTY_LABEL

Fields inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadAccessKey

ACCESS_KEY_NONE, HTML_ATTRIBUTE_ACCESS_KEY

Constructor Summary

Constructors

Constructor and Description
AbstractUiWidgetField(UiContext context, ADAPTER widgetAdapter) The constructor.

Method Summary

Modifier and Type	Method and Description
protected void	clearValidationFailure() This method clears the messages locally (the non-recursive part of AbstractUiWidget.clearMessages()).
protected ADAPTER_VALUE	convertFromValue(VALUE widgetValue) This method converts the given widgetValue to the type used by the widget adapter.
protected VALUE	convertToValue(ADAPTER_VALUE adapterValue, ValidationState state) This method converts the given adapterValue from the widget adapter to the type of this value.
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 newValue, boolean forUser) This method is called from the data-binding triggered by API methods such as AbstractUiWidget.setValue(Object, boolean).
String	getLabel() This method gets the label of this object.
UiWidgetLabel	getLabelWidget() This method gets the label widget associated with this field.
protected ADAPTER_VALUE	getNullValue() This method gets the result of convertFromValue(Object) for the value null.
String	getSource()
String	getValidationFailure() This method gets the validation failure of this object.
String	getValueAsString() This method gets the value as String.
protected abstract Class<VALUE>	getValueClass()
VALUE	getValueDirect(VALUE template, ValidationState state) This method is a combination of AttributeReadValueAdvanced.getValueOrException(Object) and AbstractValidatableObject.validate(ValidationState).
protected void	initializeWidgetAdapter(ADAPTER adapter) This method is called from AbstractUiWidgetNative.getWidgetAdapter() to initialize the UiWidgetAdapter.
boolean	isTrimValue() This method determines if the value of this object should be automatically trimmed.
void	setId(String newId) This method set the ID of this object.
void	setLabel(String label) This method sets the label of this object.
protected void	setMandatory(boolean mandatory) This method is called whenever the AbstractUiWidget.isMandatory() flag is updated.
void	setTrimValue(boolean trimValue) This method sets the trimValue flag.
void	setValidationFailure(String validationFailure) This method sets the validation failure.
void	setValue(VALUE newValue, boolean forUser) This is the generic variant of AttributeWriteValueAdvanced.setValue(Object) and AttributeWriteValueAdvanced.setValueForUser(Object).
void	setValueAsString(String value) This method sets the valueAsString of this object.
void	setVisible(boolean visible, boolean programmatic) This method shows or hides this object.
String	toString()
private void	updateFieldLabel() Updates the field label in field label widget.

Methods inherited from class net.sf.mmm.client.ui.base.widget.AbstractUiWidgetActive

addFocusHandler, getAccessKey, isFocused, onAccessKeyPressed, removeFocusHandler, setAccessKey, setFocused, setFocused

Methods inherited from class net.sf.mmm.client.ui.base.widget.AbstractUiWidgetNative

addChangeHandler, addStyle, clearMessages, clearValidity, createSize, createUniqueId, createWidgetAdapter, dispose, doSetMode, doValidate, getAriaRole, getAriaRoleFixedType, getChild, getChild, getChildCount, getChildIndex, getId, getIndexOfStyle, getMode, getModeFixed, getParent, getPrimaryStyle, getSize, getStyles, getTooltip, getVisibleFlag, getWidgetAdapter, getWidgetAdapter, hasStyle, hasWidgetAdapter, isDisposed, isEnabled, isModifiedRecursive, isVisible, isVisibleRecursive, removeChangeHandler, removeFromParent, removeStyle, setAriaRole, setEnabled, setIdPrefix, setMode, setMode, setModeFixed, setParent, setPrimaryStyle, setStyles, setTooltip, setVisible, visibilityChanged

Methods inherited from class net.sf.mmm.client.ui.base.widget.AbstractUiWidget

addEventHandler, addValidator, clearMessagesLocal, convertValueToString, fireEvent, fireValueChange, getBasicUtil, getContext, getDataBinding, getDataBinding, getDataBindingForWidget, getEventSender, getFactory, getLogger, getObserverSource, getOriginalValue, getRecentValue, getValueOrException, getWidgetAdapter, hasEventSender, isMandatory, isModified, removeEventHandler, removeFromParent, removeValidator, setModified, setParent

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

addValidatorMandatory, createValidationFailure, getValue, getValueAndValidate, 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.api.widget.UiWidgetComposite

getChild, getChild

Methods inherited from interface net.sf.mmm.client.ui.api.widget.UiWidgetAbstractComposite

getChildCount, getChildIndex

Methods inherited from interface net.sf.mmm.client.ui.api.widget.UiWidget

getContext, getParent, getSize

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

clearMessages

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

addEventHandler, removeEventHandler

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

setMode

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

getMode

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

setModeFixed

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

getModeFixed

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

getId

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

setTooltip

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

getTooltip

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

getVisibleFlag, isVisible, setVisible

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

isVisibleRecursive

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

setEnabled

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

isEnabled

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

addStyle, removeStyle

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

hasStyle

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

setStyles

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

getStyles

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

setPrimaryStyle

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

getPrimaryStyle

Methods inherited from interface net.sf.mmm.util.lang.api.attribute.AttributeWriteDisposed

dispose

Methods inherited from interface net.sf.mmm.util.lang.api.attribute.AttributeReadDisposed

isDisposed

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

isModified

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

getAriaRole

Methods inherited from interface net.sf.mmm.client.ui.api.widget.UiWidgetWithValue

getValue

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

getValueAndValidate

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

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

getOriginalValue, 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.client.ui.api.attribute.AttributeWriteAccessKey

setAccessKey

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

getAccessKey

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

addFocusHandler, removeFocusHandler

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

isFocused

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

setFocused

Field Detail

validationFailure

private String validationFailure

See Also:

getValidationFailure()

fieldLabel

private String fieldLabel

See Also:

getLabel()

fieldLabelWidget

private AbstractUiWidgetLabel<?> fieldLabelWidget

See Also:

getLabelWidget()

valueAsString

private String valueAsString

See Also:

getValueAsString()

trimValue

private boolean trimValue

See Also:

isTrimValue()

Constructor Detail

AbstractUiWidgetField

public AbstractUiWidgetField(UiContext context,
                             ADAPTER widgetAdapter)

The constructor.

Parameters:

context - is the context.

widgetAdapter - is the widget adapter. Typically null for lazy initialization.

Method Detail

initializeWidgetAdapter

protected void initializeWidgetAdapter(ADAPTER adapter)

This method is called from AbstractUiWidgetNative.getWidgetAdapter() to initialize the UiWidgetAdapter. All attributes of this widget need to be set in the UiWidgetAdapter.

Overrides:

initializeWidgetAdapter in class AbstractUiWidgetActive<ADAPTER extends UiWidgetAdapterField<VALUE,ADAPTER_VALUE>,VALUE>

Parameters:

adapter - is the UiWidgetAdapter to initialize.

getValueClass

protected abstract Class<VALUE> getValueClass()

Overrides:

getValueClass in class AbstractUiWidget<VALUE>

Returns:

the Class reflecting <VALUE>. May also be null for Void.

doGetValue

protected VALUE doGetValue(VALUE template,
                           ValidationState state)
                    throws RuntimeException

This method is called from the 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:

• For native fields this method has to get the actual value from the underlying native widget (text-box, password-field, etc.).
• For 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.
• For 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.
• For other cases, especially if <VALUE> is Void, there is nothing to do here.

The implementation of this method has to correspond with the implementation of AbstractUiWidget.doSetValue(Object, boolean) .

Overrides:

doGetValue in class AbstractUiWidgetNative<ADAPTER extends UiWidgetAdapterField<VALUE,ADAPTER_VALUE>,VALUE>

Parameters:

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.

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) 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.

Throws:

RuntimeException

See Also:

AbstractUiWidget.doSetValue(Object, boolean)

isTrimValue

public final boolean isTrimValue()

This method determines if the value of this object should be automatically trimmed. The default value is true. E.g. if a text field widget supports this property and it is true the value entered by the end-user will automatically be trimmed. If you want prevent this (e.g. if the end-user shall provide a separator, indentation, substitution variable, or the like) you need to set it to false.

Specified by:

isTrimValue in interface AttributeReadTrimValue

Returns:

true if the value of this object should be automatically trimmed.

setTrimValue

public final void setTrimValue(boolean trimValue)

This method sets the trimValue flag.

Specified by:

setTrimValue in interface AttributeWriteTrimValue

Parameters:

trimValue - is the new value of AttributeReadTrimValue.isTrimValue().

doSetValue

protected void doSetValue(VALUE newValue,
                          boolean forUser)

This method is called from the 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).

Overrides:

doSetValue in class AbstractUiWidgetNative<ADAPTER extends UiWidgetAdapterField<VALUE,ADAPTER_VALUE>,VALUE>

Parameters:

newValue - 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:

AbstractUiWidget.doGetValue(Object, ValidationState)

convertToValue

protected VALUE convertToValue(ADAPTER_VALUE adapterValue,
                               ValidationState state)

This method converts the given adapterValue from the widget adapter to the type of this value. The default implementation simply performs a cast. You have to override this method if <VALUE> and <WIDGET_VALUE> differ.

Parameters:

adapterValue - is the value to convert. Will NOT be null.

state - is the ValidationState or null if not called without validation.

Returns:

the converted value.

getNullValue

protected ADAPTER_VALUE getNullValue()

This method gets the result of convertFromValue(Object) for the value null. It is called for null values instead of convertFromValue(Object) to prevent NullPointerExceptions. The default is null - override to change.

Returns:

the value representation of null for the widget adapter.

convertFromValue

protected ADAPTER_VALUE convertFromValue(VALUE widgetValue)

This method converts the given widgetValue to the type used by the widget adapter. The default implementation simply performs a cast. You have to override this method if <VALUE> and <WIDGET_VALUE> differ.

Parameters:

widgetValue - is the value to convert. Will NOT be null (See getNullValue()).

Returns:

the converted value.

setValue

public void setValue(VALUE newValue,
                     boolean forUser)

This is the generic variant of AttributeWriteValueAdvanced.setValue(Object) and AttributeWriteValueAdvanced.setValueForUser(Object).
NOTE:
To make your code expressive please only use this method for generic situations where forUser is dynamic.

Specified by:

setValue in interface AttributeWriteValueAdvanced<VALUE>

Overrides:

setValue in class AbstractUiWidget<VALUE>

Parameters:

newValue - is the new value to set.

forUser - true for the semantics of AttributeWriteValueAdvanced.setValueForUser(Object), false for AttributeWriteValueAdvanced.setValue(Object).

getValueAsString

public String getValueAsString()

This method gets the value as String. It returns the value as it is entered by the end-user that may be invalid.

Specified by:

getValueAsString in interface AttributeReadValueAsString

Returns:

the value as entered by the user. Will be the empty String if the field is blank.

setValueAsString

public void setValueAsString(String value)

This method sets the valueAsString of this object.
ATTENTION:
This method shall only be used in very specific situations. Use it e.g. if you explicitly want to enter invalid data.

Specified by:

setValueAsString in interface AttributeWriteValueAsString

Parameters:

value - is the new value as it would have been entered by the user.

getValidationFailure

public String getValidationFailure()

This method gets the validation failure of this object. This is a text that explains the user why the value he has entered is invalid (typically provided as tooltip of an error icon).

Specified by:

getValidationFailure in interface AttributeReadValidationFailure

Returns:

the validation error text or null for no error.

setValidationFailure

public void setValidationFailure(String validationFailure)

This method sets the validation failure.
ATTENTION:
For regular usage you should use UiFeatureValidation. This method is only intended as back-door for very special cases (e.g. you have to use your own validator infrastructure and perform validation outside this framework). It is not recommended to use this method as an API user.

Specified by:

setValidationFailure in interface AttributeWriteValidationFailure

Parameters:

validationFailure - is the validation failure text. The empty string or null will clear the error and mark the field as valid. Otherwise the field will be invalid.

clearValidationFailure

protected void clearValidationFailure()

This method clears the messages locally (the non-recursive part of AbstractUiWidget.clearMessages()).

Overrides:

clearValidationFailure in class AbstractUiWidget<VALUE>

getLabel

public String getLabel()

This method gets the label of this object. A label is some text that is permanently shown to the user in the UI in order to describe the meaning of the object and in particular its value. For elements that allow to display or edit a value the label is typically shown beside the edit/display widget. For action elements such as buttons or links the label is the actual text (lettering).

NOTE:
Every field widget (UiWidgetField) has an associated label widget. This method gets its label text. Please note that the label widget is not contained in this field widget itself, so if you regularly add this field widget to some other widget you will not see the label. However, UiWidgetGridPanel also automatically adds the label widget. The recommended use-case is to create a form to view and edit your business object extending UiWidgetCustomGridPanel and use UiDataBinding.
Unlike UiWidgetField.getLabelWidget().getLabel() this method prevents actually creating the label widget if it does NOT yet exist. Further it will only return what has been set via UiWidgetField.setLabel(String) and NOT what has potentially been set via UiWidgetField.getLabelWidget() . setLabel (what should be avoided).

Specified by:

getLabel in interface AttributeReadLabel

Specified by:

getLabel in interface UiWidgetField<VALUE>

Returns:

the label text. Will be the empty string if no label has been set.

setLabel

public void setLabel(String label)

This method sets the label of this object.

Specified by:

setLabel in interface AttributeWriteLabel

Specified by:

setLabel in interface UiWidgetField<VALUE>

Parameters:

label - is the new label to set.

See Also:

UiWidgetField.getLabel()

updateFieldLabel

private void updateFieldLabel()

Updates the field label in field label widget.

setMandatory

protected void setMandatory(boolean mandatory)

This method is called whenever the AbstractUiWidget.isMandatory() flag is updated. You may override it to update the UI to reflect this change.

Overrides:

setMandatory in class AbstractUiWidget<VALUE>

Parameters:

mandatory - is the new value of AbstractUiWidget.isMandatory().

getLabelWidget

public final UiWidgetLabel getLabelWidget()

This method gets the label widget associated with this field.
ATTENTION:
Depending on the underlying toolkit the label widget is lazily created on the first call of this method. Additionally users of this API (unlike implementors of the API) may only use this for very specific cases (e.g. setting the style of the label). Therefore you should avoid calling this method unless you are aware of what you are doing. To access the label-text simply use UiWidgetField.getLabel() and UiWidgetField.setLabel(String). Be aware that some native toolkits (e.g. SmartGWT) already implement field widgets including the label. In this case this method will return a different view on the same native widget.

Specified by:

getLabelWidget in interface UiWidgetField<VALUE>

Returns:

the associated label widget.

setId

public void setId(String newId)

This method set the ID of this object. Use this method to give the object a meaningful identifier after creation.
ATTENTION:
See javadoc of AttributeReadHtmlId.getId() for the syntax constraints of IDs.

Specified by:

setId in interface AttributeWriteHtmlId

Specified by:

setId in interface AttributeWriteId<String>

Overrides:

setId in class AbstractUiWidgetNative<ADAPTER extends UiWidgetAdapterField<VALUE,ADAPTER_VALUE>,VALUE>

Parameters:

newId - is the new ID for the object.

toString

public String toString()

Overrides:

toString in class AbstractUiWidgetNative<ADAPTER extends UiWidgetAdapterField<VALUE,ADAPTER_VALUE>,VALUE>

getValueDirect

public 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 UiFeatureValueAndValidation.getValueAndValidate(ValidationState).

Specified by:

getValueDirect in interface UiFeatureValueAndValidation<VALUE>

Overrides:

getValueDirect in class AbstractUiWidget<VALUE>

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.

setVisible

public void setVisible(boolean visible,
                       boolean programmatic)

This method shows or hides this object.

Specified by:

setVisible in interface AttributeWriteVisibleAdvanced

Overrides:

setVisible in class AbstractUiWidgetNative<ADAPTER extends UiWidgetAdapterField<VALUE,ADAPTER_VALUE>,VALUE>

Parameters:

visible - - see AbstractUiWidgetNative.setVisible(boolean).

programmatic - - see UiEvent.isProgrammatic().

See Also:

AbstractUiWidgetNative.setVisible(boolean)

getSource

public String getSource()

Overrides:

getSource in class AbstractUiWidget<VALUE>

Returns:

a String representation of this object that qualifies as source description that might be displayed to end-users (unlike AbstractUiWidget.toString() what is for debugging only).