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

Interface UiWidgetField<VALUE>

Type Parameters:

VALUE - is the generic type of the value.

All Superinterfaces:

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

All Known Subinterfaces:

UiWidgetCheckboxesField<VALUE>, UiWidgetCheckboxField, UiWidgetCodeAreaField, UiWidgetColorField, UiWidgetComboboxField<VALUE>, UiWidgetDateField, UiWidgetDoubleField, UiWidgetFileField, UiWidgetInstantField, UiWidgetIntegerField, UiWidgetIntegerSliderField, UiWidgetListBoxField<VALUE>, UiWidgetLocalDateField, UiWidgetLocalTimeField, UiWidgetLongField, UiWidgetOptionsField<VALUE>, UiWidgetPasswordField, UiWidgetRadioButtonsField<VALUE>, UiWidgetRadioButtonsVerticalField<VALUE>, UiWidgetRangeField<VALUE>, UiWidgetRichTextField, UiWidgetTextAreaField, UiWidgetTextField, UiWidgetTextualInputField<VALUE>

All Known Implementing Classes:

AbstractUiWidgetCheckboxField, AbstractUiWidgetCodeAreaField, AbstractUiWidgetColorField, AbstractUiWidgetComboboxField, AbstractUiWidgetDateField, AbstractUiWidgetDoubleField, AbstractUiWidgetField, AbstractUiWidgetFileField, AbstractUiWidgetInstantField, AbstractUiWidgetIntegerField, AbstractUiWidgetIntegerSliderField, AbstractUiWidgetListBoxField, AbstractUiWidgetLocalDateField, AbstractUiWidgetLocalTimeField, AbstractUiWidgetLongField, AbstractUiWidgetNumberField, AbstractUiWidgetOptionsField, AbstractUiWidgetPasswordField, AbstractUiWidgetRadioButtonsField, AbstractUiWidgetRadioButtonsVerticalField, AbstractUiWidgetRangeField, AbstractUiWidgetRichTextField, AbstractUiWidgetTextAreaField, AbstractUiWidgetTextAreaFieldBase, AbstractUiWidgetTextField, AbstractUiWidgetTextFieldBase, AbstractUiWidgetTextualInputField, UiWidgetCheckboxFieldGwt, UiWidgetCheckboxFieldTestImpl, UiWidgetCodeAreaFieldTestImpl, UiWidgetColorFieldGwt, UiWidgetColorFieldTestImpl, UiWidgetComboboxFieldGwt, UiWidgetComboboxFieldTestImpl, UiWidgetCustomField, UiWidgetCustomFieldAtomic, UiWidgetCustomFieldComposite, UiWidgetDateFieldGwt, UiWidgetDateFieldTestImpl, UiWidgetDoubleFieldGwt, UiWidgetDoubleFieldTestImpl, UiWidgetFileFieldGwt, UiWidgetFileFieldTestImpl, UiWidgetIntegerFieldGwt, UiWidgetIntegerFieldTestImpl, UiWidgetIntegerSliderFieldGwt, UiWidgetIntegerSliderFieldTestImpl, UiWidgetLocalDateFieldGwt, UiWidgetLocalDateFieldTestImpl, UiWidgetLocalTimeFieldGwt, UiWidgetLocalTimeFieldTestImpl, UiWidgetLongFieldGwt, UiWidgetLongFieldTestImpl, UiWidgetPasswordFieldGwt, UiWidgetPasswordFieldTestImpl, UiWidgetRadioButtonsFieldGwt, UiWidgetRadioButtonsTestImpl, UiWidgetRadioButtonsVerticalFieldGwt, UiWidgetRadioButtonsVerticalFieldTestImpl, UiWidgetRichTextFieldGwt, UiWidgetRichTextFieldTestImpl, UiWidgetTextAreaFieldGwt, UiWidgetTextAreaFieldTestImpl, UiWidgetTextFieldGwt, UiWidgetTextFieldTestImpl

public interface UiWidgetField<VALUE>
extends UiWidgetRegularComposite<UiWidget>, UiWidgetWithValue<VALUE>, AttributeWriteValueAsString, AttributeWriteValidationFailure, AttributeWriteTrimValue, AttributeWriteLabel, UiWidgetActive

This is the abstract interface for a regular composite widget that represents a (potentially) editable field (text field, combobox, text area, radio-buttons, checkbox, etc.). Such a field is associated with a label. To build a form with multiple fields a UiWidgetGridPanel should be used (typically indirectly via a custom widget). Such form can be used to display the fields with their values in view mode (read-only) or in edit mode. This can be changed dynamically via AttributeWriteMode.setMode(net.sf.mmm.client.ui.api.common.UiMode). To prevent a single field from switching to edit mode you can call AttributeWriteModeFixed.setModeFixed(net.sf.mmm.client.ui.api.common.UiMode) with UiMode.VIEW so it will remain immutable. Besides a field can also be disabled so in edit mode it will be grayed out and prevents the user from changing its value. This is suggested for fields that dynamically change their ( editable) status based on a particular condition (e.g. the current value of another field). A field widget is a composite because it may also be composed out of multiple native input widgets (e.g. to edit a composite Datatype - see UiWidgetFactoryDatatype.createForDatatype(Class)).

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
static String	STYLE_FIELD The default top-level style of this widget.
static String	STYLE_LABEL The primary style of the field label widget.
static String	STYLE_MANDATORY The additional style of the field label widget if mandatory.
static String	STYLE_VIEW The primary style of the internal widget to display the value in view-mode.

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

Method Summary

Modifier and Type	Method and Description
String	getLabel() This method gets the label of this object.
UiWidgetLabel	getLabelWidget() This method gets the label widget associated with this field.
void	setLabel(String label) This method sets the label of this object.

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

setId

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

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, 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.AttributeWriteValueAsString

setValueAsString

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

getValueAsString

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

setValidationFailure

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

getValidationFailure

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

setTrimValue

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

isTrimValue

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

STYLE_FIELD

static final String STYLE_FIELD

The default top-level style of this widget.

See Also:

Constant Field Values

STYLE_VIEW

static final String STYLE_VIEW

The primary style of the internal widget to display the value in view-mode.

See Also:

Constant Field Values

STYLE_LABEL

static final String STYLE_LABEL

The primary style of the field label widget.

See Also:

Constant Field Values

STYLE_MANDATORY

static final String STYLE_MANDATORY

The additional style of the field label widget if mandatory.

See Also:

Constant Field Values

Method Detail

getLabel

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 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 setLabel(String) and NOT what has potentially been set via getLabelWidget() . setLabel (what should be avoided).

Specified by:

getLabel in interface AttributeReadLabel

Returns:

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

setLabel

void setLabel(String label)

This method sets the label of this object.

Specified by:

setLabel in interface AttributeWriteLabel

Parameters:

label - is the new label to set.

See Also:

getLabel()

getLabelWidget

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 getLabel() and 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.

Returns:

the associated label widget.