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

Class AbstractUiWidgetAdapterWithEvents<WIDGET,EVENT_ADAPTER extends AbstractEventAdapter>

java.lang.Object

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

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

Type Parameters:

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

EVENT_ADAPTER - is the generic type of getEventAdapter().

All Implemented Interfaces:

AttributeReadAccessKey, AttributeReadAltText, AttributeReadAttribute, AttributeReadColumnSpan, AttributeReadEnabled, AttributeReadFocused, AttributeReadHeightInRows, AttributeReadHtmlId, AttributeReadImage<UiWidgetImage>, AttributeReadLabel, AttributeReadLengthProperty, AttributeReadMaximumTextLength, AttributeReadPrimaryStyle, AttributeReadResizable, AttributeReadSelectionMode, AttributeReadSizeInPixel, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadTooltip, AttributeReadUrl, AttributeReadValidationFailure, AttributeWriteAttribute, AttributeWriteEnabled, AttributeWriteHtmlId, AttributeWriteLengthProperty, AttributeWriteOnlyAttribute, AttributeWritePrimaryStyle, AttributeWriteStyles, AttributeWriteStylesAdvanced, AttributeWriteTooltip, UiWidgetAdapter, AttributeReadDisposed, AttributeReadId<String>, AttributeReadTitle<String>, AttributeWriteDisposed, AttributeWriteId<String>, Accessibility

Direct Known Subclasses:

UiWidgetAdapterGwt

public abstract class AbstractUiWidgetAdapterWithEvents<WIDGET,EVENT_ADAPTER extends AbstractEventAdapter>
extends AbstractUiWidgetAdapter<WIDGET>

This class extends AbstractUiWidgetAdapter with #addEventHandler.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private EVENT_ADAPTER	eventAdapter

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

Fields inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadColumnSpan

ATTRIBUTE_COLSPAN

Constructor Summary

Constructors

Constructor and Description
AbstractUiWidgetAdapterWithEvents() The constructor.
AbstractUiWidgetAdapterWithEvents(WIDGET toplevelWidget) The constructor.

Method Summary

Modifier and Type	Method and Description
protected void	applyEventAdapter(EVENT_ADAPTER adapter) This method applies the given event adapter to the widget(s) so it receive native events.
protected void	applyEventAdapterForChange(EVENT_ADAPTER adapter) Applies for EventType.VALUE_CHANGE events.
protected void	applyEventAdapterForClick(EVENT_ADAPTER adapter) Applies for EventType.CLICK events.
protected void	applyEventAdapterForFocus(EVENT_ADAPTER adapter) Applies for EventType.FOCUS_GAIN and EventType.FOCUS_LOSS events.
protected void	applyEventAdapterForSelection(EVENT_ADAPTER adapter) Applies for EventType.SELECTION_CHANGE events.
protected abstract EVENT_ADAPTER	createEventAdapter(UiFeatureEvent source, UiHandlerEvent sender) This method creates the getEventAdapter() instance.
EVENT_ADAPTER	getEventAdapter()
void	setEventSender(UiFeatureEvent source, UiHandlerEvent sender) This method registers the given event handler in the widget.

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

addStyle, createLabel, createToplevelWidget, getAccessKey, getActiveWidget, getAltText, getAttribute, getBundle, getColumnSpan, getContext, getHeightInRows, getId, getImage, getLabel, getMaximumTextLength, getPrimaryStyle, getSelectionMode, getStyles, getTitle, getTooltip, getToplevelWidget, getUiWidget, getUiWidgetTyped, getUrl, getValidationFailure, hasStyle, isDisposed, isEnabled, isFocused, isResizable, isStyleDeltaSupported, removeStyle, setMode, setParent, setPrimaryStyle, 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, removeFromParent, 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.AttributeWriteTooltip

setTooltip

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

setEnabled

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

setStyles

Methods inherited from interface net.sf.mmm.util.lang.api.attribute.AttributeWriteDisposed

dispose

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

setAttribute

Field Detail

eventAdapter

private EVENT_ADAPTER extends AbstractEventAdapter eventAdapter

See Also:

setEventSender(UiFeatureEvent, UiHandlerEvent)

Constructor Detail

AbstractUiWidgetAdapterWithEvents

public AbstractUiWidgetAdapterWithEvents()

The constructor.

AbstractUiWidgetAdapterWithEvents

public AbstractUiWidgetAdapterWithEvents(WIDGET toplevelWidget)

The constructor.

Parameters:

toplevelWidget - is the toplevel widget.

Method Detail

setEventSender

public void setEventSender(UiFeatureEvent source,
                           UiHandlerEvent sender)

This method registers the given event handler in the widget. This method will be called only once.

Parameters:

source - is the event source.

sender - is the UiHandlerEvent where the events are send to. This is actually an adapter that dispatches the events to the individual listeners registered in the widget.

createEventAdapter

protected abstract EVENT_ADAPTER createEventAdapter(UiFeatureEvent source,
                                                    UiHandlerEvent sender)

This method creates the getEventAdapter() instance. It should to be implemented by the top-level widget-adapter class specific for a native UI toolkit. It may further be overridden to use a sub-class instead when more specific behavior is needed.

Parameters:

source - is the source of the events (typically UiWidget).

sender - is the sender of events (an adapter that delegates to the individual handlers/listeners).

Returns:

the new event adapter.

getEventAdapter

public EVENT_ADAPTER getEventAdapter()

Returns:

the event adapter. May be null.

See Also:

setEventSender(UiFeatureEvent, UiHandlerEvent), AbstractEventAdapter

applyEventAdapter

protected void applyEventAdapter(EVENT_ADAPTER adapter)

This method applies the given event adapter to the widget(s) so it receive native events. It will be called only once. Override only to add specific event registrations.

Parameters:

adapter - is the event adapter.

applyEventAdapterForClick

protected void applyEventAdapterForClick(EVENT_ADAPTER adapter)

Applies for EventType.CLICK events.

Parameters:

adapter - is the event adapter.

applyEventAdapterForFocus

protected void applyEventAdapterForFocus(EVENT_ADAPTER adapter)

Applies for EventType.FOCUS_GAIN and EventType.FOCUS_LOSS events.

Parameters:

adapter - is the event adapter.

applyEventAdapterForChange

protected void applyEventAdapterForChange(EVENT_ADAPTER adapter)

Applies for EventType.VALUE_CHANGE events.

Parameters:

adapter - is the event adapter.

applyEventAdapterForSelection

protected void applyEventAdapterForSelection(EVENT_ADAPTER adapter)

Applies for EventType.SELECTION_CHANGE events.

Parameters:

adapter - is the event adapter.