xdev.ui.tree

Class XdevTreeNode

java.lang.Object

javax.swing.tree.DefaultMutableTreeNode

xdev.ui.tree.XdevTreeNode

All Implemented Interfaces:

Serializable, Cloneable, MutableTreeNode, TreeNode, Copyable<XdevTreeNode>

public class XdevTreeNode
extends DefaultMutableTreeNode
implements Copyable<XdevTreeNode>

The standard tree node in XDEV. Based on DefaultMutableTreeNode.

The XdevTree provides methods to modify trees from a nodes perspective.

Since:

2.0

Author:

XDEV Software

See Also:

DefaultMutableTreeNode, Serialized Form

Field Summary

Fields inherited from class javax.swing.tree.DefaultMutableTreeNode

allowsChildren, children, EMPTY_ENUMERATION, parent, userObject

Constructor Summary

Constructors

Constructor and Description
XdevTreeNode(Object userObject) Creates a tree node with no parent, no children, but which allows children, and initializes it with the specified user object.
XdevTreeNode(Object userObject, String caption) Creates a tree node with no parent, no children, but which allows children, and initializes it with the specified user object.
XdevTreeNode(Object userObject, String caption, Icon icon) Creates a tree node with no parent, no children, but which allows children, and initializes it with the specified user object.

Method Summary

Modifier and Type	Method and Description
void	add(MutableTreeNode node)
XdevTreeNode	add(XdevTreeNode... nodes) Removes nodes from their parent and makes them a child of this node by adding it to the end of this node's child array.
XdevTreeNode	clone() Returns a field-for-field copy of this instance.
XdevTreeNode	cloneTree() Clones a XdevTreeNode and all its children (deep clone).
String	getCaption() Returns the caption of this XdevTreeNode.
TreeNode	getChildAt(int index)
<T extends TreeNode> List<T>	getChildren() Returns a XdevList containing the children of this XdevTreeNode.
Icon	getIcon() Returns the Icon of this XdevTreeNode.
DefaultTreeModel	getModel() Returns the TreeModel for this XdevTreeNode.
<T extends TreeNode> List<T>	getPathAsList() Returns the path from the root, to get to this node.
<T extends TreeNode> List<T>	getSubTree() Creates and returns an XdevList that traverses the subtree rooted at this node in preorder.
XdevTreeNode	getXdevParent() Returns this node's parent or null if this node has no parent.
void	insert(MutableTreeNode node, int index)
void	remove(int index)
void	remove(MutableTreeNode node)
void	removeAllChildren()
void	removeFromParent()
XdevTreeNode	removeNode(XdevTreeNode node) Removes node from this node's child array, giving it a null parent.
XdevTreeNode	removeNodeAt(int index) Removes the node at the specified index from this node's children and sets that node's parent to null.
XdevTreeNode	searchNode(Object userObject, String caption) Searches the tree below (including) this XdevTreeNode for the first node matching the given userObject and/or the given caption.
<T extends TreeNode> List<T>	searchNodes(Object userObject, String caption) Searches the tree below (including) this XdevTreeNode for the all node matching the given userObject and/or the given caption.
void	setCaption(String caption) Sets the caption of this XdevTreeNode.
void	setIcon(Icon icon) Sets the Icon of this XdevTreeNode.
void	setModel(DefaultTreeModel model) Sets the TreeModel for this XdevTreeNode.
void	setUserObject(Object o)
String	toString()

Methods inherited from class javax.swing.tree.DefaultMutableTreeNode

breadthFirstEnumeration, children, depthFirstEnumeration, getAllowsChildren, getChildAfter, getChildBefore, getChildCount, getDepth, getFirstChild, getFirstLeaf, getIndex, getLastChild, getLastLeaf, getLeafCount, getLevel, getNextLeaf, getNextNode, getNextSibling, getParent, getPath, getPathToRoot, getPreviousLeaf, getPreviousNode, getPreviousSibling, getRoot, getSharedAncestor, getSiblingCount, getUserObject, getUserObjectPath, isLeaf, isNodeAncestor, isNodeChild, isNodeDescendant, isNodeRelated, isNodeSibling, isRoot, pathFromAncestorEnumeration, postorderEnumeration, preorderEnumeration, setAllowsChildren, setParent

Methods inherited from class java.lang.Object

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

Constructor Detail

XdevTreeNode

public XdevTreeNode(Object userObject)

Creates a tree node with no parent, no children, but which allows children, and initializes it with the specified user object.

Parameters:

userObject - an Object provided by the user that constitutes the node's data

XdevTreeNode

public XdevTreeNode(Object userObject,
                    String caption)

Creates a tree node with no parent, no children, but which allows children, and initializes it with the specified user object.

Parameters:

userObject - an Object provided by the user that constitutes the node's data

caption - the caption of this XdevTreeNode

XdevTreeNode

public XdevTreeNode(Object userObject,
                    String caption,
                    Icon icon)

Creates a tree node with no parent, no children, but which allows children, and initializes it with the specified user object.

Parameters:

userObject - an Object provided by the user that constitutes the node's data

caption - the caption of this XdevTreeNode

icon - Icon of this XdevTreeNode

Method Detail

add

public XdevTreeNode add(XdevTreeNode... nodes)
                 throws IllegalArgumentException

Removes nodes from their parent and makes them a child of this node by adding it to the end of this node's child array.

Parameters:

nodes - nodes to add as a children of this node

Returns:

this XdevTreeNode after the nodes have been added

Throws:

IllegalArgumentException - if one element of nodes is null

See Also:

insert(javax.swing.tree.MutableTreeNode, int)

getXdevParent

public XdevTreeNode getXdevParent()

Returns this node's parent or null if this node has no parent.

Returns:

this node's parent XdevTreeNode, or null if this node has no parent

getChildAt

public TreeNode getChildAt(int index)

Specified by:

getChildAt in interface TreeNode

Overrides:

getChildAt in class DefaultMutableTreeNode

getChildren

public <T extends TreeNode> List<T> getChildren()

Returns a XdevList containing the children of this XdevTreeNode.

Only the children of this XdevTreeNode are returned. The children of the children are not returned.

Returns:

a XdevList containing the children of this XdevTreeNode.

setUserObject

public void setUserObject(Object o)

Specified by:

setUserObject in interface MutableTreeNode

Overrides:

setUserObject in class DefaultMutableTreeNode

add

public void add(MutableTreeNode node)

Overrides:

add in class DefaultMutableTreeNode

insert

public void insert(MutableTreeNode node,
                   int index)

Specified by:

insert in interface MutableTreeNode

Overrides:

insert in class DefaultMutableTreeNode

removeNode

public XdevTreeNode removeNode(XdevTreeNode node)
                        throws IllegalArgumentException

Removes node from this node's child array, giving it a null parent.

Parameters:

node - a child of this node to remove

Returns:

the removed node

Throws:

IllegalArgumentException - if node is null or is not a child of this node

remove

public void remove(MutableTreeNode node)

Specified by:

remove in interface MutableTreeNode

Overrides:

remove in class DefaultMutableTreeNode

removeNodeAt

public XdevTreeNode removeNodeAt(int index)
                          throws ArrayIndexOutOfBoundsException

Removes the node at the specified index from this node's children and sets that node's parent to null.

Parameters:

index - the index in this node's child array of the child to remove * @return the removed node

Throws:

ArrayIndexOutOfBoundsException - if childIndex is out of bounds

remove

public void remove(int index)

Specified by:

remove in interface MutableTreeNode

Overrides:

remove in class DefaultMutableTreeNode

removeAllChildren

public void removeAllChildren()

Overrides:

removeAllChildren in class DefaultMutableTreeNode

removeFromParent

public void removeFromParent()

Specified by:

removeFromParent in interface MutableTreeNode

Overrides:

removeFromParent in class DefaultMutableTreeNode

getPathAsList

public <T extends TreeNode> List<T> getPathAsList()

Returns the path from the root, to get to this node. The last element in the path is this node.

Returns:

an XdevList of TreeNode objects giving the path, where the first element in the path is the root and the last element is this node.

toString

public String toString()

Overrides:

toString in class DefaultMutableTreeNode

getCaption

public String getCaption()

Returns the caption of this XdevTreeNode.

Returns:

the caption of this XdevTreeNode.

setCaption

public void setCaption(String caption)

Sets the caption of this XdevTreeNode.

Parameters:

caption - the caption of this XdevTreeNode.

getIcon

public Icon getIcon()

Returns the Icon of this XdevTreeNode.

Returns:

the Icon of this XdevTreeNode.

setIcon

public void setIcon(Icon icon)

Sets the Icon of this XdevTreeNode.

Parameters:

icon - the Icon of this XdevTreeNode.

getSubTree

public <T extends TreeNode> List<T> getSubTree()

Creates and returns an XdevList that traverses the subtree rooted at this node in preorder. The first node of the XdevList is this node.

Returns:

an XdevList for traversing the tree in preorder

searchNode

public XdevTreeNode searchNode(Object userObject,
                               String caption)

Searches the tree below (including) this XdevTreeNode for the first node matching the given userObject and/or the given caption.

Parameters:

userObject - to search for. If userObject is null , the searched for node must only match caption.

caption - to search for. If caption is null, the searched for node must only match userObject.

Returns:

the node that matches userObject and/or the given caption.

searchNodes

public <T extends TreeNode> List<T> searchNodes(Object userObject,
                                                String caption)

Searches the tree below (including) this XdevTreeNode for the all node matching the given userObject and/or the given caption.

Parameters:

userObject - to search for. If userObject is null , the searched for node must only match caption.

caption - to search for. If caption is null, the searched for node must only match userObject.

Returns:

the node that matches userObject and/or the given caption.

setModel

public void setModel(DefaultTreeModel model)

Sets the TreeModel for this XdevTreeNode.

Parameters:

model - the TreeModel for this XdevTreeNode.

getModel

public DefaultTreeModel getModel()

Returns the TreeModel for this XdevTreeNode.

Returns:

the TreeModel for this XdevTreeNode.

clone

public XdevTreeNode clone()

Returns a field-for-field copy of this instance.

Specified by:

clone in interface Copyable<XdevTreeNode>

Overrides:

clone in class DefaultMutableTreeNode

Returns:

a field-for-field copy of this instance.

cloneTree

public XdevTreeNode cloneTree()

Clones a XdevTreeNode and all its children (deep clone).

Returns:

a deep clone of this XdevTreeNode.