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

Class AbstractUiWidgetTextualInputField<ADAPTER extends UiWidgetAdapterTextualInputField<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>

net.sf.mmm.client.ui.base.widget.field.AbstractUiWidgetTextualInputField<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, AttributeReadMaximumTextLength, AttributeReadMode, AttributeReadModeFixed, AttributeReadModified, AttributeReadPrimaryStyle, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadTooltip, AttributeReadTrimValue, AttributeReadValidationFailure, AttributeReadValueAdvanced<VALUE>, AttributeReadValueAsString, AttributeReadVisible, AttributeReadVisibleRecursive, AttributeWriteAccessKey, AttributeWriteAriaRole, AttributeWriteEnabled, AttributeWriteFocused, AttributeWriteHtmlId, AttributeWriteLabel, AttributeWriteMaximumTextLength, 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>, UiWidgetTextualInputField<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:

AbstractUiWidgetDateField, AbstractUiWidgetInstantField, AbstractUiWidgetLocalDateField, AbstractUiWidgetLocalTimeField, AbstractUiWidgetNumberField, AbstractUiWidgetPasswordField, AbstractUiWidgetTextFieldBase

public abstract class AbstractUiWidgetTextualInputField<ADAPTER extends UiWidgetAdapterTextualInputField<VALUE,ADAPTER_VALUE>,VALUE,ADAPTER_VALUE>
extends AbstractUiWidgetField<ADAPTER,VALUE,ADAPTER_VALUE>
implements UiWidgetTextualInputField<VALUE>

This is the abstract base implementation of UiWidgetTextualInputField.

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 int	maximumTextLength

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
AbstractUiWidgetTextualInputField(UiContext context, ADAPTER widgetAdapter) The constructor.

Method Summary

Modifier and Type	Method and Description
int	getMaximumTextLength() This method gets the maximum text length of this object.
protected void	initializeWidgetAdapter(ADAPTER adapter) This method is called from AbstractUiWidgetNative.getWidgetAdapter() to initialize the UiWidgetAdapter.
void	setMaximumTextLength(int length) This method sets the maximum text length of this object.

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

clearValidationFailure, convertFromValue, convertToValue, doGetValue, doSetValue, getLabel, getLabelWidget, getNullValue, getSource, getValidationFailure, getValueAsString, getValueClass, getValueDirect, isTrimValue, setId, setLabel, setMandatory, setTrimValue, setValidationFailure, setValue, setValueAsString, setVisible, toString

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

maximumTextLength

private int maximumTextLength

See Also:

getMaximumTextLength()

Constructor Detail

AbstractUiWidgetTextualInputField

public AbstractUiWidgetTextualInputField(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 AbstractUiWidgetField<ADAPTER extends UiWidgetAdapterTextualInputField<VALUE,ADAPTER_VALUE>,VALUE,ADAPTER_VALUE>

Parameters:

adapter - is the UiWidgetAdapter to initialize.

getMaximumTextLength

public int getMaximumTextLength()

This method gets the maximum text length of this object. Will be Integer.MAX_VALUE if no maximum is defined.

Specified by:

getMaximumTextLength in interface AttributeReadMaximumTextLength

Returns:

the maximum number of characters a user is allowed to enter into this object (field).

setMaximumTextLength

public void setMaximumTextLength(int length)

This method sets the maximum text length of this object.
ATTENTION:
If you are setting this property on a UI field, the typical behavior is that after the maximum text length is reached, any additional input is ignored. This also applies for copy and paste operations. For usability this might be undesired in many cases as users can not append something and then remove a prefix afterwards if the length would be exceeded. Please consider using a validator instead and only use this feature in situations where it is really suitable.

Specified by:

setMaximumTextLength in interface AttributeWriteMaximumTextLength

Parameters:

length - is the new maximum text length to set. Use Integer.MAX_VALUE to unset.