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

Interface UiWidgetAbstractComposite

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, UiWidget

All Known Subinterfaces:

UiWidgetAbstractBorderPanel, UiWidgetAbstractButtonContainer, UiWidgetAbstractDialogWindow, UiWidgetAbstractWindow, UiWidgetBorderPanel, UiWidgetButtonGroup, UiWidgetButtonPanel, UiWidgetCheckboxesField<VALUE>, UiWidgetCheckboxField, UiWidgetCodeAreaField, UiWidgetCollapsableBorderPanel, UiWidgetColorField, UiWidgetComboboxField<VALUE>, UiWidgetComposite<CHILD>, UiWidgetDateField, UiWidgetDoubleField, UiWidgetDynamicComposite<CHILD>, UiWidgetDynamicPanel<CHILD>, UiWidgetField<VALUE>, UiWidgetFileField, UiWidgetGridCell, UiWidgetGridPanel, UiWidgetGridRow, UiWidgetHorizontalPanel, UiWidgetHorizontalSplitPanel, UiWidgetInstantField, UiWidgetIntegerField, UiWidgetIntegerSliderField, UiWidgetListBoxField<VALUE>, UiWidgetLocalDateField, UiWidgetLocalTimeField, UiWidgetLongField, UiWidgetMainWindow, UiWidgetMediaPlayer, UiWidgetMenu, UiWidgetMenuBar, UiWidgetMultiComposite<CHILD>, UiWidgetOptionsField<VALUE>, UiWidgetPanel<CHILD>, UiWidgetPasswordField, UiWidgetPopup, UiWidgetRadioButtonsField<VALUE>, UiWidgetRadioButtonsVerticalField<VALUE>, UiWidgetRangeField<VALUE>, UiWidgetRegularComposite<CHILD>, UiWidgetRichTextField, UiWidgetSingleComposite<CHILD>, UiWidgetSingleMutableComposite<CHILD>, UiWidgetSlot, UiWidgetSplitPanel, UiWidgetSwitchComposite<CHILD>, UiWidgetSwitchPanel, UiWidgetTab, UiWidgetTabPanel, UiWidgetTextAreaField, UiWidgetTextField, UiWidgetTextualInputField<VALUE>, UiWidgetToolbar, UiWidgetVerticalPanel, UiWidgetVerticalSplitPanel, UiWidgetWindow

All Known Implementing Classes:

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, UiWidgetBorderPanelGwt, UiWidgetBorderPanelTestImpl, UiWidgetButtonGroupGwt, UiWidgetButtonGwt, UiWidgetButtonPanelGwt, UiWidgetButtonTestImpl, UiWidgetCheckboxFieldGwt, UiWidgetCheckboxFieldTestImpl, UiWidgetCodeAreaFieldTestImpl, UiWidgetCollapsableBorderPanelGwt, UiWidgetCollapsableSectionGwt, UiWidgetCollapsableSectionTestImpl, UiWidgetColorFieldGwt, UiWidgetColorFieldTestImpl, UiWidgetComboboxFieldGwt, UiWidgetComboboxFieldTestImpl, UiWidgetCustomAbstractDialogWindow, UiWidgetCustomAbstractWindow, UiWidgetCustomComposite, UiWidgetCustomCompositeNoValue, UiWidgetCustomDynamicComposite, UiWidgetCustomEditor, UiWidgetCustomField, UiWidgetCustomFieldAtomic, UiWidgetCustomFieldComposite, UiWidgetCustomFormEditor, UiWidgetCustomGridPanel, 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 UiWidgetAbstractComposite
extends UiWidget

This is the abstract interface for an UiWidget that is a composite. Composite means that is may have children.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields inherited from interface net.sf.mmm.client.ui.api.widget.UiWidget

STYLE_HEADER

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
UiWidget	getChild(int index) This method gets the child at the given index.
UiWidget	getChild(String childId) This method gets the child with the given id.
int	getChildCount() This method gets the number of children in this composite.
int	getChildIndex(UiWidget child) This method determines the index of the given child in the list of children of this composite.

Methods inherited from interface net.sf.mmm.client.ui.api.widget.UiWidget

getContext, getParent, 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

Method Detail

getChildIndex

int getChildIndex(UiWidget child)

This method determines the index of the given child in the list of children of this composite.
The signature is by intention not using the generic to support delegation without suffering by the java compiler.

Parameters:

child - is the potential child.

Returns:

the index of the given child or -1 if it is NOT a child of this composite.

See Also:

List.indexOf(Object)

getChild

UiWidget getChild(int index)
           throws IndexOutOfBoundsException

This method gets the child at the given index.

Parameters:

index - is the index of the requested child. Has to be in the range from 0 to getChildCount() - 1.

Returns:

the requested child.

Throws:

IndexOutOfBoundsException - if the given index is out of bounds.

See Also:

List.get(int)

getChild

UiWidget getChild(String childId)

This method gets the child with the given id.

Parameters:

childId - is the ID of the requested child.

Returns:

the child with the given id or null if no such child exists.

getChildCount

int getChildCount()

This method gets the number of children in this composite.

Returns:

the child count.