API Overview API Index Package Overview Direct link to this page
JDK 1.6
  javax.swing.tree. DefaultMutableTreeNode View Source
Author(s)
Rob Davis
Since
Version
1.24 11/17/05
Serial
Hierarchy
 Object
      DefaultMutableTreeNode
Implements
 Cloneable
 MutableTreeNode
 Serializable
Subclasses
Description
public class DefaultMutableTreeNode
  A DefaultMutableTreeNode is a general-purpose node in a tree data structure.
See also:    MutableTreeNode
Constructors
public DefaultMutableTreeNode ()
Creates a tree node that has no parent and no children, but which allows children.
public DefaultMutableTreeNode (Object userObject)
  Creates a tree node with no parent, no children, but which allows children, and initializes it with the specified user object.
public DefaultMutableTreeNode (Object userObject, boolean allowsChildren)
  Creates a tree node with no parent, no children, initialized with the specified user object, and that allows children only if specified.
Methods
Hide/Show inherited methods
public 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.
public Enumeration breadthFirstEnumeration ()
  Creates and returns an enumeration that traverses the subtree rooted at this node in breadth-first order.
public Enumeration children ()
  Creates and returns a forward-order enumeration of this node's children.
public Object clone ()
  Overridden to make clone public.
public Enumeration depthFirstEnumeration ()
  Creates and returns an enumeration that traverses the subtree rooted at this node in depth-first order.
public boolean getAllowsChildren ()
  Returns true if this node is allowed to have children.
public 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.
public TreeNode getChildAt (int index)
  Returns the child at the specified index in this node's child array.
public 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.
public int getChildCount ()
  Returns the number of children of this node.
public int getDepth ()
  Returns the depth of the tree rooted at this node -- the longest distance from this node to a leaf.
public TreeNode getFirstChild ()
  Returns this node's first child.
public 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.
public int getIndex (TreeNode aChild)
  Returns the index of the specified child in this node's child array.
public TreeNode getLastChild ()
  Returns this node's last child.
public 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.
public int getLeafCount ()
  Returns the total number of leaves that are descendants of this node.
public int getLevel ()
  Returns the number of levels above this node -- the distance from the root to this node.
public DefaultMutableTreeNode getNextLeaf ()
  Returns the leaf after this node or null if this node is the last leaf in the tree.
public DefaultMutableTreeNode getNextNode ()
  Returns the node that follows this node in a preorder traversal of this node's tree.
public DefaultMutableTreeNode getNextSibling ()
  Returns the next sibling of this node in the parent's children array.
public TreeNode getParent ()
  Returns this node's parent or null if this node has no parent.
public TreeNode getPath ()
  Returns the path from the root, to get to this node.
protected 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.
public DefaultMutableTreeNode getPreviousLeaf ()
  Returns the leaf before this node or null if this node is the first leaf in the tree.
public DefaultMutableTreeNode getPreviousNode ()
  Returns the node that precedes this node in a preorder traversal of this node's tree.
public DefaultMutableTreeNode getPreviousSibling ()
  Returns the previous sibling of this node in the parent's children array.
public TreeNode getRoot ()
  Returns the root of the tree that contains this node.
public TreeNode getSharedAncestor (DefaultMutableTreeNode aNode)
  Returns the nearest common ancestor to this node and aNode.
public int getSiblingCount ()
  Returns the number of siblings of this node.
public Object getUserObject ()
  Returns this node's user object.
public Object getUserObjectPath ()
  Returns the user object path, from the root, to get to this node.
public void insert (MutableTreeNode newChild, int childIndex) [Specified in MutableTreeNode]
  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.
public boolean isLeaf ()
  Returns true if this node has no children.
public 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.
public boolean isNodeChild (TreeNode aNode)
  Returns true if aNode is a child of this node.
public 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.
public boolean isNodeRelated (DefaultMutableTreeNode aNode)
  Returns true if and only if aNode is in the same tree as this node.
public boolean isNodeSibling (TreeNode anotherNode)
  Returns true if anotherNode is a sibling of (has the same parent as) this node.
public boolean isRoot ()
  Returns true if this node is the root of the tree.
public Enumeration pathFromAncestorEnumeration (TreeNode ancestor)
  Creates and returns an enumeration that follows the path from ancestor to this node.
public Enumeration postorderEnumeration ()
  Creates and returns an enumeration that traverses the subtree rooted at this node in postorder.
public Enumeration preorderEnumeration ()
  Creates and returns an enumeration that traverses the subtree rooted at this node in preorder.
public void remove (int childIndex) [Specified in MutableTreeNode]
  Removes the child at the specified index from this node's children and sets that node's parent to null.
public void remove (MutableTreeNode aChild) [Specified in MutableTreeNode]
  Removes aChild from this node's child array, giving it a null parent.
public void removeAllChildren ()
  Removes all of this node's children, setting their parents to null.
public void removeFromParent () [Specified in MutableTreeNode]
  Removes the subtree rooted at this node from the tree, giving this node a null parent.
public void setAllowsChildren (boolean allows)
  Determines whether or not this node is allowed to have children.
public void setParent (MutableTreeNode newParent) [Specified in MutableTreeNode]
  Sets this node's parent to newParent but does not change the parent's child array.
public void setUserObject (Object userObject) [Specified in MutableTreeNode]
  Sets the user object for this node to userObject.
public String toString ()
  Returns the result of sending toString() to this node's user object, or null if this node has no user object.
Fields
Hide/Show inherited fields
protected boolean allowsChildren
true if the node is able to have children
protected Vector children
array of children, may be null if this node has no children
publicfinalstatic Enumeration<TreeNode> EMPTY_ENUMERATION
  An enumeration that is always empty.
protected MutableTreeNode parent
this node's parent, or null if this node has no parent
protectedtransient Object userObject
optional user object
Nested Classes
  DefaultMutableTreeNode.PreorderEnumeration
  DefaultMutableTreeNode.PostorderEnumeration
  DefaultMutableTreeNode.BreadthFirstEnumeration
  DefaultMutableTreeNode.PathBetweenNodesEnumeration
Generated By: JavaOnTracks Doclet 0.1.4     ©Thibaut Colar