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

Class AbstractUiWidgetTree<ADAPTER extends UiWidgetAdapterTree<NODE>,NODE>

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

net.sf.mmm.client.ui.base.widget.AbstractUiWidgetActive<ADAPTER,VALUE>

net.sf.mmm.client.ui.base.widget.complex.AbstractUiWidgetAbstractDataSet<ADAPTER,NODE,NODE,NODE>

net.sf.mmm.client.ui.base.widget.complex.AbstractUiWidgetTree<ADAPTER,NODE>

Type Parameters:

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

NODE - is the generic type of the tree-nodes. E.g. TreeNode.

All Implemented Interfaces:

AttributeReadAccessKey, AttributeReadAriaRole, AttributeReadEditable, AttributeReadEnabled, AttributeReadFocused, AttributeReadHtmlId, AttributeReadMode, AttributeReadModeFixed, AttributeReadModified, AttributeReadPrimaryStyle, AttributeReadSelectedValue<NODE>, AttributeReadSelectionMode, AttributeReadStringTitle, AttributeReadStyles, AttributeReadStylesAdvanced, AttributeReadSummary, AttributeReadTitleVisible, AttributeReadTooltip, AttributeReadValueAdvanced<NODE>, AttributeReadVisible, AttributeReadVisibleRecursive, AttributeWriteAccessKey, AttributeWriteAriaRole, AttributeWriteEditable, AttributeWriteEnabled, AttributeWriteFocused, AttributeWriteHtmlId, AttributeWriteMode, AttributeWriteModeFixed, AttributeWriteModified, AttributeWriteOnlyFocused, AttributeWritePrimaryStyle, AttributeWriteSelectedValue<NODE>, AttributeWriteSelectionMode, AttributeWriteStringTitle, AttributeWriteStyles, AttributeWriteStylesAdvanced, AttributeWriteSummary, AttributeWriteTitleVisible, AttributeWriteTooltip, AttributeWriteValueAdvanced<NODE>, AttributeWriteVisible, AttributeWriteVisibleAdvanced, UiFeature, UiFeatureEvent, UiFeatureFocus, UiFeatureMessages, UiFeatureMode, UiFeatureSelectedValue<NODE>, UiFeatureValidation<NODE>, UiFeatureValue<NODE>, UiFeatureValueAndValidation<NODE>, UiWidgetAbstractDataSet<NODE>, UiWidgetAbstractTree<NODE>, UiWidgetTree<NODE>, UiWidget, UiWidgetAbstractComposite, UiWidgetAbstractWithValue<NODE>, UiWidgetActive, UiWidgetNative, UiWidgetRegular, UiWidgetWithSelectedValue<NODE>, UiWidgetWithValue<NODE>, AttributeReadDisposed, AttributeReadId<String>, AttributeReadTitle<String>, AttributeReadValue<NODE>, AttributeWriteDisposed, AttributeWriteId<String>, AttributeWriteTitle<String>, AttributeWriteValue<NODE>, Accessibility, AbstractValidatableObject, HasValueValidators<NODE>, ValidatableObject<NODE>

Direct Known Subclasses:

UiWidgetTreeGwt, UiWidgetTreeTestImpl

public abstract class AbstractUiWidgetTree<ADAPTER extends UiWidgetAdapterTree<NODE>,NODE>
extends AbstractUiWidgetAbstractDataSet<ADAPTER,NODE,NODE,NODE>
implements UiWidgetTree<NODE>

This is the abstract base implementation of UiWidgetAbstractListTable.

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

Nested classes/interfaces inherited from interface net.sf.mmm.client.ui.api.widget.complex.UiWidgetAbstractTree

UiWidgetAbstractTree.UiTreeModel<NODE>, UiWidgetAbstractTree.UiTreeModelMutable<NODE>, UiWidgetAbstractTree.UiTreeNodeRenderer<NODE,WIDGET extends UiWidgetRegular>, UiWidgetAbstractTree.UiTreeNodeRendererDefault<NODE>, UiWidgetAbstractTree.UiWidgetTreeNode<NODE>

Field Summary

Fields

Modifier and Type	Field and Description
private static UiWidgetAbstractTree.UiTreeNodeRenderer<Object,UiWidgetLabel>	DEFAULT_RENDERER The default UiWidgetAbstractTree.UiTreeNodeRenderer.
private String	title
private UiWidgetAbstractTree.UiTreeModel<NODE>	treeModel
private UiWidgetAbstractTree.UiTreeNodeRenderer<NODE,?>	treeNodeRenderer

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

STYLE_TREE

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

PROPERTY_SUMMARY

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

PROPERTY_TITLE

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

ACCESS_KEY_NONE, HTML_ATTRIBUTE_ACCESS_KEY

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	collapseAllNodes() This method collapses all nodes.
protected void	doSetSelected(NODE container, boolean selected) Internal method to set the selection of the item in the given container.
protected void	doSetValue(NODE value, boolean forUser) This method is called from the data-binding triggered by API methods such as AbstractUiWidget.setValue(Object, boolean).
void	expandNodes() This method expands all nodes that have already been loaded.
Collection<NODE>	getAllAvailableItems() Internal method to get the Collection with all items (currently) available in this widget.
protected NODE	getItem(NODE container) This method gets the item in the given container.
protected NODE	getItemContainer(NODE item) Gets the existing container for the given item.
protected NODE	getLastAvailableItem()
String	getTitle() This method gets the title of this object.
UiWidgetAbstractTree.UiTreeModel<NODE>	getTreeModel() This method gets the UiWidgetAbstractTree.UiTreeModel adapting from <NODE> to this tree-widget.
UiWidgetAbstractTree.UiWidgetTreeNode<NODE>	getTreeNodeWidget(NODE node) This method gets the UiWidgetAbstractTree.UiWidgetTreeNode for the given <NODE>.
protected void	initializeWidgetAdapter(ADAPTER adapter) This method is called from AbstractUiWidgetNative.getWidgetAdapter() to initialize the UiWidgetAdapter.
void	setTitle(String title) This method sets the title of this object.
void	setTreeModel(UiWidgetAbstractTree.UiTreeModel<NODE> model) This method sets the UiWidgetAbstractTree.UiTreeModel adapting from <NODE> to this tree-widget.
void	setTreeNodeRenderer(UiWidgetAbstractTree.UiTreeNodeRenderer<NODE,?> renderer) This method sets the UiWidgetAbstractTree.UiTreeNodeRenderer used to render the widgets for an individual <NODE>.

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

addSelectionHandler, asFeatureSelectedValue, clearSelection, doGetSelected, getFirstAvailableItem, getSelectedValue, getSelectedValues, getSelectedValuesInternal, getSelectionCount, getSelectionMode, getSummary, hasSelectedValue, isEditable, isSelected, isTitleVisible, onItemSelection, removeSelectionHandler, setEditable, setSelectedValue, setSelectedValues, setSelectedValues, setSelection, setSelection, setSelectionMode, setSummary, setTitleVisible

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

addFocusHandler, getAccessKey, isFocused, onAccessKeyPressed, removeFocusHandler, setAccessKey, setFocused, setFocused

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

addChangeHandler, addStyle, clearMessages, clearValidity, createSize, createUniqueId, createWidgetAdapter, dispose, doGetValue, doSetMode, doValidate, getAriaRole, getAriaRoleFixedType, getChild, getChild, getChildCount, getChildIndex, getId, getIndexOfStyle, getMode, getModeFixed, getParent, getPrimaryStyle, getSize, getStyles, getTooltip, getVisibleFlag, getWidgetAdapter, getWidgetAdapter, hasStyle, hasWidgetAdapter, isDisposed, isEnabled, isModifiedRecursive, isVisible, isVisibleRecursive, removeChangeHandler, removeFromParent, removeStyle, setAriaRole, setEnabled, 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, 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.UiWidgetWithSelectedValue

asFeatureSelectedValue

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.client.ui.api.feature.UiFeatureSelectedValue

addSelectionHandler, isSelected, removeSelectionHandler, setSelection

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

setSelectedValue, setSelectedValues

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

getSelectedValue, getSelectedValues, getSelectionCount, hasSelectedValue

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

setSelectionMode

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

getSelectionMode

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

setSummary

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

getSummary

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

setTitleVisible

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

isTitleVisible

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

setEditable

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

isEditable

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

getValue

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

getValueAndValidate, getValueDirect

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

addChangeHandler, removeChangeHandler

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

resetValue, setValue, setValue, setValueForUser

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

getOriginalValue, getValueOrException

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

addValidatorMandatory, isMandatory

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

addValidator, removeValidator

Field Detail

DEFAULT_RENDERER

private static final UiWidgetAbstractTree.UiTreeNodeRenderer<Object,UiWidgetLabel> DEFAULT_RENDERER

The default UiWidgetAbstractTree.UiTreeNodeRenderer.

treeModel

private UiWidgetAbstractTree.UiTreeModel<NODE> treeModel

See Also:

getTreeModel()

treeNodeRenderer

private UiWidgetAbstractTree.UiTreeNodeRenderer<NODE,?> treeNodeRenderer

See Also:

setTreeNodeRenderer(net.sf.mmm.client.ui.api.widget.complex.UiWidgetAbstractTree.UiTreeNodeRenderer)

title

private String title

See Also:

getTitle()

Constructor Detail

AbstractUiWidgetTree

public AbstractUiWidgetTree(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 AbstractUiWidgetAbstractDataSet<ADAPTER extends UiWidgetAdapterTree<NODE>,NODE,NODE,NODE>

Parameters:

adapter - is the UiWidgetAdapter to initialize.

setTreeModel

public void setTreeModel(UiWidgetAbstractTree.UiTreeModel<NODE> model)

This method sets the UiWidgetAbstractTree.UiTreeModel adapting from <NODE> to this tree-widget.

Specified by:

setTreeModel in interface UiWidgetAbstractTree<NODE>

Parameters:

model - is the UiWidgetAbstractTree.UiTreeModel to set.

setTreeNodeRenderer

public void setTreeNodeRenderer(UiWidgetAbstractTree.UiTreeNodeRenderer<NODE,?> renderer)

This method sets the UiWidgetAbstractTree.UiTreeNodeRenderer used to render the widgets for an individual <NODE>.

Specified by:

setTreeNodeRenderer in interface UiWidgetAbstractTree<NODE>

Parameters:

renderer - is the UiWidgetAbstractTree.UiTreeNodeRenderer.

getTreeNodeWidget

public UiWidgetAbstractTree.UiWidgetTreeNode<NODE> getTreeNodeWidget(NODE node)

This method gets the UiWidgetAbstractTree.UiWidgetTreeNode for the given <NODE>. It contains a node widget that was created by the UiWidgetAbstractTree.UiTreeNodeRenderer. Further you can collapse or expand the node.

Specified by:

getTreeNodeWidget in interface UiWidgetAbstractTree<NODE>

Parameters:

node - is the <NODE>.

Returns:

the according UiWidgetAbstractTree.UiWidgetTreeNode or null if the given node is NOT in this tree.

See Also:

UiWidgetAbstractTree.setTreeNodeRenderer(UiTreeNodeRenderer)

collapseAllNodes

public void collapseAllNodes()

This method collapses all nodes.

Specified by:

collapseAllNodes in interface UiWidgetAbstractTree<NODE>

expandNodes

public void expandNodes()

This method expands all nodes that have already been loaded.

Specified by:

expandNodes in interface UiWidgetAbstractTree<NODE>

getTreeModel

public UiWidgetAbstractTree.UiTreeModel<NODE> getTreeModel()

Description copied from interface: UiWidgetAbstractTree

This method gets the UiWidgetAbstractTree.UiTreeModel adapting from <NODE> to this tree-widget.

Specified by:

getTreeModel in interface UiWidgetAbstractTree<NODE>

Returns:

the treeModel

getTitle

public String getTitle()

This method gets the title of this object. The detailed meaning of the title depends on the type of object. E.g. a window will have the title in the top-level bar. The title may also be called caption (technically in HTML).

Specified by:

getTitle in interface AttributeReadStringTitle

Specified by:

getTitle in interface UiWidgetAbstractDataSet<NODE>

Specified by:

getTitle in interface AttributeReadTitle<String>

Overrides:

getTitle in class AbstractUiWidgetAbstractDataSet<ADAPTER extends UiWidgetAdapterTree<NODE>,NODE,NODE,NODE>

Returns:

the title.

setTitle

public void setTitle(String title)

This method sets the title of this object.

Specified by:

setTitle in interface AttributeWriteStringTitle

Specified by:

setTitle in interface UiWidgetAbstractDataSet<NODE>

Specified by:

setTitle in interface AttributeWriteTitle<String>

Overrides:

setTitle in class AbstractUiWidgetAbstractDataSet<ADAPTER extends UiWidgetAdapterTree<NODE>,NODE,NODE,NODE>

Parameters:

title - is the new title.

See Also:

AttributeWriteTitleVisible.setTitleVisible(boolean)

doSetValue

protected void doSetValue(NODE value,
                          boolean forUser)

This method is called from the data-binding triggered by API methods such as AbstractUiWidget.setValue(Object, boolean). In many cases the data-binding already performs the required work to do. However, here is the place to implemented the custom logic to get the value from the actual widget. For details see AbstractUiWidget.doGetValue(Object, ValidationState).

Overrides:

doSetValue in class AbstractUiWidgetNative<ADAPTER extends UiWidgetAdapterTree<NODE>,NODE>

Parameters:

value - is the value to set. Typically a composite object (e.g. java bean) so its attributes are set to fields (see UiWidgetField).

forUser - true if called from AbstractUiFeatureValueAndValidation.setValueForUser(Object), false if set from AbstractUiFeatureValueAndValidation.setValue(Object).

See Also:

AbstractUiWidget.doGetValue(Object, ValidationState)

doSetSelected

protected void doSetSelected(NODE container,
                             boolean selected)

Internal method to set the selection of the item in the given container. Shall not do anything else (e.g. firing event).

Specified by:

doSetSelected in class AbstractUiWidgetAbstractDataSet<ADAPTER extends UiWidgetAdapterTree<NODE>,NODE,NODE,NODE>

Parameters:

container - is the container with the item to mark.

selected - - true to select, false to deselect.

getAllAvailableItems

public Collection<NODE> getAllAvailableItems()

Internal method to get the Collection with all items (currently) available in this widget. In case of lazy loading only those that have already been loaded.
ATTENTION:
The Collection must NOT be modified if retrieved via this method. Implementations will provide separate addItem and removeItem methods.

Specified by:

getAllAvailableItems in class AbstractUiWidgetAbstractDataSet<ADAPTER extends UiWidgetAdapterTree<NODE>,NODE,NODE,NODE>

Returns:

the Collection with all items (currently) available in this widget. In case of lazy loading only those that have already been loaded.

getLastAvailableItem

protected NODE getLastAvailableItem()

Specified by:

getLastAvailableItem in class AbstractUiWidgetAbstractDataSet<ADAPTER extends UiWidgetAdapterTree<NODE>,NODE,NODE,NODE>

Returns:

the last of the available items.

getItemContainer

protected NODE getItemContainer(NODE item)

Gets the existing container for the given item. This method has to be very efficient. You should use a Map for this purpose.

Specified by:

getItemContainer in class AbstractUiWidgetAbstractDataSet<ADAPTER extends UiWidgetAdapterTree<NODE>,NODE,NODE,NODE>

Parameters:

item - is the item to lookup.

Returns:

the container for the given item or null if no such container exists.

getItem

protected NODE getItem(NODE container)

This method gets the item in the given container.

Specified by:

getItem in class AbstractUiWidgetAbstractDataSet<ADAPTER extends UiWidgetAdapterTree<NODE>,NODE,NODE,NODE>

Parameters:

container - is the container of the requested item.

Returns:

the unwrapped item.