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

Class UiWidgetAdapterGwtWidgetActive<WIDGET extends com.google.gwt.user.client.ui.Widget>

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

Type Parameters:

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

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, AttributeWriteAccessKey, AttributeWriteAttribute, AttributeWriteEnabled, AttributeWriteFocused, AttributeWriteHtmlId, AttributeWriteImage<UiWidgetImage>, AttributeWriteKeyboardFilter, AttributeWriteLengthProperty, AttributeWriteOnlyAttribute, AttributeWriteOnlyFocused, AttributeWritePrimaryStyle, AttributeWriteStyles, AttributeWriteStylesAdvanced, AttributeWriteTooltip, UiWidgetAdapter, UiWidgetAdapterActive, HandlerRegistrationCollector, AttributeReadDisposed, AttributeReadId<String>, AttributeReadTitle<String>, AttributeWriteDisposed, AttributeWriteId<String>, Accessibility

Direct Known Subclasses:

UiWidgetAdapterGwtAbstractDataTable, UiWidgetAdapterGwtCollapsableSection, UiWidgetAdapterGwtField, UiWidgetAdapterGwtFocusWidget, UiWidgetAdapterGwtTree

public abstract class UiWidgetAdapterGwtWidgetActive<WIDGET extends com.google.gwt.user.client.ui.Widget>
extends UiWidgetAdapterGwtWidget<WIDGET>
implements UiWidgetAdapterActive, AttributeWriteKeyboardFilter

This is the implementation of UiWidgetAdapterActive using GWT based on Widget.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private KeyboardFilterAdapter	keyboardFilterAdapter

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
UiWidgetAdapterGwtWidgetActive() The constructor.

Method Summary

Modifier and Type	Method and Description
protected void	applyEventAdapterForClick(EventAdapterGwt adapter) Applies for EventType.CLICK events.
protected void	applyEventAdapterForFocus(EventAdapterGwt adapter) Applies for EventType.FOCUS_GAIN and EventType.FOCUS_LOSS events.
CharFilter	getKeyboardFilter() This method gets the keyboard-filter.
protected abstract com.google.gwt.user.client.ui.Focusable	getWidgetAsFocusable()
protected abstract com.google.gwt.event.dom.client.HasAllFocusHandlers	getWidgetAsHasAllFocusHandlers()
protected com.google.gwt.event.dom.client.HasBlurHandlers	getWidgetAsHasBlurHandlers()
protected com.google.gwt.event.dom.client.HasFocusHandlers	getWidgetAsHasFocusHandlers()
protected abstract com.google.gwt.event.dom.client.HasKeyPressHandlers	getWidgetAsKeyPressHandlers()
void	setAccessKey(char accessKey) This method sets the accessKey attribute of this object.
protected com.google.gwt.event.shared.HandlerRegistration	setClickEventSender(com.google.gwt.event.dom.client.ClickHandler handler, com.google.gwt.user.client.ui.Widget widget) Registers the given handler for click events.
boolean	setFocused() This method sets the focus to this object.
void	setKeyboardFilter(CharFilter keyboardFilter) This method sets the keyboard-filter.

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

dispose, getActiveWidget, 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, applyEventAdapterForChange, applyEventAdapterForSelection, getEventAdapter, setEventSender

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

createLabel, createToplevelWidget, 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, setMode, 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, setMode, 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.AttributeReadAccessKey

getAccessKey

Field Detail

keyboardFilterAdapter

private KeyboardFilterAdapter keyboardFilterAdapter

See Also:

getKeyboardFilter()

Constructor Detail

UiWidgetAdapterGwtWidgetActive

public UiWidgetAdapterGwtWidgetActive()

The constructor.

Method Detail

getWidgetAsFocusable

protected abstract com.google.gwt.user.client.ui.Focusable getWidgetAsFocusable()

Returns:

the widget as Focusable or null if NOT supported.

getWidgetAsKeyPressHandlers

protected abstract com.google.gwt.event.dom.client.HasKeyPressHandlers getWidgetAsKeyPressHandlers()

Returns:

the widget as HasKeyPressHandlers or null if NOT supported.

getWidgetAsHasAllFocusHandlers

protected abstract com.google.gwt.event.dom.client.HasAllFocusHandlers getWidgetAsHasAllFocusHandlers()

Returns:

the widget as HasAllFocusHandlers or null if NOT supported.

getWidgetAsHasFocusHandlers

protected com.google.gwt.event.dom.client.HasFocusHandlers getWidgetAsHasFocusHandlers()

Returns:

the widget as HasFocusHandlers or null if NOT supported.

getWidgetAsHasBlurHandlers

protected com.google.gwt.event.dom.client.HasBlurHandlers getWidgetAsHasBlurHandlers()

Returns:

the widget as HasBlurHandlers or null if NOT supported.

setClickEventSender

protected com.google.gwt.event.shared.HandlerRegistration setClickEventSender(com.google.gwt.event.dom.client.ClickHandler handler,
                                                                              com.google.gwt.user.client.ui.Widget widget)

Registers the given handler for click events.

Parameters:

handler - is the ClickHandler to register.

widget - is the Widget where to register the ClickHandler.

Returns:

the GWT HandlerRegistration.

setFocused

public final boolean setFocused()

This method sets the focus to this object.
NOTE:
You can only set the focus. To actually remove it, you need to set it in a different widget. Further, as an API user you can normally ignore the result. This is only relevant for composite widgets such as panels, that delegate the call recursively and may not contain any child that can take the focus.

Specified by:

setFocused in interface AttributeWriteOnlyFocused

Returns:

true if the focus has been set successfully, false otherwise.

applyEventAdapterForClick

protected void applyEventAdapterForClick(EventAdapterGwt adapter)

Applies for EventType.CLICK events.

Overrides:

applyEventAdapterForClick in class AbstractUiWidgetAdapterWithEvents<WIDGET extends com.google.gwt.user.client.ui.Widget,EventAdapterGwt>

Parameters:

adapter - is the event adapter.

applyEventAdapterForFocus

protected void applyEventAdapterForFocus(EventAdapterGwt adapter)

Applies for EventType.FOCUS_GAIN and EventType.FOCUS_LOSS events.

Overrides:

applyEventAdapterForFocus in class AbstractUiWidgetAdapterWithEvents<WIDGET extends com.google.gwt.user.client.ui.Widget,EventAdapterGwt>

Parameters:

adapter - is the event adapter.

getKeyboardFilter

public final CharFilter getKeyboardFilter()

This method gets the keyboard-filter. Only characters accepted by filter can be entered into the according UI field.

Specified by:

getKeyboardFilter in interface AttributeReadKeyboardFilter

Returns:

the current keyboard-filter or null if not set.

setKeyboardFilter

public final void setKeyboardFilter(CharFilter keyboardFilter)

This method sets the keyboard-filter. Typically such filter is only set once (e.g. to build custom datatype fields based on generic text input widgets) and then never changed.
ATTENTION:
A keyboard filter is no guarantee that it is impossible for the user to enter invalid characters. E.g. if you are building a web-client some browser quirks allow to bypass the keyboard filter using copy and paste. Be sure to also validate the result in any case.

Specified by:

setKeyboardFilter in interface AttributeWriteKeyboardFilter

Parameters:

keyboardFilter - is the keyboard filter to set. An existing filter will be replaced. May be null to remove an existing filter.

setAccessKey

public void setAccessKey(char accessKey)

This method sets the accessKey attribute of this object.

Specified by:

setAccessKey in interface AttributeWriteAccessKey

Parameters:

accessKey - is the new value of AttributeReadAccessKey.getAccessKey(). Use AttributeReadAccessKey.ACCESS_KEY_NONE to unset.