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

Interface UiWidgetComboboxField<VALUE>

Type Parameters:

VALUE - is the generic type of the value.

All Superinterfaces:

AbstractValidatableObject, Accessibility, AttributeReadAccessKey, AttributeReadAllowCustomInput, AttributeReadAriaRole, AttributeReadDisposed, AttributeReadEnabled, AttributeReadFocused, AttributeReadFormatter<VALUE>, AttributeReadHtmlId, AttributeReadId<String>, AttributeReadLabel, AttributeReadMode, AttributeReadModeFixed, AttributeReadModified, AttributeReadOptions<VALUE>, AttributeReadPrimaryStyle, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadTooltip, AttributeReadTrimValue, AttributeReadValidationFailure, AttributeReadValue<VALUE>, AttributeReadValueAdvanced<VALUE>, AttributeReadValueAsString, AttributeReadVisible, AttributeReadVisibleRecursive, AttributeWriteAccessKey, AttributeWriteAllowCustomInput, AttributeWriteDisposed, AttributeWriteEnabled, AttributeWriteFocused, AttributeWriteFormatter<VALUE>, AttributeWriteHtmlId, AttributeWriteId<String>, AttributeWriteLabel, AttributeWriteMode, AttributeWriteModeFixed, AttributeWriteOnlyFocused, AttributeWriteOptions<VALUE>, 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>, UiWidgetField<VALUE>, UiWidgetNative, UiWidgetOptionsBase<VALUE>, UiWidgetOptionsField<VALUE>, UiWidgetRegular, UiWidgetRegularComposite<UiWidget>, UiWidgetWithValue<VALUE>, ValidatableObject<VALUE>

All Known Implementing Classes:

AbstractUiWidgetComboboxField, UiWidgetComboboxFieldGwt, UiWidgetComboboxFieldTestImpl

public interface UiWidgetComboboxField<VALUE>
extends UiWidgetOptionsField<VALUE>, AttributeWriteAllowCustomInput, UiWidgetNative

This is the interface for a options field widget that represents a combobox. Such widget is like a drop-down where the user can open a menu with the available options to choose from. If supported by the underlying native toolkit it also allows typing text and offering completions in order to allow better keyboard control.
Here you can see an example (with field label "Title"):

 Title: 
 

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

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

Method Summary

Modifier and Type	Method and Description
RoleCombobox	getAriaRole() This method gets the Accessibility.WAI_ARIA role of this object.

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

getLabel, getLabelWidget, setLabel

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

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

setFormatter

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

setOptions

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

getOptions

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

getFormatter

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

setAllowCustomInput

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

isAllowCustomInput

Method Detail

getAriaRole

RoleCombobox getAriaRole()

This method gets the Accessibility.WAI_ARIA role of this object.
ATTENTION:
A reasonable UI framework (e.g. when using UiWidget) is supposed to provide high-level widgets and support setting the according Role and their attributes automatically. Therefore users should only use this for special situations e.g. for setting aria-hidden intentionally for a visible object.

Specified by:

getAriaRole in interface AttributeReadAriaRole

Returns:

the Role or null if NOT set.

See Also:

Accessibility