classpathhelper.util
Interface ITreeRoot

All Superinterfaces:

ITree

All Known Implementing Classes:

AbstractTreeRoot

public interface ITreeRoot

extends ITree

Root of a tree of ITree nodes. The root extends an ITree by providing the location where a listener can register for events.

Since:

1.0

Author:

bharris

Method Summary

void	addTreeNodeChangeListener(ITreeNodeChangeListener listener) Adds a listener for node changes
void	addTreeStructureChangeListener(ITreeStructureChangeListener listener) Adds a listener for tree structure changes.
void	fireTreeNodeChangeEvent(ITree[] nodes) Method that fires a node change event.
void	fireTreeNodeChangeEvent(ITree[] nodes, java.lang.String[][] properties) Method that fires a node change event.
void	fireTreeStructureAddEvent(ITree parent, ITree[] children) Method that fires a tree structure add event.
void	fireTreeStructureAddEvent(ITree parent, java.lang.String[] properties, ITree[] children) Method that fires a tree structure add event.
void	fireTreeStructureRemoveEvent(ITree parent, ITree[] children) Method that fires a tree structure remove event.
boolean	removeTreeNodeChangeListener(ITreeNodeChangeListener listener) Removes a tree node change listener
boolean	removeTreeStructureChangeListener(ITreeStructureChangeListener listener) Removes a tree structure listener.

Methods inherited from interface classpathhelper.util.ITree

getChildren, getIconName, getParent, hasChildren

Method Detail

addTreeStructureChangeListener

public void addTreeStructureChangeListener(ITreeStructureChangeListener listener)

Adds a listener for tree structure changes.

Parameters:

listener - the listener.

Since:

1.0

removeTreeStructureChangeListener

public boolean removeTreeStructureChangeListener(ITreeStructureChangeListener listener)

Removes a tree structure listener.

Parameters:

listener - The listener to remove.

Returns:

true if the listener was found and removed, otherwise false.

Since:

1.0

addTreeNodeChangeListener

public void addTreeNodeChangeListener(ITreeNodeChangeListener listener)

Adds a listener for node changes

Parameters:

listener - The listener.

Since:

1.0

removeTreeNodeChangeListener

public boolean removeTreeNodeChangeListener(ITreeNodeChangeListener listener)

Removes a tree node change listener

Parameters:

listener - The listener to remove.

Returns:

true if the listener was found and removed, otherwise false.

Since:

1.0

fireTreeStructureAddEvent

public void fireTreeStructureAddEvent(ITree parent,
                                      ITree[] children)

Method that fires a tree structure add event.

Parameters:

parent - The node which had children added.

children - The children added to parent.

Since:

1.0

fireTreeStructureAddEvent

public void fireTreeStructureAddEvent(ITree parent,
                                      java.lang.String[] properties,
                                      ITree[] children)

Method that fires a tree structure add event.

Parameters:

parent - The node which had children added.

properties - A list of properties in the parent that have changed with this children adding or null if no properties where affected.

children - The children added to parent.

Since:

1.1

fireTreeStructureRemoveEvent

public void fireTreeStructureRemoveEvent(ITree parent,
                                         ITree[] children)

Method that fires a tree structure remove event.

Parameters:

parent - The node which had children removed.

children - The children removed from the parent.

Since:

1.0

fireTreeNodeChangeEvent

public void fireTreeNodeChangeEvent(ITree[] nodes)

Method that fires a node change event.

Parameters:

nodes - The nodes whose state has changed.

Since:

1.0

fireTreeNodeChangeEvent

public void fireTreeNodeChangeEvent(ITree[] nodes,
                                    java.lang.String[][] properties)

Method that fires a node change event.

Parameters:

nodes - The nodes whose state has changed.

properties - The properties that changed for each node.

Since:

1.1