org.geotools.gui.swing.tree
Class NamedTreeNode

Object
  extended by DefaultMutableTreeNode
      extended by DefaultMutableTreeNode
          extended by NamedTreeNode
All Implemented Interfaces:
Serializable, Cloneable, MutableTreeNode, 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
Author:
Martin Desruisseaux (IRD)
See Also:
Serialized Form
Module:

Field Summary
 
Fields inherited from class DefaultMutableTreeNode
allowsChildren, children, EMPTY_ENUMERATION, parent, userObject
 
Constructor Summary
NamedTreeNode(String name)
          Creates a tree node that has no parent and no children, but which allows children.
NamedTreeNode(String name, Object userObject)
          Creates a tree node with no parent, no children, but which allows children, and initializes it with the specified user object.
NamedTreeNode(String name, 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
 String toString()
          Returns this node label.
 
Methods inherited from class 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 Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface MutableTreeNode
insert, remove, remove, removeFromParent, setParent, setUserObject
 
Methods inherited from interface TreeNode
children, getAllowsChildren, getChildAt, getChildCount, getIndex, getParent, isLeaf
 
Methods inherited from interface TreeNode
getUserObject
 
Methods inherited from interface TreeNode
children, getAllowsChildren, getChildAt, getChildCount, getIndex, getParent, isLeaf
 

Constructor Detail

NamedTreeNode

public NamedTreeNode(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(String name,
                     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(String name,
                     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 String toString()
Returns this node label. This method is invoked by JTree for populating the tree widget.

Overrides:
toString in class DefaultMutableTreeNode


Copyright © 1996-2009 Geotools. All Rights Reserved.