net.sf.mmm.client.ui.api.widget

Interface UiWidget

All Superinterfaces:

AbstractValidatableObject, Accessibility, AttributeReadAriaRole, AttributeReadDisposed, AttributeReadEnabled, AttributeReadHtmlId, AttributeReadId<String>, AttributeReadMode, AttributeReadModeFixed, AttributeReadModified, AttributeReadPrimaryStyle, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadTooltip, AttributeReadVisible, AttributeReadVisibleRecursive, AttributeWriteDisposed, AttributeWriteEnabled, AttributeWriteHtmlId, AttributeWriteId<String>, AttributeWriteMode, AttributeWriteModeFixed, AttributeWritePrimaryStyle, AttributeWriteStyles, AttributeWriteStylesAdvanced, AttributeWriteTooltip, AttributeWriteVisible, AttributeWriteVisibleAdvanced, UiFeature, UiFeatureEvent, UiFeatureMessages, UiFeatureMode

All Known Subinterfaces:

UiWidgetAbstractBorderPanel, UiWidgetAbstractButton, UiWidgetAbstractButtonContainer, UiWidgetAbstractComposite, UiWidgetAbstractDataSet<ITEM>, UiWidgetAbstractDataTable<ROW>, UiWidgetAbstractDialogWindow, UiWidgetAbstractListTable<ROW>, UiWidgetAbstractTree<NODE>, UiWidgetAbstractTree.UiWidgetTreeNode<NODE>, UiWidgetAbstractWindow, UiWidgetAbstractWithValue<VALUE>, UiWidgetActive, UiWidgetBorderPanel, UiWidgetButton, UiWidgetButtonGroup, UiWidgetButtonPanel, UiWidgetButtonSeparator, UiWidgetCheckboxesField<VALUE>, UiWidgetCheckboxField, UiWidgetClickable, UiWidgetCodeAreaField, UiWidgetCollapsableBorderPanel, UiWidgetCollapsableSection, UiWidgetColorField, UiWidgetComboboxField<VALUE>, UiWidgetComposite<CHILD>, UiWidgetDateField, UiWidgetDoubleField, UiWidgetDynamicComposite<CHILD>, UiWidgetDynamicPanel<CHILD>, UiWidgetField<VALUE>, UiWidgetFileField, UiWidgetGridCell, UiWidgetGridPanel, UiWidgetGridRow, UiWidgetHorizontalPanel, UiWidgetHorizontalSplitPanel, UiWidgetImage, UiWidgetInstantField, UiWidgetIntegerField, UiWidgetIntegerSliderField, UiWidgetLabel, UiWidgetLink, UiWidgetListBase<ROW>, UiWidgetListBoxField<VALUE>, UiWidgetListContainer<ITEM>, UiWidgetListTable<ROW>, UiWidgetLocalDateField, UiWidgetLocalTimeField, UiWidgetLongField, UiWidgetMainWindow, UiWidgetMedia, UiWidgetMediaAudio, UiWidgetMediaPlayer, UiWidgetMediaVideo, UiWidgetMenu, UiWidgetMenuBar, UiWidgetMenuItem, UiWidgetMenuItemCheckbox, UiWidgetMenuItemClickable, UiWidgetMenuItemRadioButton, UiWidgetMenuItemSeparator, UiWidgetMultiComposite<CHILD>, UiWidgetNative, UiWidgetOptionListTable<ROW>, UiWidgetOptionsBase<VALUE>, UiWidgetOptionsField<VALUE>, UiWidgetPanel<CHILD>, UiWidgetPasswordField, UiWidgetPopup, UiWidgetRadioButtonsField<VALUE>, UiWidgetRadioButtonsVerticalField<VALUE>, UiWidgetRangeField<VALUE>, UiWidgetRegular, UiWidgetRegularComposite<CHILD>, UiWidgetRichTextField, UiWidgetSection, UiWidgetSingleComposite<CHILD>, UiWidgetSingleMutableComposite<CHILD>, UiWidgetSlot, UiWidgetSplitPanel, UiWidgetSwitchComposite<CHILD>, UiWidgetSwitchPanel, UiWidgetTab, UiWidgetTableColumn<ROW,CELL>, UiWidgetTabPanel, UiWidgetTextAreaField, UiWidgetTextField, UiWidgetTextualInputField<VALUE>, UiWidgetToggleButton, UiWidgetToolbar, UiWidgetTree<NODE>, UiWidgetTreeTable<NODE>, UiWidgetVerticalPanel, UiWidgetVerticalSplitPanel, UiWidgetWindow, UiWidgetWithSelectedValue<VALUE>, UiWidgetWithValue<VALUE>

All Known Implementing Classes:

AbstractUiWidget, AbstractUiWidgetAbstractBorderPanel, AbstractUiWidgetAbstractButton, AbstractUiWidgetAbstractButtonContainer, AbstractUiWidgetAbstractDataSet, AbstractUiWidgetAbstractDataTable, AbstractUiWidgetAbstractDialogWindow, AbstractUiWidgetAbstractListTable, AbstractUiWidgetAbstractWindow, AbstractUiWidgetActive, AbstractUiWidgetBorderPanel, AbstractUiWidgetButton, AbstractUiWidgetButtonGroup, AbstractUiWidgetButtonPanel, AbstractUiWidgetCheckboxField, AbstractUiWidgetClickable, AbstractUiWidgetCodeAreaField, AbstractUiWidgetCollapsableBorderPanel, AbstractUiWidgetCollapsableSection, AbstractUiWidgetColorField, AbstractUiWidgetComboboxField, AbstractUiWidgetComposite, AbstractUiWidgetCustomMasterDetail, AbstractUiWidgetCustomTwoListSelection, AbstractUiWidgetDateField, AbstractUiWidgetDoubleField, AbstractUiWidgetDynamicComposite, AbstractUiWidgetDynamicPanel, AbstractUiWidgetField, AbstractUiWidgetFileField, AbstractUiWidgetGridCell, AbstractUiWidgetGridPanel, AbstractUiWidgetGridRow, AbstractUiWidgetHorizontalPanel, AbstractUiWidgetHorizontalSplitPanel, AbstractUiWidgetImage, AbstractUiWidgetInstantField, AbstractUiWidgetIntegerField, AbstractUiWidgetIntegerSliderField, AbstractUiWidgetLabel, AbstractUiWidgetLink, AbstractUiWidgetListBoxField, AbstractUiWidgetListTable, AbstractUiWidgetLocalDateField, AbstractUiWidgetLocalTimeField, AbstractUiWidgetLongField, AbstractUiWidgetMainWindow, AbstractUiWidgetMenu, AbstractUiWidgetMenuBar, AbstractUiWidgetMenuItemClickable, AbstractUiWidgetMenuItemSeparator, AbstractUiWidgetNative, AbstractUiWidgetNumberField, AbstractUiWidgetOptionsField, AbstractUiWidgetPasswordField, AbstractUiWidgetPopup, AbstractUiWidgetRadioButtonsField, AbstractUiWidgetRadioButtonsVerticalField, AbstractUiWidgetRangeField, AbstractUiWidgetRegularAtomic, AbstractUiWidgetRichTextField, AbstractUiWidgetSection, AbstractUiWidgetSingleComposite, AbstractUiWidgetSingleMutableComposite, AbstractUiWidgetSlot, AbstractUiWidgetSplitPanel, AbstractUiWidgetSwitchComposite, AbstractUiWidgetTab, AbstractUiWidgetTableColumn, AbstractUiWidgetTabPanel, AbstractUiWidgetTextAreaField, AbstractUiWidgetTextAreaFieldBase, AbstractUiWidgetTextField, AbstractUiWidgetTextFieldBase, AbstractUiWidgetTextualInputField, AbstractUiWidgetToggleButton, AbstractUiWidgetToolbar, AbstractUiWidgetTree, AbstractUiWidgetVerticalPanel, AbstractUiWidgetVerticalSplitPanel, AbstractUiWidgetWindow, AbstractUiWidgetWithLabel, UiWidgetAdapterGwtTree.TreeNodeAdapter, UiWidgetBorderPanelGwt, UiWidgetBorderPanelTestImpl, UiWidgetButtonGroupGwt, UiWidgetButtonGwt, UiWidgetButtonPanelGwt, UiWidgetButtonTestImpl, UiWidgetCheckboxFieldGwt, UiWidgetCheckboxFieldTestImpl, UiWidgetCodeAreaFieldTestImpl, UiWidgetCollapsableBorderPanelGwt, UiWidgetCollapsableSectionGwt, UiWidgetCollapsableSectionTestImpl, UiWidgetColorFieldGwt, UiWidgetColorFieldTestImpl, UiWidgetComboboxFieldGwt, UiWidgetComboboxFieldTestImpl, UiWidgetCustom, UiWidgetCustomAbstractDialogWindow, UiWidgetCustomAbstractListTable, UiWidgetCustomAbstractWindow, UiWidgetCustomAtomicNoValue, UiWidgetCustomButton, UiWidgetCustomButtonSave, UiWidgetCustomComposite, UiWidgetCustomCompositeNoValue, UiWidgetCustomDynamicComposite, UiWidgetCustomEditor, UiWidgetCustomField, UiWidgetCustomFieldAtomic, UiWidgetCustomFieldComposite, UiWidgetCustomFormEditor, UiWidgetCustomGridPanel, UiWidgetCustomListTable, UiWidgetCustomMasterDetail, UiWidgetCustomPanel, UiWidgetCustomPopup, UiWidgetCustomVerticalPanel, UiWidgetDateFieldGwt, UiWidgetDateFieldTestImpl, UiWidgetDoubleFieldGwt, UiWidgetDoubleFieldTestImpl, UiWidgetFileFieldGwt, UiWidgetFileFieldTestImpl, UiWidgetGridCellGwt, UiWidgetGridCellTestImpl, UiWidgetGridPanelGwt, UiWidgetGridPanelTestImpl, UiWidgetGridRowGwt, UiWidgetGridRowTestImpl, UiWidgetHorizontalPanelGwt, UiWidgetHorizontalPanelTestImpl, UiWidgetHorizontalSplitPanelGwt, UiWidgetImageGwt, UiWidgetImageTestImpl, UiWidgetIntegerFieldGwt, UiWidgetIntegerFieldTestImpl, UiWidgetIntegerSliderFieldGwt, UiWidgetIntegerSliderFieldTestImpl, UiWidgetLabelGwt, UiWidgetLabelTestImpl, UiWidgetLinkGwt, UiWidgetLinkTestImpl, UiWidgetListTableGwt, UiWidgetLocalDateFieldGwt, UiWidgetLocalDateFieldTestImpl, UiWidgetLocalTimeFieldGwt, UiWidgetLocalTimeFieldTestImpl, UiWidgetLongFieldGwt, UiWidgetLongFieldTestImpl, UiWidgetMainWindowGwt, UiWidgetMainWindowTestImpl, UiWidgetMenuBarGwt, UiWidgetMenuBarTestImpl, UiWidgetMenuGwt, UiWidgetMenuItemClickableGwt, UiWidgetMenuItemClickableTestImpl, UiWidgetMenuItemSeparatorGwt, UiWidgetMenuItemSeparatorTestImpl, UiWidgetMenuTestImpl, UiWidgetPasswordFieldGwt, UiWidgetPasswordFieldTestImpl, UiWidgetPopupGwt, UiWidgetPopupTestImpl, UiWidgetRadioButtonsFieldGwt, UiWidgetRadioButtonsTestImpl, UiWidgetRadioButtonsVerticalFieldGwt, UiWidgetRadioButtonsVerticalFieldTestImpl, UiWidgetRichTextFieldGwt, UiWidgetRichTextFieldTestImpl, UiWidgetSectionGwt, UiWidgetSectionTestImpl, UiWidgetSlotGwt, UiWidgetSlotTestImpl, UiWidgetTabGwt, UiWidgetTableColumnImpl, UiWidgetTabPanelGwt, UiWidgetTabPanelTestImpl, UiWidgetTabTestImpl, UiWidgetTextAreaFieldGwt, UiWidgetTextAreaFieldTestImpl, UiWidgetTextFieldGwt, UiWidgetTextFieldTestImpl, UiWidgetToggleButtonGwt, UiWidgetToolbarGwt, UiWidgetTreeGwt, UiWidgetTreeTestImpl, UiWidgetVerticalPanelGwt, UiWidgetVerticalPanelTestImpl, UiWidgetVerticalSplitPanelGwt, UiWidgetWindowGwt

public interface UiWidget
extends UiFeatureMessages, UiFeatureEvent, UiFeatureMode, AttributeWriteHtmlId, AttributeWriteTooltip, AttributeWriteVisibleAdvanced, AttributeWriteEnabled, AttributeWriteStylesAdvanced, AttributeWriteDisposed, AttributeReadModified, AttributeReadAriaRole, AbstractValidatableObject

This is the interface for an adapter to a physical widget (or potentially a composition of such widgets) of the underlying native widget toolkit.
A widget is any object of the UI (user interface) and may be atomic or composite.
Native widgets can be created via UiWidgetFactory that has implementations for all supported toolkits (technically via UiWidgetFactoryNative). This way you can decide which native toolkit you like to use just by configuration and classpath (See CDI).
If you want to make your UI code portable even for toolkits such as SWT, you need to make proper use of AttributeWriteDisposed.dispose() for all UiWidget that are no longer needed what is generally a good idea. Further for toolkits such as GWT there are strict limitations for the client-side code. The mmm project provides abstraction for various technology specific areas to fill the gaps for you. Use mmm-service for client/server communication and mmm-client-dialog for history-management, embedding, etc.
ATTENTION:
A UiWidget can only be used once in a client application. Even if you want to have the exact same button twice on the screen you need to create two distinct instances.
Please also note that UiWidget and all its sub-interfaces are extendable interfaces.

For advanced usage see also UiWidgetCustom.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
static String	STYLE_HEADER The style for a header element.

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
UiContext	getContext() This method gets the UiContext.
UiWidgetComposite<?>	getParent()
Size	getSize()

Methods inherited from interface net.sf.mmm.client.ui.api.feature.UiFeatureMessages

clearMessages

Methods inherited from interface net.sf.mmm.client.ui.api.feature.UiFeatureEvent

addEventHandler, removeEventHandler

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

setMode

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

getMode

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

setModeFixed

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

getModeFixed

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

getVisibleFlag, isVisible, setVisible, setVisible

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

isVisibleRecursive

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

isModified

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

getAriaRole

Methods inherited from interface net.sf.mmm.util.validation.api.AbstractValidatableObject

validate

Field Detail

STYLE_HEADER

static final String STYLE_HEADER

The style for a header element.

See Also:

Constant Field Values

Method Detail

getParent

UiWidgetComposite<?> getParent()

Returns:

the parent of this widget or null if NOT attached to the UI or if this is a root widget (e.g. UiWidgetMainWindow).

getContext

UiContext getContext()

This method gets the UiContext. This is the container with central components for the UI and client infrastructure. E.g. it contains the widget-factory that created this UiWidget. It may be used internally in UiWidget implementations as well as externally to create new UiWidgets (typically children).

Returns:

the UiContext.

getSize

Size getSize()

Returns:

the Size aspect to read and write the size of this widget.