public static class

JTree.DynamicUtilTreeNode

extends DefaultMutableTreeNode

java.lang.Object
↳	javax.swing.tree.DefaultMutableTreeNode
	↳	javax.swing.JTree.DynamicUtilTreeNode

Class Overview

DynamicUtilTreeNode can wrap vectors/hashtables/arrays/strings and create the appropriate children tree nodes as necessary. It is dynamic in that it will only create the children as necessary.

Warning: Serialized objects of this class will not be compatible with future Swing releases. The current serialization support is appropriate for short term storage or RMI between applications running the same version of Swing. As of 1.4, support for long term storage of all JavaBeans^TM has been added to the java.beans package. Please see XMLEncoder.

Summary

Fields
protected Object	childValue	Value to create children with.
protected boolean	hasChildren	Does the this `JTree` have children? This property is currently not implemented.
protected boolean	loadedChildren	Have the children been loaded yet?

[Expand]

Inherited Fields

From class javax.swing.tree.DefaultMutableTreeNode

Public Constructors
	JTree.DynamicUtilTreeNode(Object value, Object children) Creates a node with the specified object as its value and with the specified children.

Public Methods
Enumeration	children() Subclassed to load the children, if necessary.
static void	createChildren(DefaultMutableTreeNode parent, Object children) Adds to parent all the children in `children`.
TreeNode	getChildAt(int index) Subclassed to load the children, if necessary.
int	getChildCount() Returns the number of child nodes.
boolean	isLeaf() Returns true if this node allows children.

Protected Methods
void	loadChildren() Loads the children based on `childValue`.

[Expand]

Inherited Methods

From class javax.swing.tree.DefaultMutableTreeNode

void	add(MutableTreeNode newChild) Removes `newChild` from its parent and makes it a child of this node by adding it to the end of this node's child array.
Enumeration	breadthFirstEnumeration() Creates and returns an enumeration that traverses the subtree rooted at this node in breadth-first order.
Enumeration	children() Creates and returns a forward-order enumeration of this node's children.
Object	clone() Overridden to make clone public.
Enumeration	depthFirstEnumeration() Creates and returns an enumeration that traverses the subtree rooted at this node in depth-first order.
boolean	getAllowsChildren() Returns true if this node is allowed to have children.
TreeNode	getChildAfter(TreeNode aChild) Returns the child in this node's child array that immediately follows `aChild`, which must be a child of this node.
TreeNode	getChildAt(int index) Returns the child at the specified index in this node's child array.
TreeNode	getChildBefore(TreeNode aChild) Returns the child in this node's child array that immediately precedes `aChild`, which must be a child of this node.
int	getChildCount() Returns the number of children of this node.
int	getDepth() Returns the depth of the tree rooted at this node -- the longest distance from this node to a leaf.
TreeNode	getFirstChild() Returns this node's first child.
DefaultMutableTreeNode	getFirstLeaf() Finds and returns the first leaf that is a descendant of this node -- either this node or its first child's first leaf.
int	getIndex(TreeNode aChild) Returns the index of the specified child in this node's child array.
TreeNode	getLastChild() Returns this node's last child.
DefaultMutableTreeNode	getLastLeaf() Finds and returns the last leaf that is a descendant of this node -- either this node or its last child's last leaf.
int	getLeafCount() Returns the total number of leaves that are descendants of this node.
int	getLevel() Returns the number of levels above this node -- the distance from the root to this node.
DefaultMutableTreeNode	getNextLeaf() Returns the leaf after this node or null if this node is the last leaf in the tree.
DefaultMutableTreeNode	getNextNode() Returns the node that follows this node in a preorder traversal of this node's tree.
DefaultMutableTreeNode	getNextSibling() Returns the next sibling of this node in the parent's children array.
TreeNode	getParent() Returns this node's parent or null if this node has no parent.
TreeNode[]	getPath() Returns the path from the root, to get to this node.
TreeNode[]	getPathToRoot(TreeNode aNode, int depth) Builds the parents of node up to and including the root node, where the original node is the last element in the returned array.
DefaultMutableTreeNode	getPreviousLeaf() Returns the leaf before this node or null if this node is the first leaf in the tree.
DefaultMutableTreeNode	getPreviousNode() Returns the node that precedes this node in a preorder traversal of this node's tree.
DefaultMutableTreeNode	getPreviousSibling() Returns the previous sibling of this node in the parent's children array.
TreeNode	getRoot() Returns the root of the tree that contains this node.
TreeNode	getSharedAncestor(DefaultMutableTreeNode aNode) Returns the nearest common ancestor to this node and `aNode`.
int	getSiblingCount() Returns the number of siblings of this node.
Object	getUserObject() Returns this node's user object.
Object[]	getUserObjectPath() Returns the user object path, from the root, to get to this node.
void	insert(MutableTreeNode newChild, int childIndex) Removes `newChild` from its present parent (if it has a parent), sets the child's parent to this node, and then adds the child to this node's child array at index `childIndex`.
boolean	isLeaf() Returns true if this node has no children.
boolean	isNodeAncestor(TreeNode anotherNode) Returns true if `anotherNode` is an ancestor of this node -- if it is this node, this node's parent, or an ancestor of this node's parent.
boolean	isNodeChild(TreeNode aNode) Returns true if `aNode` is a child of this node.
boolean	isNodeDescendant(DefaultMutableTreeNode anotherNode) Returns true if `anotherNode` is a descendant of this node -- if it is this node, one of this node's children, or a descendant of one of this node's children.
boolean	isNodeRelated(DefaultMutableTreeNode aNode) Returns true if and only if `aNode` is in the same tree as this node.
boolean	isNodeSibling(TreeNode anotherNode) Returns true if `anotherNode` is a sibling of (has the same parent as) this node.
boolean	isRoot() Returns true if this node is the root of the tree.
Enumeration	pathFromAncestorEnumeration(TreeNode ancestor) Creates and returns an enumeration that follows the path from `ancestor` to this node.
Enumeration	postorderEnumeration() Creates and returns an enumeration that traverses the subtree rooted at this node in postorder.
Enumeration	preorderEnumeration() Creates and returns an enumeration that traverses the subtree rooted at this node in preorder.
void	remove(int childIndex) Removes the child at the specified index from this node's children and sets that node's parent to null.
void	remove(MutableTreeNode aChild) Removes `aChild` from this node's child array, giving it a null parent.
void	removeAllChildren() Removes all of this node's children, setting their parents to null.
void	removeFromParent() Removes the subtree rooted at this node from the tree, giving this node a null parent.
void	setAllowsChildren(boolean allows) Determines whether or not this node is allowed to have children.
void	setParent(MutableTreeNode newParent) Sets this node's parent to `newParent` but does not change the parent's child array.
void	setUserObject(Object userObject) Sets the user object for this node to `userObject`.
String	toString() Returns the result of sending `toString()` to this node's user object, or null if this node has no user object.

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

From interface javax.swing.tree.MutableTreeNode

From interface javax.swing.tree.TreeNode

Fields

protected Object childValue

Value to create children with.

protected boolean hasChildren

Does the this JTree have children? This property is currently not implemented.

protected boolean loadedChildren

Have the children been loaded yet?

Public Constructors

public JTree.DynamicUtilTreeNode (Object value, Object children)

Creates a node with the specified object as its value and with the specified children. For the node to allow children, the children-object must be an array of objects, a Vector, or a Hashtable -- even if empty. Otherwise, the node is not allowed to have children.

Parameters

value	the `Object` that is the value for the new node
children	an array of `Object`s, a `Vector`, or a `Hashtable` used to create the child nodes; if any other object is specified, or if the value is `null`, then the node is not allowed to have children

Public Methods

public Enumeration children ()

Subclassed to load the children, if necessary.

Returns

an Enumeration of this node's children

public static void createChildren (DefaultMutableTreeNode parent, Object children)

Adds to parent all the children in children. If children is an array or vector all of its elements are added is children, otherwise if children is a hashtable all the key/value pairs are added in the order Enumeration returns them.

public TreeNode getChildAt (int index)

Subclassed to load the children, if necessary.

Parameters

index	an index into this node's child array

Returns

the TreeNode in this node's child array at the specified index

public int getChildCount ()

Returns the number of child nodes.

Returns

the number of child nodes

public boolean isLeaf ()

Returns true if this node allows children. Whether the node allows children depends on how it was created.

Returns

true if this node allows children, false otherwise

Protected Methods

protected void loadChildren ()

Loads the children based on childValue. If childValue is a Vector or array each element is added as a child, if childValue is a Hashtable each key/value pair is added in the order that Enumeration returns the keys.

Interfaces

Classes

Enums

Exceptions

JTree.DynamicUtilTreeNode

Class Overview

Summary

Fields

protected Object childValue

protected boolean hasChildren

protected boolean loadedChildren

Public Constructors

public JTree.DynamicUtilTreeNode (Object value, Object children)

Parameters

Public Methods

public Enumeration children ()

Returns

public static void createChildren (DefaultMutableTreeNode parent, Object children)

public TreeNode getChildAt (int index)

Parameters

Returns

public int getChildCount ()

Returns

public boolean isLeaf ()

Returns

See Also

Protected Methods

protected void loadChildren ()