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

Interface UiWidgetAdapter

All Superinterfaces:

Accessibility, AttributeReadAttribute, AttributeReadDisposed, AttributeReadEnabled, AttributeReadHtmlId, AttributeReadId<String>, AttributeReadLengthProperty, AttributeReadPrimaryStyle, AttributeReadSizeInPixel, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadTooltip, AttributeWriteAttribute, AttributeWriteDisposed, AttributeWriteEnabled, AttributeWriteHtmlId, AttributeWriteId<String>, AttributeWriteLengthProperty, AttributeWriteOnlyAttribute, AttributeWritePrimaryStyle, AttributeWriteStyles, AttributeWriteStylesAdvanced, AttributeWriteTooltip

All Known Subinterfaces:

UiWidgetAdapterAbstractBorderPanel, UiWidgetAdapterAbstractButtonContainer, UiWidgetAdapterAbstractDataSet<ITEM>, UiWidgetAdapterAbstractDataTable<ROW>, UiWidgetAdapterAbstractDialogWindow, UiWidgetAdapterAbstractListTable<ROW,ITEM_CONTAINER>, UiWidgetAdapterAbstractWindow, UiWidgetAdapterActive, UiWidgetAdapterBorderPanel, UiWidgetAdapterButton, UiWidgetAdapterButtonGroup, UiWidgetAdapterButtonPanel, UiWidgetAdapterCheckboxField, UiWidgetAdapterClickable, UiWidgetAdapterCodeAreaField, UiWidgetAdapterCollapsableBorderPanel, UiWidgetAdapterCollapsableSection, UiWidgetAdapterColorField, UiWidgetAdapterComboboxField<VALUE>, UiWidgetAdapterComposite<CHILD>, UiWidgetAdapterDateField, UiWidgetAdapterDoubleField, UiWidgetAdapterDynamicComposite<CHILD>, UiWidgetAdapterDynamicPanel, UiWidgetAdapterField<VALUE,ADAPTER_VALUE>, UiWidgetAdapterFileField, UiWidgetAdapterGridCell, UiWidgetAdapterGridPanel, UiWidgetAdapterGridRow, UiWidgetAdapterHorizontalPanel, UiWidgetAdapterHorizontalSplitPanel, UiWidgetAdapterImage, UiWidgetAdapterInstantField, UiWidgetAdapterIntegerField, UiWidgetAdapterIntegerSliderField, UiWidgetAdapterLabel, UiWidgetAdapterLink, UiWidgetAdapterListBoxField<VALUE>, UiWidgetAdapterListTable<ROW,ITEM_CONTAINER>, UiWidgetAdapterLocalDateField, UiWidgetAdapterLocalTimeField, UiWidgetAdapterLongField, UiWidgetAdapterMainWindow, UiWidgetAdapterMenu, UiWidgetAdapterMenuBar, UiWidgetAdapterMenuItemClickable, UiWidgetAdapterMenuItemSeparator, UiWidgetAdapterNumberField<VALUE>, UiWidgetAdapterOptionsField<VALUE>, UiWidgetAdapterPasswordField, UiWidgetAdapterPopup, UiWidgetAdapterRadioButtonsField<VALUE>, UiWidgetAdapterRangeField<VALUE>, UiWidgetAdapterRichTextField, UiWidgetAdapterSection, UiWidgetAdapterSingleComposite<CHILD>, UiWidgetAdapterSingleMutableComposite<CHILD>, UiWidgetAdapterSlot, UiWidgetAdapterSplitPanel, UiWidgetAdapterSwitchComposite<CHILD>, UiWidgetAdapterTab, UiWidgetAdapterTableColumn, UiWidgetAdapterTabPanel, UiWidgetAdapterTextAreaField, UiWidgetAdapterTextAreaFieldBase, UiWidgetAdapterTextField, UiWidgetAdapterTextFieldBase, UiWidgetAdapterTextualInputField<VALUE,ADAPTER_VALUE>, UiWidgetAdapterToggleButton, UiWidgetAdapterToolbar, UiWidgetAdapterTree<NODE>, UiWidgetAdapterVerticalPanel, UiWidgetAdapterVerticalSplitPanel, UiWidgetAdapterWindow, UiWidgetAdapterWithLabel

All Known Implementing Classes:

AbstractUiWidgetAdapter, AbstractUiWidgetAdapterWithEvents, UiWidgetAdapterGwt, UiWidgetAdapterGwtAbstractDataTable, UiWidgetAdapterGwtAbstractDialogWindow, UiWidgetAdapterGwtAbstractListTable, UiWidgetAdapterGwtAbstractWindow, UiWidgetAdapterGwtBorderPanel, UiWidgetAdapterGwtButton, UiWidgetAdapterGwtButtonGroup, UiWidgetAdapterGwtButtonPanel, UiWidgetAdapterGwtCheckboxField, UiWidgetAdapterGwtClickable, UiWidgetAdapterGwtCollapsableBorderPanel, UiWidgetAdapterGwtCollapsableSection, UiWidgetAdapterGwtColorField, UiWidgetAdapterGwtComboBoxField, UiWidgetAdapterGwtComposite, UiWidgetAdapterGwtDateField, UiWidgetAdapterGwtDoubleField, UiWidgetAdapterGwtDynamicComposite, UiWidgetAdapterGwtField, UiWidgetAdapterGwtFieldFocusWidget, UiWidgetAdapterGwtFieldFocusWidgetBase, UiWidgetAdapterGwtFieldValueBox, UiWidgetAdapterGwtFieldValueBoxBase, UiWidgetAdapterGwtFileField, UiWidgetAdapterGwtFocusWidget, UiWidgetAdapterGwtGridCell, UiWidgetAdapterGwtGridPanel, UiWidgetAdapterGwtGridRow, UiWidgetAdapterGwtHorizontalPanel, UiWidgetAdapterGwtHorizontalSplitPanel, UiWidgetAdapterGwtImage, UiWidgetAdapterGwtIntegerField, UiWidgetAdapterGwtIntegerSliderField, UiWidgetAdapterGwtLabel, UiWidgetAdapterGwtLink, UiWidgetAdapterGwtListBoxCombo, UiWidgetAdapterGwtListTable, UiWidgetAdapterGwtLocalDateField, UiWidgetAdapterGwtLocalTimeField, UiWidgetAdapterGwtLongField, UiWidgetAdapterGwtMainWindow, UiWidgetAdapterGwtMenu, UiWidgetAdapterGwtMenuBar, UiWidgetAdapterGwtMenuItem, UiWidgetAdapterGwtMenuItemBase, UiWidgetAdapterGwtMenuItemSeparator, UiWidgetAdapterGwtNumberField, UiWidgetAdapterGwtPanel, UiWidgetAdapterGwtPasswordField, UiWidgetAdapterGwtPopup, UiWidgetAdapterGwtRadioButtons, UiWidgetAdapterGwtRadioButtonsHorizontal, UiWidgetAdapterGwtRadioButtonsVertical, UiWidgetAdapterGwtRichTextField, UiWidgetAdapterGwtSection, UiWidgetAdapterGwtSingleComposite, UiWidgetAdapterGwtSingleMutableComposite, UiWidgetAdapterGwtSlot, UiWidgetAdapterGwtSplitPanel, UiWidgetAdapterGwtTab, UiWidgetAdapterGwtTabLayoutPanel, UiWidgetAdapterGwtTableColumn, UiWidgetAdapterGwtTextAreaBase, UiWidgetAdapterGwtTextAreaField, UiWidgetAdapterGwtTextBoxBase, UiWidgetAdapterGwtTextField, UiWidgetAdapterGwtToggleButton, UiWidgetAdapterGwtToolbar, UiWidgetAdapterGwtTree, UiWidgetAdapterGwtVerticalPanel, UiWidgetAdapterGwtVerticalSplitPanel, UiWidgetAdapterGwtWidget, UiWidgetAdapterGwtWidgetActive, UiWidgetAdapterGwtWindow, UiWidgetAdapterTest, UiWidgetAdapterTestCheckboxField, UiWidgetAdapterTestColorField, UiWidgetAdapterTestComposite, UiWidgetAdapterTestCompositeRegular, UiWidgetAdapterTestDateField, UiWidgetAdapterTestDoubleField, UiWidgetAdapterTestField, UiWidgetAdapterTestFileField, UiWidgetAdapterTestGridPanel, UiWidgetAdapterTestGridRow, UiWidgetAdapterTestIntegerField, UiWidgetAdapterTestLocalDateField, UiWidgetAdapterTestLocalTimeField, UiWidgetAdapterTestLongField, UiWidgetAdapterTestMenu, UiWidgetAdapterTestMenuBar, UiWidgetAdapterTestNumberField, UiWidgetAdapterTestOptionsField, UiWidgetAdapterTestSelectedValue, UiWidgetAdapterTestStringField, UiWidgetAdapterTestTabPanel, UiWidgetAdapterTestTree

public interface UiWidgetAdapter
extends AttributeWriteHtmlId, AttributeWriteTooltip, AttributeWriteEnabled, AttributeWriteStylesAdvanced, AttributeWriteDisposed, AttributeWriteLengthProperty, AttributeReadSizeInPixel, AttributeWriteAttribute

This is the interface that adapts to the native widget of the underlying toolkit implementation for a native widget.
It is a design trade-off as java does not have multi-inheritance (we would need scala traits here). This way it is possible to implement an abstract base-implementation for the types of the UiWidget-hierarchy and inherit different implementations (Swing, SWT, GWT, etc.) from that without creating redundant code.
ATTENTION:
The getters (AttributeRead* methods) of attributes that cannot be changed by the end-user are never used and therefore NOT implemented properly.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

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

Method Summary

Modifier and Type	Method and Description
String	createAbsoluteImageUrl(String relativePath) This method creates an absolute URL from the given relativePath.
UiWidgetLabel	createLabel(UiContext context) This method creates the label for this widget.
Object	getToplevelWidget()
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.
void	removeFromParent() This method removes the widget from its parent.
void	setEventSender(UiFeatureEvent source, UiHandlerEvent sender) This method registers the given event handler in the widget.
void	setMode(boolean editMode) This method is called from UiModeChanger for AttributeWriteMode.setMode(net.sf.mmm.client.ui.api.common.UiMode).
void	setParent(UiWidgetComposite<?> parent) This method gets called whenever the parent of the according UiWidget is changed.
void	setVisible(boolean visible, boolean programmatic)

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

Method Detail

getToplevelWidget

Object getToplevelWidget()

Returns:

the native widget.

See Also:

AbstractUiWidgetFactoryNative.getNativeWidget(net.sf.mmm.client.ui.api.widget.UiWidgetRegular)

removeFromParent

void removeFromParent()

This method removes the widget from its parent. After this method, the widget is detached from the UI.

setParent

void setParent(UiWidgetComposite<?> parent)

This method gets called whenever the parent of the according UiWidget is changed. It does nothing by default but may be overridden to deal with special behavior of native UI toolkits.

Parameters:

parent - is the new parent or null if removed from parent.

setVisible

void setVisible(boolean visible,
                boolean programmatic)

Parameters:

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

programmatic - - see UiEvent.isProgrammatic().

See Also:

AttributeWriteVisibleAdvanced.setVisible(boolean, boolean)

setMode

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.

Parameters:

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

createAbsoluteImageUrl

String createAbsoluteImageUrl(String relativePath)

This method creates an absolute URL from the given relativePath.

Parameters:

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

Returns:

the absolute URL.

See Also:

UiConfiguration.getTheme()

createLabel

UiWidgetLabel createLabel(UiContext context)

This method creates the label for this widget. Depending on the underlying toolkit implementation the native widget may already contain the label (applies e.g. for FormItem in SmartGWT). In such case this method will wrap it as UiWidgetLabel. Otherwise this method should create a new UiWidgetLabel and return it.

Parameters:

context - is the UiContext that may be used to create the label.

Returns:

the label.

isStyleDeltaSupported

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.

Returns:

true if style delta operations are supported, false otherwise.

setEventSender

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.