net.sf.mmm.client.ui.base.model

Class UiTreeNodeModel<VALUE>

java.lang.Object

net.sf.mmm.client.ui.base.model.UiTreeNodeModel<VALUE>

Type Parameters:

VALUE - is the generic type of the value contained in each node.

All Implemented Interfaces:

UiWidgetAbstractTree.UiTreeModel<TreeNodeSimple<VALUE>>, UiWidgetAbstractTree.UiTreeModelMutable<TreeNodeSimple<VALUE>>

public class UiTreeNodeModel<VALUE>
extends Object
implements UiWidgetAbstractTree.UiTreeModelMutable<TreeNodeSimple<VALUE>>

This is a simple implementation of mutable tree model.

Since:

1.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

Constructor Summary

Constructors

Constructor and Description
UiTreeNodeModel()

Method Summary

Modifier and Type	Method and Description
void	addChild(TreeNodeSimple<VALUE> parent, TreeNodeSimple<VALUE> child) Convenience method variant of UiWidgetAbstractTree.UiTreeModelMutable.addChild(Object, Object, int) to add a child at the end.
void	addChild(TreeNodeSimple<VALUE> parent, TreeNodeSimple<VALUE> child, int index) Adds the given child <NODE> to the given parent at the specified index.
TreeNodeSimple<VALUE>	addChild(TreeNodeSimple<VALUE> parent, VALUE childValue) Creates a new TreeNodeSimple for the given childValue and adds it to the given parent.
TreeNodeSimple<VALUE>	addChild(TreeNodeSimple<VALUE> parent, VALUE childValue, int index) Creates a new TreeNodeSimple for the given childValue and adds it to the given parent.
List<TreeNodeSimple<VALUE>>	getChildren(TreeNodeSimple<VALUE> node) This method gets the children of the given tree-node.
void	getChildrenAsync(TreeNodeSimple<VALUE> node, Consumer<List<TreeNodeSimple<VALUE>>> callback) This method gets the children of the given tree-node asynchronously.
void	removeChilden(TreeNodeSimple<VALUE> parent, TreeNodeSimple<VALUE>... children) Removes the given children from the parent.

Methods inherited from class java.lang.Object

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

Constructor Detail

UiTreeNodeModel

public UiTreeNodeModel()

Method Detail

getChildren

public List<TreeNodeSimple<VALUE>> getChildren(TreeNodeSimple<VALUE> node)

This method gets the children of the given tree-node.

Specified by:

getChildren in interface UiWidgetAbstractTree.UiTreeModel<TreeNodeSimple<VALUE>>

Parameters:

node - the tree-node for which the children are requested.

Returns:

the List of child-nodes or null if NOT available and asynchronous loading is required.

getChildrenAsync

public void getChildrenAsync(TreeNodeSimple<VALUE> node,
                             Consumer<List<TreeNodeSimple<VALUE>>> callback)

This method gets the children of the given tree-node asynchronously.

Specified by:

getChildrenAsync in interface UiWidgetAbstractTree.UiTreeModel<TreeNodeSimple<VALUE>>

Parameters:

node - the tree-node for which the children are requested.

callback - is the Consumer that will be called when the children are available. Maybe null if only loading shall be triggered.

addChild

public void addChild(TreeNodeSimple<VALUE> parent,
                     TreeNodeSimple<VALUE> child,
                     int index)

Adds the given child <NODE> to the given parent at the specified index.

Specified by:

addChild in interface UiWidgetAbstractTree.UiTreeModelMutable<TreeNodeSimple<VALUE>>

Parameters:

parent - is the parent <NODE> where to add the given child.

child - is the <NODE> to add to the children of parent. This method will remove the child from any previous parent. The instance of the child may later be modified. To prevent undesired modifications create a deep-copy of the node before calling this method.

index - is the index where to add the child.

addChild

public void addChild(TreeNodeSimple<VALUE> parent,
                     TreeNodeSimple<VALUE> child)

Convenience method variant of UiWidgetAbstractTree.UiTreeModelMutable.addChild(Object, Object, int) to add a child at the end.

Specified by:

addChild in interface UiWidgetAbstractTree.UiTreeModelMutable<TreeNodeSimple<VALUE>>

Parameters:

parent - is the parent <NODE> where to add the given child.

child - is the <NODE> to add to the children of parent.

See Also:

UiWidgetAbstractTree.UiTreeModelMutable.addChild(Object, Object, int)

addChild

public TreeNodeSimple<VALUE> addChild(TreeNodeSimple<VALUE> parent,
                                      VALUE childValue)

Creates a new TreeNodeSimple for the given childValue and adds it to the given parent.

Parameters:

parent - is the parent node.

childValue - is the value of the new child node.

Returns:

the new child node.

addChild

public TreeNodeSimple<VALUE> addChild(TreeNodeSimple<VALUE> parent,
                                      VALUE childValue,
                                      int index)

Creates a new TreeNodeSimple for the given childValue and adds it to the given parent.

Parameters:

parent - is the parent node.

childValue - is the value of the new child node.

index - is the index where to insert the new child.

Returns:

the new child node.

removeChilden

public void removeChilden(TreeNodeSimple<VALUE> parent,
                          TreeNodeSimple<VALUE>... children)

Removes the given children from the parent.

Specified by:

removeChilden in interface UiWidgetAbstractTree.UiTreeModelMutable<TreeNodeSimple<VALUE>>

Parameters:

parent - is the parent <NODE> where to remove the given children.

children - are the children to remove.