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

Class AbstractUiWidgetMenu<ADAPTER extends UiWidgetAdapterMenu>

java.lang.Object

net.sf.mmm.client.ui.base.feature.AbstractUiFeatureValueAndValidation<VALUE>

net.sf.mmm.client.ui.base.widget.AbstractUiWidget<VALUE>

net.sf.mmm.client.ui.base.widget.AbstractUiWidgetNative<ADAPTER,Void>

net.sf.mmm.client.ui.base.widget.AbstractUiWidgetComposite<ADAPTER,CHILD>

net.sf.mmm.client.ui.base.widget.AbstractUiWidgetDynamicComposite<ADAPTER,UiWidgetMenuItem>

net.sf.mmm.client.ui.base.widget.menu.AbstractUiWidgetMenu<ADAPTER>

Type Parameters:

ADAPTER - is the generic type of AbstractUiWidgetNative.getWidgetAdapter().

All Implemented Interfaces:

AttributeReadAriaRole, AttributeReadEnabled, AttributeReadHtmlId, AttributeReadLabel, AttributeReadMode, AttributeReadModeFixed, AttributeReadModified, AttributeReadPrimaryStyle, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadTooltip, AttributeReadValueAdvanced<Void>, AttributeReadVisible, AttributeReadVisibleRecursive, AttributeWriteAriaRole, AttributeWriteEnabled, AttributeWriteHtmlId, AttributeWriteLabel, AttributeWriteMode, AttributeWriteModeFixed, AttributeWriteModified, AttributeWriteOnlyFocused, AttributeWritePrimaryStyle, AttributeWriteStyles, AttributeWriteStylesAdvanced, AttributeWriteTooltip, AttributeWriteValueAdvanced<Void>, AttributeWriteVisible, AttributeWriteVisibleAdvanced, UiFeature, UiFeatureEvent, UiFeatureMessages, UiFeatureMode, UiFeatureValidation<Void>, UiFeatureValue<Void>, UiFeatureValueAndValidation<Void>, UiWidgetMenu, UiWidgetMenuItem, UiWidget, UiWidgetAbstractComposite, UiWidgetAbstractWithValue<Void>, UiWidgetComposite<UiWidgetMenuItem>, UiWidgetDynamicComposite<UiWidgetMenuItem>, UiWidgetMultiComposite<UiWidgetMenuItem>, UiWidgetNative, AttributeReadDisposed, AttributeReadId<String>, AttributeReadValue<Void>, AttributeWriteDisposed, AttributeWriteId<String>, AttributeWriteValue<Void>, Accessibility, AbstractValidatableObject, HasValueValidators<Void>, ValidatableObject<Void>

Direct Known Subclasses:

UiWidgetMenuGwt, UiWidgetMenuTestImpl

public abstract class AbstractUiWidgetMenu<ADAPTER extends UiWidgetAdapterMenu>
extends AbstractUiWidgetDynamicComposite<ADAPTER,UiWidgetMenuItem>
implements UiWidgetMenu

This is the abstract base implementation of UiWidgetMenu.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.mmm.client.ui.base.widget.AbstractUiWidgetNative

AbstractUiWidgetNative.SizeImpl

Nested classes/interfaces inherited from class net.sf.mmm.client.ui.base.widget.AbstractUiWidget

AbstractUiWidget.AccessHelper, AbstractUiWidget.EventSender, AbstractUiWidget.HandlerContainer

Field Summary

Fields

Modifier and Type	Field and Description
private String	label

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

Fields inherited from interface net.sf.mmm.client.ui.api.attribute.AttributeReadLabel

PROPERTY_LABEL

Constructor Summary

Constructors

Constructor and Description
AbstractUiWidgetMenu(UiContext context, ADAPTER widgetAdapter) The constructor.

Method Summary

Modifier and Type	Method and Description
void	addSeparator() This method adds a separator to this menu.
UiWidgetMenu	addSubmenu(String submenuLabel) This method adds a sub-menu to this menu.
String	getLabel() This method gets the label of this object.
String	getSource()
protected void	initializeWidgetAdapter(ADAPTER adapter) This method is called from AbstractUiWidgetNative.getWidgetAdapter() to initialize the UiWidgetAdapter.
void	setLabel(String label) This method sets the label of this object.

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

addChild, addChild, doAddChild, getChild, getChildCount, getChildIndex, removeChild, removeChild

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

getChild

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

addChangeHandler, addStyle, clearMessages, clearValidity, createSize, createUniqueId, createWidgetAdapter, dispose, doGetValue, doSetMode, doSetValue, doValidate, getAriaRole, getAriaRoleFixedType, getId, getIndexOfStyle, getMode, getModeFixed, getParent, getPrimaryStyle, getSize, getStyles, getTooltip, getVisibleFlag, getWidgetAdapter, getWidgetAdapter, hasStyle, hasWidgetAdapter, isDisposed, isEnabled, isModifiedRecursive, isVisible, isVisibleRecursive, removeChangeHandler, removeFromParent, removeStyle, setAriaRole, setEnabled, setFocused, setId, setIdPrefix, setMode, setMode, setModeFixed, setParent, setPrimaryStyle, setStyles, setTooltip, setVisible, setVisible, toString, visibilityChanged

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

addEventHandler, addValidator, clearMessagesLocal, clearValidationFailure, convertValueToString, fireEvent, fireValueChange, getBasicUtil, getContext, getDataBinding, getDataBinding, getDataBindingForWidget, getEventSender, getFactory, getLogger, getObserverSource, getOriginalValue, getRecentValue, getValueClass, getValueDirect, getValueOrException, getWidgetAdapter, hasEventSender, isMandatory, isModified, removeEventHandler, removeFromParent, removeValidator, setMandatory, setModified, setParent, setValue

Methods inherited from class net.sf.mmm.client.ui.base.feature.AbstractUiFeatureValueAndValidation

addValidatorMandatory, createValidationFailure, getValue, getValueAndValidate, handleGetValueError, resetValue, setValue, setValueForUser, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

addChild

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

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

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

resetValue, setValue, setValueForUser

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

getValue

Field Detail

label

private String label

See Also:

getLabel()

Constructor Detail

AbstractUiWidgetMenu

public AbstractUiWidgetMenu(UiContext context,
                            ADAPTER widgetAdapter)

The constructor.

Parameters:

context - is the context.

widgetAdapter - is the widget adapter. Typically null for lazy initialization.

Method Detail

initializeWidgetAdapter

protected void initializeWidgetAdapter(ADAPTER adapter)

This method is called from AbstractUiWidgetNative.getWidgetAdapter() to initialize the UiWidgetAdapter. All attributes of this widget need to be set in the UiWidgetAdapter.

Overrides:

initializeWidgetAdapter in class AbstractUiWidgetDynamicComposite<ADAPTER extends UiWidgetAdapterMenu,UiWidgetMenuItem>

Parameters:

adapter - is the UiWidgetAdapter to initialize.

getLabel

public String getLabel()

This method gets the label of this object. A label is some text that is permanently shown to the user in the UI in order to describe the meaning of the object and in particular its value. For elements that allow to display or edit a value the label is typically shown beside the edit/display widget. For action elements such as buttons or links the label is the actual text (lettering).

Specified by:

getLabel in interface AttributeReadLabel

Returns:

the label text. Will be the empty string if no label has been set.

setLabel

public void setLabel(String label)

This method sets the label of this object.

Specified by:

setLabel in interface AttributeWriteLabel

Parameters:

label - is the new label to set.

addSeparator

public void addSeparator()

This method adds a separator to this menu.

Specified by:

addSeparator in interface UiWidgetMenu

addSubmenu

public UiWidgetMenu addSubmenu(String submenuLabel)

This method adds a sub-menu to this menu.

Specified by:

addSubmenu in interface UiWidgetMenu

Parameters:

submenuLabel - is the label of the sub-menu.

Returns:

the new sub-menu.

getSource

public String getSource()

Overrides:

getSource in class AbstractUiWidget<Void>

Returns:

a String representation of this object that qualifies as source description that might be displayed to end-users (unlike AbstractUiWidget.toString() what is for debugging only).