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

Interface UiWidgetAbstractTree<NODE>

Type Parameters:

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

All Superinterfaces:

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

All Known Subinterfaces:

UiWidgetTree<NODE>, UiWidgetTreeTable<NODE>

All Known Implementing Classes:

AbstractUiWidgetTree, UiWidgetTreeGwt, UiWidgetTreeTestImpl

public interface UiWidgetAbstractTree<NODE>
extends UiWidgetAbstractDataSet<NODE>, UiWidgetWithValue<NODE>

This is the interface for a data set widget that represents a tree widget. Such widget represents a tree-structure showing tree-nodes that can be collapsed and expanded. It has the following features:

• Configured via tree model

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	UiWidgetAbstractTree.UiTreeModel<NODE> This is the interface for the model (adapter) for a UiWidgetTree.
static interface	UiWidgetAbstractTree.UiTreeModelMutable<NODE> Extends UiWidgetAbstractTree.UiTreeModel with features for editing the tree structure.
static interface	UiWidgetAbstractTree.UiTreeNodeRenderer<NODE,WIDGET extends UiWidgetRegular> The renderer responsible to create widgets and assign a <NODE> to them.
static class	UiWidgetAbstractTree.UiTreeNodeRendererDefault<NODE> This is the default implementation of UiWidgetAbstractTree.UiTreeNodeRenderer.
static interface	UiWidgetAbstractTree.UiWidgetTreeNode<NODE> This is the interface for the main widget representing a node of the tree.

Field Summary

Fields

Modifier and Type	Field and Description
static String	STYLE_TREE The style of this tree 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

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

Method Summary

Modifier and Type	Method and Description
void	collapseAllNodes() This method collapses all nodes.
void	expandNodes() This method expands all nodes that have already been loaded.
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>.
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 interface net.sf.mmm.client.ui.api.widget.complex.UiWidgetAbstractDataSet

getTitle, setTitle

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

STYLE_TREE

static final String STYLE_TREE

The style of this tree widget.

See Also:

Constant Field Values

Method Detail

getTreeModel

UiWidgetAbstractTree.UiTreeModel<NODE> getTreeModel()

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

Returns:

the UiWidgetAbstractTree.UiTreeModel. May be null if NOT set.

setTreeModel

void setTreeModel(UiWidgetAbstractTree.UiTreeModel<NODE> model)

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

Parameters:

model - is the UiWidgetAbstractTree.UiTreeModel to set.

setTreeNodeRenderer

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

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

Parameters:

renderer - is the UiWidgetAbstractTree.UiTreeNodeRenderer.

getTreeNodeWidget

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.

Parameters:

node - is the <NODE>.

Returns:

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

See Also:

setTreeNodeRenderer(UiTreeNodeRenderer)

collapseAllNodes

void collapseAllNodes()

This method collapses all nodes.

expandNodes

void expandNodes()

This method expands all nodes that have already been loaded.