net.sf.mmm.client.ui.impl.gwt.widget.field.adapter

Class UiWidgetAdapterGwtField<WIDGET extends com.google.gwt.user.client.ui.Widget,VALUE,ADAPTER_VALUE>

java.lang.Object

net.sf.mmm.client.ui.base.widget.adapter.AbstractUiWidgetAdapter<WIDGET>

net.sf.mmm.client.ui.base.widget.adapter.AbstractUiWidgetAdapterWithEvents<WIDGET,EventAdapterGwt>

net.sf.mmm.client.ui.impl.gwt.widget.adapter.UiWidgetAdapterGwt<WIDGET>

net.sf.mmm.client.ui.impl.gwt.widget.adapter.UiWidgetAdapterGwtWidget<WIDGET>

net.sf.mmm.client.ui.impl.gwt.widget.adapter.UiWidgetAdapterGwtWidgetActive<com.google.gwt.user.client.ui.Widget>

net.sf.mmm.client.ui.impl.gwt.widget.field.adapter.UiWidgetAdapterGwtField<WIDGET,VALUE,ADAPTER_VALUE>

Type Parameters:

WIDGET - is the generic type of AbstractUiWidgetAdapter.getToplevelWidget().

VALUE - is the generic type of the changed value.

ADAPTER_VALUE - is the generic type of the value of the adapted widget.

All Implemented Interfaces:

AttributeReadAccessKey, AttributeReadAltText, AttributeReadAttribute, AttributeReadColumnSpan, AttributeReadEnabled, AttributeReadFocused, AttributeReadHeightInRows, AttributeReadHtmlId, AttributeReadImage<UiWidgetImage>, AttributeReadKeyboardFilter, AttributeReadLabel, AttributeReadLengthProperty, AttributeReadMaximumTextLength, AttributeReadPrimaryStyle, AttributeReadResizable, AttributeReadSelectionMode, AttributeReadSizeInPixel, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadTooltip, AttributeReadUrl, AttributeReadValidationFailure, AttributeReadValueAsString, AttributeWriteAccessKey, AttributeWriteAttribute, AttributeWriteEnabled, AttributeWriteFocused, AttributeWriteHtmlId, AttributeWriteImage<UiWidgetImage>, AttributeWriteKeyboardFilter, AttributeWriteLengthProperty, AttributeWriteOnlyAttribute, AttributeWriteOnlyFocused, AttributeWritePrimaryStyle, AttributeWriteStyles, AttributeWriteStylesAdvanced, AttributeWriteTooltip, AttributeWriteValidationFailure, AttributeWriteValueAsString, UiWidgetAdapter, UiWidgetAdapterActive, UiWidgetAdapterField<VALUE,ADAPTER_VALUE>, HandlerRegistrationCollector, AttributeReadDisposed, AttributeReadId<String>, AttributeReadMaximumValue<ADAPTER_VALUE>, AttributeReadMinimumValue<ADAPTER_VALUE>, AttributeReadTitle<String>, AttributeReadValue<ADAPTER_VALUE>, AttributeWriteDisposed, AttributeWriteId<String>, AttributeWriteValue<ADAPTER_VALUE>, Accessibility

Direct Known Subclasses:

UiWidgetAdapterGwtDateField, UiWidgetAdapterGwtFieldFocusWidgetBase, UiWidgetAdapterGwtFileField, UiWidgetAdapterGwtRadioButtons, UiWidgetAdapterGwtRichTextField

public abstract class UiWidgetAdapterGwtField<WIDGET extends com.google.gwt.user.client.ui.Widget,VALUE,ADAPTER_VALUE>
extends UiWidgetAdapterGwtWidgetActive<com.google.gwt.user.client.ui.Widget>
implements UiWidgetAdapterField<VALUE,ADAPTER_VALUE>, AttributeReadMinimumValue<ADAPTER_VALUE>, AttributeReadMaximumValue<ADAPTER_VALUE>

This is the implementation of UiWidgetAdapterField using GWT.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private WIDGET	activeWidget
private String	recentStringValue
private ADAPTER_VALUE	recentValue
private com.google.gwt.user.client.ui.InlineLabel	widgetMarkerEditMode A marker displayed after the activeWidget in edit mode.
private com.google.gwt.user.client.ui.Widget	widgetViewMode

Fields inherited from class net.sf.mmm.client.ui.impl.gwt.widget.adapter.UiWidgetAdapterGwt

TAB_INDEX_NONE

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

ACCESS_KEY_NONE, HTML_ATTRIBUTE_ACCESS_KEY

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

ATTRIBUTE_COLSPAN

Constructor Summary

Constructors

Constructor and Description
UiWidgetAdapterGwtField() The constructor.

Method Summary

Modifier and Type	Method and Description
protected void	applyEventAdapterForChange(EventAdapterGwt adapter) Applies for EventType.VALUE_CHANGE events.
protected void	attachActiveWidget(com.google.gwt.user.client.ui.ComplexPanel panel) Attaches the active widget after creation to AbstractUiWidgetAdapter.getToplevelWidget().
protected String	convertValueToString(ADAPTER_VALUE value) Converts the given value to String.
protected abstract WIDGET	createActiveWidget()
protected com.google.gwt.user.client.ui.Widget	createToplevelWidget() This method creates the underlying widget.
protected com.google.gwt.user.client.ui.Widget	createViewWidget() Creates the Widget that is used to display the field value in view-mode.
WIDGET	getActiveWidget() This method gets the active widget.
protected com.google.gwt.dom.client.Element	getInputElement()
ADAPTER_VALUE	getMaximumValue() This method gets the maximum value of this object.
ADAPTER_VALUE	getMinimumValue() This method gets the minimum value of this object.
ADAPTER_VALUE	getValue() This method gets the value of this object.
String	getValueAsString() This method gets the value as String.
protected abstract com.google.gwt.event.dom.client.HasChangeHandlers	getWidgetAsHasChangeHandlers()
protected abstract com.google.gwt.user.client.TakesValue<ADAPTER_VALUE>	getWidgetAsTakesValue()
protected abstract com.google.gwt.user.client.TakesValue<String>	getWidgetAsTakesValueString()
protected com.google.gwt.user.client.ui.Widget	getWidgetViewMode()
protected void	setAdapterValueInViewMode(ADAPTER_VALUE value) This method updates the view-mode-widget such that it displays the given value.
void	setMode(boolean editMode) This method is called from UiModeChanger for AttributeWriteMode.setMode(net.sf.mmm.client.ui.api.common.UiMode).
void	setValidationFailure(String validationFailure) This method sets the validation failure.
void	setValue(ADAPTER_VALUE value) This method sets the value.
void	setValueAsString(String value) This method sets the valueAsString of this object.
protected void	setValueInViewMode(String value) This method updates the view-mode-widget such that it displays the given value.
protected void	updateWidgetViewMode() This method updates the view-mode-widget such that it displays the current value.

Methods inherited from class net.sf.mmm.client.ui.impl.gwt.widget.adapter.UiWidgetAdapterGwtWidgetActive

applyEventAdapterForClick, applyEventAdapterForFocus, getKeyboardFilter, getWidgetAsFocusable, getWidgetAsHasAllFocusHandlers, getWidgetAsHasBlurHandlers, getWidgetAsHasFocusHandlers, getWidgetAsKeyPressHandlers, setAccessKey, setClickEventSender, setFocused, setKeyboardFilter

Methods inherited from class net.sf.mmm.client.ui.impl.gwt.widget.adapter.UiWidgetAdapterGwtWidget

dispose, removeFromParent

Methods inherited from class net.sf.mmm.client.ui.impl.gwt.widget.adapter.UiWidgetAdapterGwt

addHandlerRegistration, addStyle, createAbsoluteImageUrl, createEventAdapter, getHeightInPixel, getImage, getImageParentElement, getLength, getSizeElement, getToplevelWidget, getToplevelWidget, getWidthInPixel, isStyleDeltaSupported, removeStyle, setAttribute, setId, setImage, setLength, setPrimaryStyle, setStyles, setTooltip, setVisible

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

applyEventAdapter, applyEventAdapterForSelection, getEventAdapter, setEventSender

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

createLabel, getAccessKey, getAltText, getAttribute, getBundle, getColumnSpan, getContext, getHeightInRows, getId, getLabel, getMaximumTextLength, getPrimaryStyle, getSelectionMode, getStyles, getTitle, getTooltip, getToplevelWidget, getUiWidget, getUiWidgetTyped, getUrl, getValidationFailure, hasStyle, isDisposed, isEnabled, isFocused, isResizable, setParent, setUiWidget

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sf.mmm.client.ui.base.widget.adapter.UiWidgetAdapter

createAbsoluteImageUrl, createLabel, getToplevelWidget, isStyleDeltaSupported, removeFromParent, setEventSender, setParent, setVisible

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

setLength

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

getLength

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

getHeightInPixel, getWidthInPixel

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

getAttribute

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

setAttribute

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

getValidationFailure

Field Detail

widgetViewMode

private com.google.gwt.user.client.ui.Widget widgetViewMode

See Also:

getWidgetViewMode()

activeWidget

private WIDGET extends com.google.gwt.user.client.ui.Widget activeWidget

See Also:

getActiveWidget()

widgetMarkerEditMode

private com.google.gwt.user.client.ui.InlineLabel widgetMarkerEditMode

A marker displayed after the activeWidget in edit mode. Empty by default. May be used to show error markers.

recentValue

private ADAPTER_VALUE recentValue

See Also:

getValue()

recentStringValue

private String recentStringValue

See Also:

getValueAsString()

Constructor Detail

UiWidgetAdapterGwtField

public UiWidgetAdapterGwtField()

The constructor.

Method Detail

getWidgetAsHasChangeHandlers

protected abstract com.google.gwt.event.dom.client.HasChangeHandlers getWidgetAsHasChangeHandlers()

Returns:

the widget as HasChangeHandlers or null if NOT supported.

getWidgetAsTakesValue

protected abstract com.google.gwt.user.client.TakesValue<ADAPTER_VALUE> getWidgetAsTakesValue()

Returns:

the widget as TakesValue.

getWidgetAsTakesValueString

protected abstract com.google.gwt.user.client.TakesValue<String> getWidgetAsTakesValueString()

Returns:

the widget as TakesValue for the value type String.

setMode

public void setMode(boolean editMode)

This method is called from UiModeChanger for AttributeWriteMode.setMode(net.sf.mmm.client.ui.api.common.UiMode). It only handles the predefined UiModes.

Specified by:

setMode in interface UiWidgetAdapter

Overrides:

setMode in class AbstractUiWidgetAdapter<com.google.gwt.user.client.ui.Widget>

Parameters:

editMode - - true of UiMode.EDIT and false for UiMode.VIEW.

updateWidgetViewMode

protected void updateWidgetViewMode()

This method updates the view-mode-widget such that it displays the current value.

setAdapterValueInViewMode

protected void setAdapterValueInViewMode(ADAPTER_VALUE value)

This method updates the view-mode-widget such that it displays the given value. By default a label is created for view-mode. If you change this you will also need to override this method to properly apply the value.

Parameters:

value - is the value to display.

setValueInViewMode

protected void setValueInViewMode(String value)

This method updates the view-mode-widget such that it displays the given value. By default a label is created for view-mode. If you change this you will also need to override this method to properly apply the value.

Parameters:

value - is the value to display.

convertValueToString

protected String convertValueToString(ADAPTER_VALUE value)

Converts the given value to String.

Parameters:

value - the value to convert.

Returns:

the String representation of the given value.

applyEventAdapterForChange

protected void applyEventAdapterForChange(EventAdapterGwt adapter)

Applies for EventType.VALUE_CHANGE events.

Overrides:

applyEventAdapterForChange in class AbstractUiWidgetAdapterWithEvents<com.google.gwt.user.client.ui.Widget,EventAdapterGwt>

Parameters:

adapter - is the event adapter.

getValue

public ADAPTER_VALUE getValue()

This method gets the value of this object.

Specified by:

getValue in interface AttributeReadValue<ADAPTER_VALUE>

Returns:

the value of this object. May be null unless otherwise stated.

setValue

public void setValue(ADAPTER_VALUE value)

This method sets the value.

Specified by:

setValue in interface AttributeWriteValue<ADAPTER_VALUE>

Parameters:

value - is the new value. May be null unless otherwise stated.

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.

createToplevelWidget

protected final com.google.gwt.user.client.ui.Widget createToplevelWidget()

This method creates the underlying widget.
ATTENTION:
This method is called from the constructor but implemented in sub-classes. You should NOT access or even modify member variables as they are NOT set at this point (even final members). However, this design is done by intention instead of passing the widget as constructor argument to give more flexibility by overriding and also for potential lazy initialization of the widget.

Specified by:

createToplevelWidget in class AbstractUiWidgetAdapter<com.google.gwt.user.client.ui.Widget>

Returns:

a new instance of the underlying widget.

getWidgetViewMode

protected final com.google.gwt.user.client.ui.Widget getWidgetViewMode()

Returns:

the widget for the view-mode.

createViewWidget

protected com.google.gwt.user.client.ui.Widget createViewWidget()

Creates the Widget that is used to display the field value in view-mode. If you override this method and change the widget type you will also need to override updateWidgetViewMode().

Returns:

a new view Widget.

getActiveWidget

public final WIDGET getActiveWidget()

Description copied from class: UiWidgetAdapterGwtWidget

This method gets the active widget. For simple cases this will be the same as AbstractUiWidgetAdapter.getToplevelWidget(). In more complex scenarios the toplevel widget may only be a container widget and this method returns a child that represents the active part.

Overrides:

getActiveWidget in class UiWidgetAdapterGwtWidget<com.google.gwt.user.client.ui.Widget>

Returns:

the widget for the edit-mode.

attachActiveWidget

protected void attachActiveWidget(com.google.gwt.user.client.ui.ComplexPanel panel)

Attaches the active widget after creation to AbstractUiWidgetAdapter.getToplevelWidget(). May be overridden for composed active widgets.

Parameters:

panel - is the ComplexPanel (see AbstractUiWidgetAdapter.getToplevelWidget()) where to attach.

createActiveWidget

protected abstract WIDGET createActiveWidget()

Returns:

a new Widget that is used to display and modify the field value in edit-mode.

getInputElement

protected com.google.gwt.dom.client.Element getInputElement()

Returns:

the input Element representing the actual editable field.

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.

getMinimumValue

public ADAPTER_VALUE getMinimumValue()

This method gets the minimum value of this object. A legal value has to be greater or equal to this minimum.

Specified by:

getMinimumValue in interface AttributeReadMinimumValue<ADAPTER_VALUE>

Returns:

the minimum allowed for value or null if unbounded.

getMaximumValue

public ADAPTER_VALUE getMaximumValue()

This method gets the maximum value of this object. A legal value has to be less or equal to this maximum.

Specified by:

getMaximumValue in interface AttributeReadMaximumValue<ADAPTER_VALUE>

Returns:

the maximum allowed for value or null if unbounded.