com.starbase.starteam
Interface FolderListener

All Superinterfaces:

java.util.EventListener, IFolderListener

All Known Implementing Classes:

FolderAdapter

public interface FolderListener

extends IFolderListener

Event-listener interface for Folder events.

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

The FolderListener interface provides very detailed information about changes to Folders and the Folder hierarchy. An application may find that the simpler (and less expensive) FolderTreeListener interface is sufficient for its needs.

See Also:

FolderAdapter, FolderTreeListener, View.addFolderListener(com.starbase.starteam.IFolderListener), Folder.addFolderListener(com.starbase.starteam.IFolderListener, int), FolderListManager.addFolderListener(com.starbase.starteam.IFolderListener)

Method Summary

void	folderAdded(FolderEvent e) Invoked when a Folder is added to a view.
void	folderChanged(FolderEvent e) Invoked when the properties of a Folder have changed.
void	folderMoved(FolderEvent e) Invoked when a Folder is moved within a view.
void	folderRemoved(FolderEvent e) Invoked when a Folder is removed from a view.

Method Detail

folderAdded

public void folderAdded(FolderEvent e)

Invoked when a Folder is added to a view.

A folderAdded event is triggered whenever a Folder with a new ItemID appears in the folder tree. This might be because a new folder was created (either directly, or as a result of creating a new project or view); because a folder was moved or shared in from another view; etc.

If a folder is moved from one parent folder to another parent within the same view, then no new Folder items are created. In this case, a folderMoved event is triggered instead of a folderAdded event.

If a folder with subfolders is added to a view (for example, by moving or sharing a subtree from another view), then a folderAdded event is triggered for each folder in the subtree. The folderAdded events for child folders are triggered after the folderAdded event for the parent.

If the logged-in user does not have access rights to see the folder in its new context, then no event is triggered.

For folderAdded events, FolderEvent.getNewFolder() returns the added folder in its new context. FolderEvent.getOldFolder() returns null.

Parameters:

e - The corresponding Folder event.

See Also:

FolderEvent

folderMoved

public void folderMoved(FolderEvent e)

Invoked when a Folder is moved within a view.

A folderMoved event is triggered whenever a Folder (or subtree) is moved from one parent folder to another parent within the same view. In this case, no folders with new ItemIDs are added to the view, and no folders are removed. Thus, when a folderMoved event is triggered, corresponding folderAdded and folderRemoved events will not be triggered.

If a folder exists in a security context where it is not accessible to the current user, then, from that user's point of reference, the folder does not exist. If the folder is then moved to a new parent folder in the same view such that it is now accessible, then, from that user's point of view, the folder has been added, not moved. Thus, in that case, a folderAdded event will be triggered instead of a folderMoved event.

Similarly, if a folder is moved in such a way that it is no longer visible to the current user, a folderRemoved event will be triggered instead of a folderMoved event.

For folderMoved events, FolderEvent.getOldFolder() returns a Folder object representing the folder before it was moved (that is, attached to the old parent folder). FolderEvent.getNewFolder() returns a Folder object representing the folder after it was moved (attached to the new parent).

Parameters:

e - The corresponding Folder event.

See Also:

FolderEvent

folderChanged

public void folderChanged(FolderEvent e)

Invoked when the properties of a Folder have changed.

The changed properties may include Item-level properties (such as ConfigurationTime or BranchOnChange) or Object-level properties that are shared across references (such as Description or ExcludeSpec).

For folderChanged events, FolderEvent.getOldFolder() returns a Folder object representing the folder before its old state (that is, before its properties were changed). FolderEvent.getNewFolder() returns the folder in its new state (after its properties were changed).

Parameters:

e - The corresponding Folder event.

See Also:

FolderEvent

folderRemoved

public void folderRemoved(FolderEvent e)

Invoked when a Folder is removed from a view.

A folderRemoved event is triggered whenever a Folder disappears from the folder tree. This might be because a folder was deleted (either directly, or as a result of deleting a project or view); because a folder was moved to another view; etc.

If a folder is moved from one parent folder to another parent within the same view, then no Folder items are removed. In this case, a folderMoved event is triggered instead of a folderRemoved event.

If a folder with subfolders is removed from a view (for example, by deleting a subtree), then a folderRemoved event is triggered for each folder in the subtree. The folderRemoved events for child folders are triggered before the folderRemoved events for the parent.

For folderRemoved events, FolderEvent.getOldFolder() returns the removed folder in its old context (that is, prior to being removed). FolderEvent.getNewFolder() returns null.

Parameters:

e - The corresponding Folder event.

See Also:

FolderEvent