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

Class UiWidgetAdapterGwt<WIDGET extends com.google.gwt.user.client.ui.UIObject>

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>

Type Parameters:

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

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, AttributeWriteImage<UiWidgetImage>, AttributeWriteLengthProperty, AttributeWriteOnlyAttribute, AttributeWritePrimaryStyle, AttributeWriteStyles, AttributeWriteStylesAdvanced, AttributeWriteTooltip, UiWidgetAdapter, HandlerRegistrationCollector, AttributeReadDisposed, AttributeReadId<String>, AttributeReadTitle<String>, AttributeWriteDisposed, AttributeWriteId<String>, Accessibility

Direct Known Subclasses:

UiWidgetAdapterGwtMenuItemBase, UiWidgetAdapterGwtMenuItemSeparator, UiWidgetAdapterGwtWidget

public abstract class UiWidgetAdapterGwt<WIDGET extends com.google.gwt.user.client.ui.UIObject>
extends AbstractUiWidgetAdapterWithEvents<WIDGET,EventAdapterGwt>
implements AttributeWriteImage<UiWidgetImage>, HandlerRegistrationCollector

This is the implementation of UiWidgetAdapter using GWT based on UIObject.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
private com.google.gwt.user.client.ui.Image	image
protected static int	TAB_INDEX_NONE The tab index to remove from tab-order.

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
UiWidgetAdapterGwt() The constructor.
UiWidgetAdapterGwt(WIDGET toplevelWidget) The constructor.

Method Summary

Modifier and Type	Method and Description
void	addHandlerRegistration(com.google.gwt.event.shared.HandlerRegistration registration) This method is to be called with the HandlerRegistration for all permanent handlers.
boolean	addStyle(String style) This method adds the given style to the styles.
String	createAbsoluteImageUrl(String relativePath) This method creates an absolute URL from the given relativePath.
protected EventAdapterGwt	createEventAdapter(UiFeatureEvent source, UiHandlerEvent sender) This method creates the AbstractUiWidgetAdapterWithEvents.getEventAdapter() instance.
void	dispose() This method disposes this object.
com.google.gwt.user.client.ui.UIObject	getActiveWidget() This method gets the active widget.
double	getHeightInPixel() This method gets the height of this object in pixels.
UiWidgetImage	getImage() This method gets the image of this object.
protected com.google.gwt.dom.client.Element	getImageParentElement() This method gets the parent-Element where a potential image is attached.
Length	getLength(LengthProperty property) This method gets the Length for the given LengthProperty of this object.
protected com.google.gwt.dom.client.Element	getSizeElement()
protected static com.google.gwt.user.client.ui.Widget	getToplevelWidget(UiWidget widget) This method is a simplified variant of getToplevelWidget(UiWidget, Class).
protected static <W extends com.google.gwt.user.client.ui.UIObject> W	getToplevelWidget(UiWidget widget, Class<W> widgetType) This method gets the native widget of the given widget.
double	getWidthInPixel() This method gets the width of this object in pixels.
boolean	isStyleDeltaSupported() This method determines if the style delta operations AttributeWriteStylesAdvanced.addStyle(String), AttributeWriteStylesAdvanced.removeStyle(String) and AttributeWritePrimaryStyle.setPrimaryStyle(String) are supported by this widget adapter.
boolean	removeStyle(String style) This method removes the given style from the styles.
void	setAttribute(String name, String value) This method sets the attribute of this object.
void	setId(String id) This method set the ID of this object.
void	setImage(UiWidgetImage imageWidget) This method sets the image of this object.
void	setLength(LengthProperty property, Length length) This method sets the specified length of this object.
void	setPrimaryStyle(String primaryStyle) This method sets the primary style.
void	setStyles(String styles) This method clears all styles and sets them to the given styles.
void	setTooltip(String tooltip) This method sets the tooltip text of this object.
void	setVisible(boolean visible, boolean programmatic)

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

applyEventAdapter, applyEventAdapterForChange, applyEventAdapterForClick, applyEventAdapterForFocus, 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

removeFromParent

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

setEnabled

Field Detail

TAB_INDEX_NONE

protected static final int TAB_INDEX_NONE

The tab index to remove from tab-order. Should actually be -1. See GWT bug 8323.

See Also:

Constant Field Values

image

private com.google.gwt.user.client.ui.Image image

See Also:

setImage(UiWidgetImage)

Constructor Detail

UiWidgetAdapterGwt

public UiWidgetAdapterGwt()

The constructor.

UiWidgetAdapterGwt

public UiWidgetAdapterGwt(WIDGET toplevelWidget)

The constructor.

Parameters:

toplevelWidget - is the toplevel widget.

Method Detail

getToplevelWidget

protected static final com.google.gwt.user.client.ui.Widget getToplevelWidget(UiWidget widget)

This method is a simplified variant of getToplevelWidget(UiWidget, Class).

Parameters:

widget - is the UiWidget to "unwrap".

Returns:

the native widget.

getToplevelWidget

protected static final <W extends com.google.gwt.user.client.ui.UIObject> W getToplevelWidget(UiWidget widget,
                                                                                              Class<W> widgetType)

This method gets the native widget of the given widget.

Type Parameters:

W - is the generic type of widgetType.

Parameters:

widget - is the UiWidget to "unwrap".

widgetType - is the expected type of the native widget.

Returns:

the native widget.

getActiveWidget

public com.google.gwt.user.client.ui.UIObject getActiveWidget()

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 AbstractUiWidgetAdapter<WIDGET extends com.google.gwt.user.client.ui.UIObject>

Returns:

the active widget.

setId

public void setId(String id)

This method set the ID of this object. Use this method to give the object a meaningful identifier after creation.
ATTENTION:
See javadoc of AttributeReadHtmlId.getId() for the syntax constraints of IDs.

Specified by:

setId in interface AttributeWriteHtmlId

Specified by:

setId in interface AttributeWriteId<String>

Parameters:

id - is the new ID for the object.

setTooltip

public void setTooltip(String tooltip)

This method sets the tooltip text of this object.

Specified by:

setTooltip in interface AttributeWriteTooltip

Parameters:

tooltip - is the new tooltip text or null to disable the tooltip.

See Also:

AttributeReadTooltip.getTooltip()

setAttribute

public void setAttribute(String name,
                         String value)

This method sets the attribute of this object.

Specified by:

setAttribute in interface AttributeWriteOnlyAttribute

Parameters:

name - is the name of the attribute.

value - is the new value of the attribute. May be null to unset (remove attribute).

setVisible

public void setVisible(boolean visible,
                       boolean programmatic)

Specified by:

setVisible in interface UiWidgetAdapter

Parameters:

visible - - true to set visible (show), false to set invisible (hide).

programmatic - - see UiEvent.isProgrammatic().

See Also:

AttributeWriteVisibleAdvanced.setVisible(boolean, boolean)

setStyles

public void setStyles(String styles)

This method clears all styles and sets them to the given styles. This will also update the primary style.

Specified by:

setStyles in interface AttributeWriteStyles

Parameters:

styles - are the styles of this object. Either a single style or a list of styles separated by whitespaces. Use the empty string to unset all styles.

addStyle

public boolean addStyle(String style)

This method adds the given style to the styles.

Specified by:

addStyle in interface AttributeWriteStylesAdvanced

Overrides:

addStyle in class AbstractUiWidgetAdapter<WIDGET extends com.google.gwt.user.client.ui.UIObject>

Parameters:

style - is the style to add. If this style is already contained in the styles, this will have no effect.

Returns:

true if the styles has actually been added, false if it was already present before.

removeStyle

public boolean removeStyle(String style)

This method removes the given style from the styles.

Specified by:

removeStyle in interface AttributeWriteStylesAdvanced

Overrides:

removeStyle in class AbstractUiWidgetAdapter<WIDGET extends com.google.gwt.user.client.ui.UIObject>

Parameters:

style - is the style to remove. If this style is NOT contained in the styles, this will have no effect.

Returns:

true if the given style has actually been removed, false otherwise (if it was NOT present).

setPrimaryStyle

public void setPrimaryStyle(String primaryStyle)

This method sets the primary style.

Specified by:

setPrimaryStyle in interface AttributeWritePrimaryStyle

Overrides:

setPrimaryStyle in class AbstractUiWidgetAdapter<WIDGET extends com.google.gwt.user.client.ui.UIObject>

Parameters:

primaryStyle - is the new value for primary style.

See Also:

AttributeReadStyles.getStyles()

isStyleDeltaSupported

public boolean isStyleDeltaSupported()

This method determines if the style delta operations AttributeWriteStylesAdvanced.addStyle(String), AttributeWriteStylesAdvanced.removeStyle(String) and AttributeWritePrimaryStyle.setPrimaryStyle(String) are supported by this widget adapter. Otherwise such operations are always performed via the AttributeWriteStyles.setStyles(String) method. If supported the delta operations are preferred as they are assumed to be more efficient.

Specified by:

isStyleDeltaSupported in interface UiWidgetAdapter

Overrides:

isStyleDeltaSupported in class AbstractUiWidgetAdapter<WIDGET extends com.google.gwt.user.client.ui.UIObject>

Returns:

true if style delta operations are supported, false otherwise.

getLength

public Length getLength(LengthProperty property)

This method gets the Length for the given LengthProperty of this object.
E.g. the call of getLength(LengthProperty.WIDTH) will return the same result as AttributeReadSize.getWidth(). Unlike AttributeReadSize this method provides access to additional properties such as e.g. LengthProperty.MIN_WIDTH or LengthProperty.MAX_HEIGHT.

Specified by:

getLength in interface AttributeReadLengthProperty

Parameters:

property - is the LengthProperty identifying the actual property to get.

Returns:

the requested Length. Will be Length.ZERO if undefined (NOT set).

setLength

public void setLength(LengthProperty property,
                      Length length)

This method sets the specified length of this object.
E.g. the call of setLength(LengthProperty.WIDTH, value) will return the same result as setWidth(value).

Specified by:

setLength in interface AttributeWriteLengthProperty

Parameters:

property - is the LengthProperty identifying the actual property to set.

length - is the new length to set.

getWidthInPixel

public double getWidthInPixel()

This method gets the width of this object in pixels.
NOTE:
The result will typically be an int value. However, to be compatible with Length.getAmount() and with some underlying native toolkits we use double to prevent potential information loss.

Specified by:

getWidthInPixel in interface AttributeReadSizeInPixel

Returns:

the width.

getHeightInPixel

public double getHeightInPixel()

This method gets the height of this object in pixels.
NOTE:
The result will typically be an int value. However, to be compatible with Length.getAmount() and with some underlying native toolkits we use double to prevent potential information loss.

Specified by:

getHeightInPixel in interface AttributeReadSizeInPixel

Returns:

the height.

getSizeElement

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

Returns:

the sized Element used by getLength(LengthProperty) and setLength(LengthProperty, Length).

createEventAdapter

protected EventAdapterGwt createEventAdapter(UiFeatureEvent source,
                                             UiHandlerEvent sender)

This method creates the AbstractUiWidgetAdapterWithEvents.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.

Specified by:

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

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.

setImage

public void setImage(UiWidgetImage imageWidget)

This method sets the image of this object. A previously set image will be replaced.

Specified by:

setImage in interface AttributeWriteImage<UiWidgetImage>

Parameters:

imageWidget - is the new image or null to remove the image.

getImageParentElement

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

This method gets the parent-Element where a potential image is attached.

Returns:

the parent-Element for an image.

getImage

public UiWidgetImage getImage()

This method gets the image of this object. If the image is attached to an object with arbitrary other features and has a smaller size, it is typically called icon.

Specified by:

getImage in interface AttributeReadImage<UiWidgetImage>

Overrides:

getImage in class AbstractUiWidgetAdapter<WIDGET extends com.google.gwt.user.client.ui.UIObject>

Returns:

the image or null if no image is defined.

dispose

public void dispose()

This method disposes this object. The resources of the object are deallocated and the object can not be used or displayed anymore. If this is an object of the UI (user interface) it will be detached.

Specified by:

dispose in interface AttributeWriteDisposed

createAbsoluteImageUrl

public String createAbsoluteImageUrl(String relativePath)

This method creates an absolute URL from the given relativePath.

Specified by:

createAbsoluteImageUrl in interface UiWidgetAdapter

Parameters:

relativePath - is the relative path (URL suffix) to the image.

Returns:

the absolute URL.

See Also:

UiConfiguration.getTheme()

addHandlerRegistration

public void addHandlerRegistration(com.google.gwt.event.shared.HandlerRegistration registration)

This method is to be called with the HandlerRegistration for all permanent handlers. This allows to remove them on disposal.

Specified by:

addHandlerRegistration in interface HandlerRegistrationCollector

Parameters:

registration - is the HandlerRegistration to add.