Ontimize Document Management 0.035EN

com.ontimize.dms.client.gui.tree
Class TreeNode

java.lang.Object
  extended by javax.swing.tree.DefaultMutableTreeNode
      extended by com.ontimize.dms.client.gui.tree.TreeNode
All Implemented Interfaces:
java.awt.datatransfer.Transferable, java.io.Serializable, java.lang.Cloneable, javax.swing.tree.MutableTreeNode, javax.swing.tree.TreeNode
Direct Known Subclasses:
TreeNodeEmpty

public class TreeNode
extends javax.swing.tree.DefaultMutableTreeNode
implements java.awt.datatransfer.Transferable

Tree node object. Allows a virtual document view.

Since:
26/02/2009 Refactoring. Allows virtual nodes., 24/02/2009 Allows setting node data., 23/04/2009 Change node to allow a empty node., 24/06/2008 Refactoring. Node configuration., 26/06/2009 Changed node path., 20/10/2009 Different icons for empty and not-empty nodes., 09/11/2009 Added custom icons for empty and not-empty nodes.
See Also:
Serialized Form

Nested Class Summary
static class TreeNode.Type
          Tree node type.
 
Field Summary
static TreeNode.Type BASE
           
protected static int BASE_KEY
           
static java.lang.String CLOSED_CONTENT_FOLDER_ICON_KEY
           
static java.lang.String CLOSED_EMPTY_FOLDER_ICON_KEY
           
protected  javax.swing.ImageIcon closedContentIcon
           
protected  javax.swing.ImageIcon closedEmptyIcon
           
protected  java.util.Map data
           
protected static javax.swing.ImageIcon DEFAULT_CLOSED_CONTENT_ICON
           
protected static javax.swing.ImageIcon DEFAULT_CLOSED_EMPTY_ICON
           
protected static javax.swing.ImageIcon DEFAULT_OPEN_CONTENT_ICON
           
protected static javax.swing.ImageIcon DEFAULT_OPEN_EMPTY_ICON
           
static TreeNode.Type DIR
           
protected static int DIR_KEY
           
protected  java.util.List fields
           
static java.awt.datatransfer.DataFlavor[] flavors
           
static java.util.List flavorsList
           
static java.lang.String ICON_KEY
           
static java.lang.String[] ICONS
           
protected  java.lang.String id
           
static TreeNode.Type KEYS
           
protected static int KEYS_KEY
           
protected  boolean leaf
           
protected  java.lang.String name
           
static java.lang.String OPENED_CONTENT_FOLDER_ICON_KEY
           
static java.lang.String OPENED_EMPTY_FOLDER_ICON_KEY
           
protected  javax.swing.ImageIcon openedContentIcon
           
protected  javax.swing.ImageIcon openedEmptyIcon
           
protected  java.lang.String path
           
protected  java.lang.String text
           
protected  java.lang.String tooltip
           
protected static java.util.Map types
           
 
Fields inherited from class javax.swing.tree.DefaultMutableTreeNode
allowsChildren, children, EMPTY_ENUMERATION, parent, userObject
 
Constructor Summary
TreeNode(java.util.Map data, java.util.Map config)
           
 
Method Summary
protected  java.lang.StringBuffer createVisibleFields()
           
 java.lang.String getCanonicalPath()
           
 javax.swing.tree.TreeNode getChildAt(int index)
           
 javax.swing.ImageIcon getClosedIcon()
           
 java.util.Map getData()
           
 java.util.List getFields()
           
 java.lang.String getID()
           
 java.lang.String getName()
           
 TreeNode getNode(java.lang.String name)
           
 java.lang.String getNodeName()
           
 java.lang.String getNodePath()
           
 TreeNode.Type getNodeType()
           
 javax.swing.ImageIcon getOpenIcon()
           
 TreeNode getParentNode()
           
 java.lang.String getPathID()
           
 java.lang.String getTooltip()
           
 java.lang.Object getTransferData(java.awt.datatransfer.DataFlavor flavor)
           
 java.awt.datatransfer.DataFlavor[] getTransferDataFlavors()
           
 javax.swing.tree.TreePath getTreePath()
           
protected  boolean hasChildren()
           
 boolean isDataFlavorSupported(java.awt.datatransfer.DataFlavor flavor)
           
 boolean isEditable()
          Check if the current node is editable.
 boolean isLeaf()
           
 boolean isNodeType(TreeNode.Type type)
           
 void setClosedContentIcon(javax.swing.ImageIcon icon)
           
 void setClosedEmptyIcon(javax.swing.ImageIcon icon)
           
 void setConfiguration(java.util.Map config)
           
 void setData(java.util.Map data)
           
 void setIcon(javax.swing.ImageIcon icon)
           
 void setOpenedContentIcon(javax.swing.ImageIcon icon)
           
 void setOpenedEmptyIcon(javax.swing.ImageIcon icon)
           
 void setText(java.lang.String text)
           
 void setTooltip(java.lang.String tooltip)
           
 java.lang.String toString()
           
protected  java.lang.String toString(java.lang.Object object)
           
 
Methods inherited from class javax.swing.tree.DefaultMutableTreeNode
add, breadthFirstEnumeration, children, clone, depthFirstEnumeration, getAllowsChildren, getChildAfter, 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, 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

ICON_KEY

public static final java.lang.String ICON_KEY
See Also:
Constant Field Values

OPENED_CONTENT_FOLDER_ICON_KEY

public static final java.lang.String OPENED_CONTENT_FOLDER_ICON_KEY
See Also:
Constant Field Values

CLOSED_CONTENT_FOLDER_ICON_KEY

public static final java.lang.String CLOSED_CONTENT_FOLDER_ICON_KEY
See Also:
Constant Field Values

OPENED_EMPTY_FOLDER_ICON_KEY

public static final java.lang.String OPENED_EMPTY_FOLDER_ICON_KEY
See Also:
Constant Field Values

CLOSED_EMPTY_FOLDER_ICON_KEY

public static final java.lang.String CLOSED_EMPTY_FOLDER_ICON_KEY
See Also:
Constant Field Values

ICONS

public static final java.lang.String[] ICONS

BASE_KEY

protected static final int BASE_KEY
See Also:
Constant Field Values

KEYS_KEY

protected static final int KEYS_KEY
See Also:
Constant Field Values

DIR_KEY

protected static final int DIR_KEY
See Also:
Constant Field Values

BASE

public static TreeNode.Type BASE

KEYS

public static TreeNode.Type KEYS

DIR

public static TreeNode.Type DIR

types

protected static java.util.Map types

flavorsList

public static java.util.List flavorsList

flavors

public static java.awt.datatransfer.DataFlavor[] flavors

DEFAULT_OPEN_EMPTY_ICON

protected static final javax.swing.ImageIcon DEFAULT_OPEN_EMPTY_ICON

DEFAULT_CLOSED_EMPTY_ICON

protected static final javax.swing.ImageIcon DEFAULT_CLOSED_EMPTY_ICON

DEFAULT_OPEN_CONTENT_ICON

protected static final javax.swing.ImageIcon DEFAULT_OPEN_CONTENT_ICON

DEFAULT_CLOSED_CONTENT_ICON

protected static final javax.swing.ImageIcon DEFAULT_CLOSED_CONTENT_ICON

path

protected java.lang.String path

name

protected java.lang.String name

data

protected java.util.Map data

fields

protected java.util.List fields

leaf

protected boolean leaf

id

protected java.lang.String id

text

protected java.lang.String text

tooltip

protected java.lang.String tooltip

openedEmptyIcon

protected javax.swing.ImageIcon openedEmptyIcon

openedContentIcon

protected javax.swing.ImageIcon openedContentIcon

closedEmptyIcon

protected javax.swing.ImageIcon closedEmptyIcon

closedContentIcon

protected javax.swing.ImageIcon closedContentIcon
Constructor Detail

TreeNode

public TreeNode(java.util.Map data,
                java.util.Map config)
Method Detail

isLeaf

public boolean isLeaf()
Specified by:
isLeaf in interface javax.swing.tree.TreeNode
Overrides:
isLeaf in class javax.swing.tree.DefaultMutableTreeNode

isEditable

public boolean isEditable()

Check if the current node is editable. Non editable nodes.

  • Root node always is not editable.
  • Nodes labelled as 'base'.
  • Nodes labelled as 'keys'.

    Returns:
    True is the node can be changed.

  • isNodeType

    public boolean isNodeType(TreeNode.Type type)

    getID

    public java.lang.String getID()

    getName

    public java.lang.String getName()

    getNodeType

    public TreeNode.Type getNodeType()

    getNodeName

    public java.lang.String getNodeName()

    getNodePath

    public java.lang.String getNodePath()

    getCanonicalPath

    public java.lang.String getCanonicalPath()

    getPathID

    public java.lang.String getPathID()

    getTreePath

    public javax.swing.tree.TreePath getTreePath()

    getNode

    public TreeNode getNode(java.lang.String name)

    getParentNode

    public TreeNode getParentNode()

    getChildAt

    public javax.swing.tree.TreeNode getChildAt(int index)
    Specified by:
    getChildAt in interface javax.swing.tree.TreeNode
    Overrides:
    getChildAt in class javax.swing.tree.DefaultMutableTreeNode

    getData

    public java.util.Map getData()

    getTooltip

    public java.lang.String getTooltip()

    getFields

    public java.util.List getFields()

    hasChildren

    protected boolean hasChildren()

    getOpenIcon

    public javax.swing.ImageIcon getOpenIcon()

    getClosedIcon

    public javax.swing.ImageIcon getClosedIcon()

    setText

    public void setText(java.lang.String text)

    setData

    public void setData(java.util.Map data)

    setConfiguration

    public void setConfiguration(java.util.Map config)

    setTooltip

    public void setTooltip(java.lang.String tooltip)

    setIcon

    public void setIcon(javax.swing.ImageIcon icon)

    setOpenedEmptyIcon

    public void setOpenedEmptyIcon(javax.swing.ImageIcon icon)

    setClosedEmptyIcon

    public void setClosedEmptyIcon(javax.swing.ImageIcon icon)

    setOpenedContentIcon

    public void setOpenedContentIcon(javax.swing.ImageIcon icon)

    setClosedContentIcon

    public void setClosedContentIcon(javax.swing.ImageIcon icon)

    toString

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

    toString

    protected java.lang.String toString(java.lang.Object object)

    createVisibleFields

    protected java.lang.StringBuffer createVisibleFields()

    getTransferDataFlavors

    public java.awt.datatransfer.DataFlavor[] getTransferDataFlavors()
    Specified by:
    getTransferDataFlavors in interface java.awt.datatransfer.Transferable

    isDataFlavorSupported

    public boolean isDataFlavorSupported(java.awt.datatransfer.DataFlavor flavor)
    Specified by:
    isDataFlavorSupported in interface java.awt.datatransfer.Transferable

    getTransferData

    public java.lang.Object getTransferData(java.awt.datatransfer.DataFlavor flavor)
                                     throws java.awt.datatransfer.UnsupportedFlavorException,
                                            java.io.IOException
    Specified by:
    getTransferData in interface java.awt.datatransfer.Transferable
    Throws:
    java.awt.datatransfer.UnsupportedFlavorException
    java.io.IOException

    Ontimize Document Management