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

Interface UiWidgetTabPanel

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, UiWidgetAbstractComposite, UiWidgetComposite<UiWidgetTab>, UiWidgetDynamicComposite<UiWidgetTab>, UiWidgetDynamicPanel<UiWidgetTab>, UiWidgetMultiComposite<UiWidgetTab>, UiWidgetNative, UiWidgetPanel<UiWidgetTab>, UiWidgetRegular, UiWidgetRegularComposite<UiWidgetTab>, UiWidgetSwitchComposite<UiWidgetTab>

All Known Implementing Classes:

AbstractUiWidgetTabPanel, UiWidgetTabPanelGwt, UiWidgetTabPanelTestImpl

public interface UiWidgetTabPanel
extends UiWidgetDynamicPanel<UiWidgetTab>, UiWidgetSwitchComposite<UiWidgetTab>, UiWidgetNative

This is the interface for a panel widget that represents a tab panel. It contains a number of children but only shows one of them at a time. On the top it shows a tab header with the labels of its children. The user can click on one of these tabs in order to see the actual content of the according tab.
This design might look a little complicated but gives a lot more flexibility for setting and changing attributes of the tab. For convenience usage there is also addChild(UiWidgetRegular, String).

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Field Summary

Fields

Modifier and Type	Field and Description
static String	STYLE_PRIMARY The default primary style of this widget.

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
UiWidgetTab	addChild(UiWidgetRegular child, String label) This method adds the given UiWidgetRegular as new tab on the right of all existing tabs.

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

showChild, showChild, showChild

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

addChild, addChild

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

removeChild, removeChild

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

getChild, getChild

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

getChildCount, getChildIndex

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

Field Detail

STYLE_PRIMARY

static final String STYLE_PRIMARY

The default primary style of this widget.

See Also:

Constant Field Values

Method Detail

addChild

UiWidgetTab addChild(UiWidgetRegular child,
                     String label)

This method adds the given UiWidgetRegular as new tab on the right of all existing tabs. This is a convenience method for the following code:

 UiWidgetTab tab = widgetFactory.create(UiWidgetTab.class);
 tab.setTitle(title);
 tab.setChild(child);
 tabPanel.addChild(tab);
 

Parameters:

child - is the child widget to add. The given component instance must be created by the same factory.

label - is the label that will be displayed to identify the tab.

Returns:

the UiWidgetTab for this tab. It allows to change the title, set tooltip or image (icon), etc.