NavigationTreeNode (JAXX :: Runtime 2.0.2 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

jaxx.runtime.swing.navigation.tree
Class NavigationTreeNode

java.lang.Object
  javax.swing.tree.DefaultMutableTreeNode
      jaxx.runtime.swing.navigation.tree.NavigationTreeNode

All Implemented Interfaces:: Serializable, Cloneable, MutableTreeNode, TreeNode, NavigationNode<NavigationTreeNode>

public class NavigationTreeNode
extends DefaultMutableTreeNode
implements NavigationNode<NavigationTreeNode>
extends DefaultMutableTreeNode
implements NavigationNode<NavigationTreeNode>

Node of the NavigationTreeModel.

Each node is associated with :

a bean coming from a JAXXContext
a uiClass to build the associated ui

To retrieve the bean from the context, there is a huge logic in the method getBean(JAXXContext).

In few words, if the jaxxContextEntryDef is defined, it means that the object is taken from the context.

Otherwise, find the first ancestor with an context entry and retrieve from here the bean.

Then go down to the initial node by applying the jxpath expressions jaxxContextEntryPath of each node on road back.

To identify easly a node, each node has a path and a fullPath (full path from root node).

To display the node we use a NavigationNodeRenderer which is in fact the DefaultMutableTreeNode.userObject, the object can be synch with the bean via the NavigationNodeRenderer.reload(Object) method.

Since:: 1.7.2
Author:: tchemit
See Also:: NavigationTreeModel, NavigationNodeRenderer, Serialized Form

Field Summary
`protected Object`	`bean` The bean associated with the node ( the value can be obtain via the method `getBean(JAXXContext)` or directly set via method `setBean(Object)`.
`protected String`	`fullPath` The full path for the node from the rood node.
`protected Class<?>`	`internalClass` The type of the related bean associated with the node.
`protected JAXXContextEntryDef<?>`	`jaxxContextEntryDef` The context entry definition to retrieve the bean.
`protected String`	`jaxxContextEntryPath` The jxPath to process to obtain real `bean` from the data retrieve in the context.
`protected String`	`path` The node path.
`protected String`	`pathSeparator` The path separator used to build the `fullPath`.
`protected Class<? extends JAXXObject>`	`uIClass` The UI class associated with the node.
`protected Class<? extends JAXXAction>`	`uIHandlerClass` The UI handler class associated with the node.

Fields inherited from class javax.swing.tree.DefaultMutableTreeNode
`allowsChildren, children, EMPTY_ENUMERATION, parent, userObject`

Constructor Summary
`NavigationTreeNode(String pathSeparator, String navigationPath, JAXXContextEntryDef<?> jaxxContextEntryDef, String jaxxContextEntryPath)`
`NavigationTreeNode(String pathSeparator, String navigationPath, Object jaxxContextEntryDef)`

Method Summary
`void`	`add(NavigationTreeNode node)`
`Enumeration<? extends NavigationTreeNode>`	`children()`
`protected String`	`computeJXPath(String expr, NavigationTreeNode parentNode)`
`Object`	`getBean()`
`Object`	`getBean(JAXXContext context)` Obtain the associated bean value from context corresponding to node
`NavigationTreeNode`	`getChild(String path)`
`NavigationTreeNode`	`getChildAt(int index)`
`protected NavigationTreeNode`	`getFirstAncestorWithDef()`
`String`	`getFullPath()`
`int`	`getIndex(NavigationTreeNode node)`
`Class<?>`	`getInternalClass()`
`JAXXContextEntryDef<?>`	`getJaxxContextEntryDef()`
`String`	`getJaxxContextEntryPath()`
`String`	`getNodePath()`
`NavigationTreeNode`	`getParent()`
`NavigationTreeNode[]`	`getPath()`
`String`	`getPathSeparator()`
`NavigationTreeNode[]`	`getPathToRoot(NavigationTreeNode aNode, int depth)`
`NavigationNodeRenderer`	`getRenderer()`
`Class<? extends JAXXObject>`	`getUIClass()`
`Class<? extends JAXXAction>`	`getUIHandlerClass()`
`void`	`insert(NavigationTreeNode child, int index)`
`void`	`reload(JAXXContext context)`
`void`	`remove(NavigationTreeNode node)`
`void`	`setBean(Object bean)`
`void`	`setInternalClass(Class<?> internalClass)`
`void`	`setJaxxContextEntryDef(JAXXContextEntryDef<?> jaxxContextEntryDef)`
`void`	`setJaxxContextEntryPath(String jaxxContextEntryPath)`
`void`	`setNodePath(String navigationPath)`
`void`	`setParent(NavigationTreeNode newParent)`
`void`	`setRenderer(NavigationNodeRenderer renderer)`
`void`	`setUIClass(Class<? extends JAXXObject> uIClass)`
`void`	`setUIHandlerClass(Class<? extends JAXXAction> uIHandlerClass)`

Methods inherited from class javax.swing.tree.DefaultMutableTreeNode
add, breadthFirstEnumeration, clone, depthFirstEnumeration, getAllowsChildren, getChildAfter, getChildBefore, getChildCount, getDepth, getFirstChild, getFirstLeaf, getIndex, getLastChild, getLastLeaf, getLeafCount, getLevel, getNextLeaf, getNextNode, getNextSibling, 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, toString

Methods inherited from class javax.swing.tree.DefaultMutableTreeNode

add, breadthFirstEnumeration, clone, depthFirstEnumeration, getAllowsChildren, getChildAfter, getChildBefore, getChildCount, getDepth, getFirstChild, getFirstLeaf, getIndex, getLastChild, getLastLeaf, getLeafCount, getLevel, getNextLeaf, getNextNode, getNextSibling, 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, toString

Methods inherited from class java.lang.Object
`equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Methods inherited from interface jaxx.runtime.swing.navigation.NavigationNode
`getAllowsChildren, getChildCount, getUserObject, isLeaf, isRoot, remove, removeFromParent, setUserObject`

Field Detail

pathSeparator

protected final String pathSeparator

The path separator used to build the fullPath.

See Also:: path, fullPath

path

protected String path

The node path.

Used to build the fullPath which gives a unique identifier of the node.

See Also:: pathSeparator, fullPath

fullPath

protected String fullPath

The full path for the node from the rood node.

This path is build by appending nodes path from the root node to this node, between each path we introduce the pathSeparator.

Exemple :

 root
   $root
    `-- child1
         `-- child2

will given $root/child1/child2.

See Also:: pathSeparator, path

uIClass

protected Class<? extends JAXXObject> uIClass

The UI class associated with the node.

This class can be null, in that case, the AbstractNavigationModelBuilder.defaultUIClass will be used while building the model.

uIHandlerClass

protected Class<? extends JAXXAction> uIHandlerClass

The UI handler class associated with the node.

This class can be null, in that case, the AbstractNavigationModelBuilder.defaultUIHandlerClass will be used while building the model.

jaxxContextEntryDef

protected JAXXContextEntryDef<?> jaxxContextEntryDef

The context entry definition to retrieve the bean.

Note: If not set - the bean will be retrieve on a ancestor node.

jaxxContextEntryPath

protected String jaxxContextEntryPath

The jxPath to process to obtain real bean from the data retrieve in the context.

Note: If not set -no jxpath will be apply on the bean from context.

bean

protected transient Object bean

The bean associated with the node ( the value can be obtain via the method getBean(JAXXContext) or directly set via method setBean(Object).

cache of bean associated with bean to improve performance

internalClass

protected Class<?> internalClass

The type of the related bean associated with the node.

Note: This type is here to override the NodeRenderer internalClass, since we could need to override this data.

If this property is let to null, then we will use the NodeRenderer one

Constructor Detail