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

Class AbstractUiWidgetDynamicComposite<ADAPTER extends UiWidgetAdapterDynamicComposite<CHILD>,CHILD extends UiWidget>

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

Type Parameters:

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

CHILD - is the generic type of the children.

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractUiWidgetAbstractWindow, AbstractUiWidgetDynamicPanel, AbstractUiWidgetMenu, AbstractUiWidgetMenuBar, AbstractUiWidgetSwitchComposite

public abstract class AbstractUiWidgetDynamicComposite<ADAPTER extends UiWidgetAdapterDynamicComposite<CHILD>,CHILD extends UiWidget>
extends AbstractUiWidgetComposite<ADAPTER,CHILD>
implements UiWidgetDynamicComposite<CHILD>

This is the abstract base implementation of UiWidgetDynamicComposite.

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 List<CHILD>	children

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addChild(CHILD child) This method adds the given child to the end of the child-list.
void	addChild(CHILD child, int index) This method adds or better inserts the given child at the given index.
protected void	doAddChild(CHILD child, int index) This method is called from addChild(UiWidget) or addChild(UiWidget, int).
CHILD	getChild(int index) This method gets the child at the given index.
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.
protected void	initializeWidgetAdapter(ADAPTER adapter) This method is called from AbstractUiWidgetNative.getWidgetAdapter() to initialize the UiWidgetAdapter.
boolean	removeChild(CHILD child) This method removes the given child from this panel.
CHILD	removeChild(int index) This method removes the child at the given index from this panel.

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, setModeRecursive, setParent, setPrimaryStyle, setStyles, setTooltip, setVisible, setVisible, toString, validateRecursive, 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, getSource, 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.UiWidgetComposite

getChild

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

children

private final List<CHILD extends UiWidget> children

See Also:

getChild(int)

Constructor Detail

AbstractUiWidgetDynamicComposite

public AbstractUiWidgetDynamicComposite(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 AbstractUiWidgetNative<ADAPTER extends UiWidgetAdapterDynamicComposite<CHILD>,Void>

Parameters:

adapter - is the UiWidgetAdapter to initialize.

removeChild

public final boolean removeChild(CHILD child)

This method removes the given child from this panel.

Specified by:

removeChild in interface UiWidgetMultiComposite<CHILD extends UiWidget>

Parameters:

child - is the UiWidget to remove from this panel.

Returns:

true if the given child has been removed successfully, false otherwise (it has NOT been previously added).

See Also:

List.remove(Object)

removeChild

public final CHILD removeChild(int index)

This method removes the child at the given index from this panel.

Specified by:

removeChild in interface UiWidgetMultiComposite<CHILD extends UiWidget>

Parameters:

index - is the index of the child to remove. It has to be in the range from 0 to UiWidgetAbstractComposite.getChildCount() - 1.

Returns:

the removed child that has previously been at the given index.

See Also:

List.remove(int)

getChildIndex

public final 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.

Specified by:

getChildIndex in interface UiWidgetAbstractComposite

Specified by:

getChildIndex in class AbstractUiWidgetComposite<ADAPTER extends UiWidgetAdapterDynamicComposite<CHILD>,CHILD extends UiWidget>

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

public final CHILD getChild(int index)

This method gets the child at the given index.

Specified by:

getChild in interface UiWidgetAbstractComposite

Specified by:

getChild in interface UiWidgetComposite<CHILD extends UiWidget>

Specified by:

getChild in class AbstractUiWidgetComposite<ADAPTER extends UiWidgetAdapterDynamicComposite<CHILD>,CHILD extends UiWidget>

Parameters:

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

Returns:

the requested child.

See Also:

List.get(int)

getChildCount

public final int getChildCount()

This method gets the number of children in this composite.

Specified by:

getChildCount in interface UiWidgetAbstractComposite

Overrides:

getChildCount in class AbstractUiWidgetNative<ADAPTER extends UiWidgetAdapterDynamicComposite<CHILD>,Void>

Returns:

the child count.

addChild

public void addChild(CHILD child)

This method adds the given child to the end of the child-list. For vertical layouts this will be the bottom and for horizontal layouts this will be the right.

Specified by:

addChild in interface UiWidgetDynamicComposite<CHILD extends UiWidget>

Parameters:

child - is the UiWidget to add as child of this composite.

See Also:

List.add(Object)

addChild

public void addChild(CHILD child,
                     int index)

This method adds or better inserts the given child at the given index.

Specified by:

addChild in interface UiWidgetDynamicComposite<CHILD extends UiWidget>

Parameters:

child - is the UiWidget to add as child of this panel.

index - is the index of the new child. It has to be in the range from 0 to UiWidgetAbstractComposite.getChildCount().

See Also:

UiWidgetDynamicComposite.addChild(UiWidget), List.add(int, Object)

doAddChild

protected void doAddChild(CHILD child,
                          int index)

This method is called from addChild(UiWidget) or addChild(UiWidget, int). It can be overridden to implement custom logic (e.g. attaching the child to the UiWidgetAdapter).

Parameters:

child - is the new child to add or insert.

index - -1 to add the child at the end, otherwise the index where to insert the child.