jdepend.swingui
Class DependTreeModel

java.lang.Object
  jdepend.swingui.DependTreeModel

All Implemented Interfaces:

javax.swing.tree.TreeModel

public class DependTreeModel
extends java.lang.Object
implements javax.swing.tree.TreeModel

The DependTreeModel class defines the data model being observed by a DependTree instance.

Author:

Mike Clark, Clarkware Consulting, Inc.

Constructor Summary

DependTreeModel(PackageNode root)
Constructs a DependTreeModel with the specified root package node.

Method Summary

void	addTreeModelListener(javax.swing.event.TreeModelListener l) Adds a listener for the TreeModelEvent posted after the tree changes.
java.lang.Object	getChild(java.lang.Object parent, int index) Returns the child of the specified parent at the specified index in the parent's child collection.
int	getChildCount(java.lang.Object parent) Returns the number of children for the specified parent.
int	getIndexOfChild(java.lang.Object parent, java.lang.Object child) Returns the index of the specified child within the specified parent.
java.lang.Object	getRoot() Returns the root of the tree.
boolean	isLeaf(java.lang.Object o) Determines whether the specified tree node is a leaf node.
void	removeTreeModelListener(javax.swing.event.TreeModelListener l) Removes a listener for TreeModelEvents.
void	valueForPathChanged(javax.swing.tree.TreePath path, java.lang.Object newValue) Callback method triggered when the value for the item specified by path has changed to newValue .

Methods inherited from class java.lang.Object

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

Constructor Detail

DependTreeModel

public DependTreeModel(PackageNode root)

Constructs a DependTreeModel with the specified root package node.

Parameters:

root - Root package node.

Method Detail

getRoot

public java.lang.Object getRoot()

Returns the root of the tree.

Specified by:

getRoot in interface javax.swing.tree.TreeModel

Returns:

The root of the tree, or null if the tree has no nodes.

getChild

public java.lang.Object getChild(java.lang.Object parent,
                                 int index)

Returns the child of the specified parent at the specified index in the parent's child collection.

The specified parent must be a node previously obtained from this data source.

Specified by:

getChild in interface javax.swing.tree.TreeModel

Parameters:

parent - A node in the tree, obtained from this data source.

index - Index of child in the parent's child collection.

Returns:

Child.

getChildCount

public int getChildCount(java.lang.Object parent)

Returns the number of children for the specified parent.

The specified parent must be a node previously obtained from this data source.

Specified by:

getChildCount in interface javax.swing.tree.TreeModel

Parameters:

parent - A node in the tree, obtained from this data source.

Returns:

The number of children of the specified parent, or 0 if the parent is a leaf node or if it has no children.

isLeaf

public boolean isLeaf(java.lang.Object o)

Determines whether the specified tree node is a leaf node.

Specified by:

isLeaf in interface javax.swing.tree.TreeModel

Parameters:

o - A node in the tree, obtained from this data source.

Returns:

true if the node is a leaf; false otherwise.

valueForPathChanged

public void valueForPathChanged(javax.swing.tree.TreePath path,
                                java.lang.Object newValue)

Callback method triggered when the value for the item specified by path has changed to newValue .

Specified by:

valueForPathChanged in interface javax.swing.tree.TreeModel

Parameters:

path - Path to the node that has changed.

newValue - The new value of the node.

getIndexOfChild

public int getIndexOfChild(java.lang.Object parent,
                           java.lang.Object child)

Returns the index of the specified child within the specified parent.

Specified by:

getIndexOfChild in interface javax.swing.tree.TreeModel

Parameters:

parent - Parent node.

child - Child node.

Returns:

Index of child within parent.

addTreeModelListener

public void addTreeModelListener(javax.swing.event.TreeModelListener l)

Adds a listener for the TreeModelEvent posted after the tree changes.

Specified by:

addTreeModelListener in interface javax.swing.tree.TreeModel

Parameters:

l - The listener to add.

removeTreeModelListener

public void removeTreeModelListener(javax.swing.event.TreeModelListener l)

Removes a listener for TreeModelEvents.

Specified by:

removeTreeModelListener in interface javax.swing.tree.TreeModel

Parameters:

l - The listener to remove.