com.starbase.starteam
Interface FolderTreeListener

All Superinterfaces:

java.util.EventListener, IFolderListener

All Known Implementing Classes:

FolderTreeAdapter

public interface FolderTreeListener

extends IFolderListener

FolderTreeListener allows an application to listen for changes to the structure of the folder tree.

A FolderTreeEvent provides access to a small subset of the information available through the more general FolderEvent. However, FolderEvents can be considerably more expensive to generate. So, for applications that just want to know when the folder structure changes, FolderTreeListener is prefered.

Note that an application will not receive FolderTreeEvents for folders that the logged-in user does not have permission to access.

See Also:

FolderTreeAdapter, FolderListener, View.addFolderListener(com.starbase.starteam.IFolderListener), Folder.addFolderListener(com.starbase.starteam.IFolderListener, int), FolderListManager.addFolderListener(com.starbase.starteam.IFolderListener)

Method Summary

void	folderTreeChanged(FolderTreeEvent e) Invoked when the Folder hierarchy has changed.

Method Detail

folderTreeChanged

public void folderTreeChanged(FolderTreeEvent e)

Invoked when the Folder hierarchy has changed. This includes whenever a Folder is added, moved, shared, deleted, etc.

FolderTreeEvent.getFolder() returns the Folder at the root of the affected folder tree. For example, if Folder A has subfolder C, and folder C is moved so that it is instead a subfolder of B, folderTreeChanged events are triggered for Folder A and Folder B.

Applications that are more interested in receiving information about Folder B in this case should instead listen for FolderEvents by registering a FolderListener.

Parameters:

e - The corresponding folder event.

See Also:

FolderTreeEvent