org.basex.gui.layout
Class TreeNode

java.lang.Object
  extended by javax.swing.tree.DefaultMutableTreeNode
      extended by org.basex.gui.layout.TreeNode
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, java.util.EventListener, javax.swing.event.TreeWillExpandListener, javax.swing.tree.MutableTreeNode, javax.swing.tree.TreeNode
Direct Known Subclasses:
TreeFolder, TreeLeaf

public abstract class TreeNode
extends javax.swing.tree.DefaultMutableTreeNode
implements javax.swing.event.TreeWillExpandListener

JTree node for representing database content (raw files / documents).

Author:
BaseX Team 2005-12, BSD License, Lukas Kircher
See Also:
Serialized Form

Field Summary
 byte[] name
          Node name.
 
Fields inherited from class javax.swing.tree.DefaultMutableTreeNode
allowsChildren, children, EMPTY_ENUMERATION, parent, userObject
 
Method Summary
 java.lang.String path()
          Returns the complete path (path + name) of this node as a string.
static byte[] preparePath(byte[] path)
          Prepares the given path to be used as a tree node.
 java.lang.String toString()
           
 void treeWillCollapse(javax.swing.event.TreeExpansionEvent e)
           
 void treeWillExpand(javax.swing.event.TreeExpansionEvent e)
           
 
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
 

Field Detail

name

public final byte[] name
Node name.

Method Detail

preparePath

public static byte[] preparePath(byte[] path)
Prepares the given path to be used as a tree node. The returned path looks the following:
  1. The path is relative to the database root directory
  2. It has one leading slash
  3. It has no trailing slashes, no matter if it represents a folder or file

Parameters:
path - path to be prepared
Returns:
path

path

public java.lang.String path()
Returns the complete path (path + name) of this node as a string.

Returns:
path string

treeWillExpand

public void treeWillExpand(javax.swing.event.TreeExpansionEvent e)
                    throws javax.swing.tree.ExpandVetoException
Specified by:
treeWillExpand in interface javax.swing.event.TreeWillExpandListener
Throws:
javax.swing.tree.ExpandVetoException

treeWillCollapse

public void treeWillCollapse(javax.swing.event.TreeExpansionEvent e)
                      throws javax.swing.tree.ExpandVetoException
Specified by:
treeWillCollapse in interface javax.swing.event.TreeWillExpandListener
Throws:
javax.swing.tree.ExpandVetoException

toString

public java.lang.String toString()
Overrides:
toString in class javax.swing.tree.DefaultMutableTreeNode