ch.randelshofer.tree

Interface NodeInfo

All Known Implementing Classes:

AbstractNodeInfo, DefaultNodeInfo, FileNodeInfo, ManyEyesNodeInfo, TreevizFileSystemXMLNodeInfo, XMLNodeInfo

public interface NodeInfo

NodeInfo is used to interpret the data stored in a TreeNode.

All methods of NodeInfo take a path to a node as a parameter. This allows to get an interperation of a node based on more criteria than just on the node alone.

Version:

1.2 2011-01-11 Adds support for actions.
1.1 2008-07-04 Adds support for change listeners.
1.0 September 21, 2007 Created.

Author:

Werner Randelshofer

Method Summary

Methods

Modifier and Type	Method and Description
void	addChangeListener(javax.swing.event.ChangeListener l)
javax.swing.Action[]	getActions(TreePath2<TreeNode> path) Returns actions for the specified node.
java.awt.Color	getColor(TreePath2<TreeNode> path) Returns the color of the node.
Colorizer	getColorizer()
long	getCumulatedWeight(TreePath2<TreeNode> path) Returns the cumulated weight of a node (the sum of the weights of this node and of all its children).
java.awt.Image	getImage(TreePath2<TreeNode> path) Returns the image of the node.
java.lang.String	getName(TreePath2<TreeNode> path) Returns the name of the node.
java.lang.String	getTooltip(TreePath2<TreeNode> path) Returns the tooltip of the node.
long	getWeight(TreePath2<TreeNode> path) Returns the weight of a node.
Weighter	getWeighter()
java.lang.String	getWeightFormatted(TreePath2<TreeNode> path) Returns the string formatted weight of a node.
void	init(TreeNode root) Initializes the node info.
void	removeChangeListener(javax.swing.event.ChangeListener l)
void	toggleColorWeighter()

Method Detail

init

void init(TreeNode root)

Initializes the node info.

Parameters:

root -

getName

java.lang.String getName(TreePath2<TreeNode> path)

Returns the name of the node.

getColor

java.awt.Color getColor(TreePath2<TreeNode> path)

Returns the color of the node.

getWeight

long getWeight(TreePath2<TreeNode> path)

Returns the weight of a node.

Returns:

The weight between 0 and Double.MAX_VALUE.

getCumulatedWeight

long getCumulatedWeight(TreePath2<TreeNode> path)

Returns the cumulated weight of a node (the sum of the weights of this node and of all its children).

Returns:

The weight between 0 and Double.MAX_VALUE.

getWeightFormatted

java.lang.String getWeightFormatted(TreePath2<TreeNode> path)

Returns the string formatted weight of a node.

getTooltip

java.lang.String getTooltip(TreePath2<TreeNode> path)

Returns the tooltip of the node.

getActions

javax.swing.Action[] getActions(TreePath2<TreeNode> path)

Returns actions for the specified node.

Returns:

An array of action objects. Returns an empty array if no actions are available. Never returns null.

getImage

java.awt.Image getImage(TreePath2<TreeNode> path)

Returns the image of the node.

getWeighter

Weighter getWeighter()

getColorizer

Colorizer getColorizer()

addChangeListener

void addChangeListener(javax.swing.event.ChangeListener l)

removeChangeListener

void removeChangeListener(javax.swing.event.ChangeListener l)

toggleColorWeighter

void toggleColorWeighter()