org.cristalise.gui

Class DynamicTreeBuilder

java.lang.Object

org.cristalise.gui.tree.Node

org.cristalise.gui.DynamicTreeBuilder

All Implemented Interfaces:

Runnable, NodeSubscriber

public class DynamicTreeBuilder
extends Node
implements NodeSubscriber

Installed as the user object on a single child node of a new node known to be composite.

Shows 'Loading . . .' when the branch is opened, but a TreeExpansionListener attempts to fire this thread off in the first child node.
When started, this thread will retrieve all of the real child nodes and add them to its parent while removing itself (hopefully for garbage collection)

Version:

$Revision: 1.24 $ $Date: 2004/12/15 12:12:06 $

Author:

$Author: abranson $

Field Summary

Fields

Modifier and Type	Field and Description
static short	FINISHED
static short	IDLE
static short	LOADING
static short	PARTIAL
short	state

Fields inherited from class org.cristalise.gui.tree.Node

binding, childNodes, desktop, icon, isExpandable, itemPath, loader, name, subscribers, toolTip, treeNode, type

Constructor Summary

Constructors

Constructor and Description
DynamicTreeBuilder(DefaultMutableTreeNode parent, ItemTabManager desktop) The newly created DynamicTreeBuilder records its parent node - the one for which it will build child nodes for.

Method Summary

Modifier and Type	Method and Description
void	add(Node newNode)
void	buildInfo(JTree parentTree) Before the tree builder can execute, it needs to be given references to the tree and NodeFactory needed to create the new nodes.
void	end(boolean more)
ImageIcon	getIcon()
DefaultMutableTreeNode	getTreeNode()
void	loadChildren()
void	remove(Path path)
void	start()
String	toString() Used by the JTree to find the text representation of the node.

Methods inherited from class org.cristalise.gui.tree.Node

createTreeNode, getChildNode, getDesktop, getIconName, getItemPath, getName, getPath, getPopupMenu, getToolTip, getTreeBuilder, getType, loadMore, makeExpandable, newNode, refresh, removeAllChildren, run, setIcon, setToolTip, setTreeNode, subscribeNode, unsubscribeNode

Methods inherited from class java.lang.Object

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

Field Detail

state

public short state

IDLE

public static final short IDLE

See Also:

Constant Field Values

LOADING

public static final short LOADING

See Also:

Constant Field Values

PARTIAL

public static final short PARTIAL

See Also:

Constant Field Values

FINISHED

public static final short FINISHED

See Also:

Constant Field Values

Constructor Detail

DynamicTreeBuilder

public DynamicTreeBuilder(DefaultMutableTreeNode parent,
                          ItemTabManager desktop)

The newly created DynamicTreeBuilder records its parent node - the one for which it will build child nodes for.

Parameters:

nodeClicked - The Parent Tree Node that will be populated.

See Also:

NodeItem, TreeDisplay

Method Detail

buildInfo

public void buildInfo(JTree parentTree)

Before the tree builder can execute, it needs to be given references to the tree and NodeFactory needed to create the new nodes.

Parameters:

myNodeFactory - The NodeFactory that can be queried for new NodeItems.

parentTree - The JTree in which this node is currently contained.

start

public void start()

toString

public String toString()

Used by the JTree to find the text representation of the node.

Overrides:

toString in class Node

getIcon

public ImageIcon getIcon()

Overrides:

getIcon in class Node

getTreeNode

public DefaultMutableTreeNode getTreeNode()

Overrides:

getTreeNode in class Node

add

public void add(Node newNode)

Specified by:

add in interface NodeSubscriber

Overrides:

add in class Node

end

public void end(boolean more)

Specified by:

end in interface NodeSubscriber

Overrides:

end in class Node

remove

public void remove(Path path)

Specified by:

remove in interface NodeSubscriber

Overrides:

remove in class Node

loadChildren

public void loadChildren()

Specified by:

loadChildren in class Node