org.geotools.gui.swing.tree
Class NamedTreeNode

java.lang.Object
  javax.swing.tree.DefaultMutableTreeNode
      org.geotools.gui.swing.tree.DefaultMutableTreeNode
          org.geotools.gui.swing.tree.NamedTreeNode

All Implemented Interfaces:

java.lang.Cloneable, javax.swing.tree.MutableTreeNode, MutableTreeNode, java.io.Serializable, javax.swing.tree.TreeNode, TreeNode

public class NamedTreeNode

extends DefaultMutableTreeNode

A tree node with a name which may be different than the user object. The JTree component invokes the toString() method for populating the tree widget. This class overrides the default implementation (userObject.toString) with a custom label.

Since:

2.0

Version:

$Id: NamedTreeNode.java 17672 2006-01-19 00:25:55Z desruisseaux $

Author:

Martin Desruisseaux

See Also:

Serialized Form

Field Summary

Fields inherited from class javax.swing.tree.DefaultMutableTreeNode

allowsChildren, children, EMPTY_ENUMERATION, parent, userObject

Constructor Summary

NamedTreeNode(java.lang.String name)
Creates a tree node that has no parent and no children, but which allows children.

NamedTreeNode(java.lang.String name, java.lang.Object userObject)
Creates a tree node with no parent, no children, but which allows children, and initializes it with the specified user object.

NamedTreeNode(java.lang.String name, java.lang.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.

Method Summary

java.lang.String

toString() Returns this node label.

Methods inherited from class javax.swing.tree.DefaultMutableTreeNode

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.swing.tree.MutableTreeNode

insert, remove, remove, removeFromParent, setParent, setUserObject

Methods inherited from interface javax.swing.tree.TreeNode

children, getAllowsChildren, getChildAt, getChildCount, getIndex, getParent, isLeaf

Methods inherited from interface org.geotools.gui.swing.tree.TreeNode

getUserObject

Constructor Detail

NamedTreeNode

public NamedTreeNode(java.lang.String name)

Creates a tree node that has no parent and no children, but which allows children.

Parameters:

name - The node name to be returned by toString().

NamedTreeNode

public NamedTreeNode(java.lang.String name,
                     java.lang.Object userObject)

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

Parameters:

name - The node name to be returned by toString().

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

NamedTreeNode

public NamedTreeNode(java.lang.String name,
                     java.lang.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.

Parameters:

name - The node name to be returned by toString().

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

allowsChildren - if true, the node is allowed to have child nodes -- otherwise, it is always a leaf node

Method Detail

toString

public java.lang.String toString()

Returns this node label. This method is invoked by JTree for populating the tree widget.