com.starteam.events
Class FolderTreeEvent

java.lang.Object
  java.util.EventObject
      com.starteam.events.FolderTreeEvent

All Implemented Interfaces:

java.io.Serializable

public final class FolderTreeEvent
extends java.util.EventObject

An event triggered whenever the Folder hierarchy is changed in a View.

See Also:

FolderTreeListener, View.addFolderListener(com.starteam.events.IFolderListener), Folder.addFolderListener(com.starteam.events.IFolderListener, int), FolderListManager.addFolderListener(com.starteam.events.IFolderListener), Serialized Form

Method Summary

Folder	getFolder() Gets the Folder at the root of the part of the hierarchy that has changed.
java.lang.String	toString() Gets a short description of this FolderTreeEvent.

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getFolder

public Folder getFolder()

Gets the Folder at the root of the part of the hierarchy that has changed. This is the deepest folder that fully encompasses the change to the folder hierarchy.

Returns a new Folder object that is not a member of any View's folder hierarchy. There may be a Folder in the hierarchy with the same ItemID, but it would be a physically different object that is likely to have different properties.

Folder.getParentFolder() and Folder.getSubFolders() will return values that are up-to-date as of the time the event was triggered. In fact, an application can rely on the entire Folder hierarchy being up-to-date. For performance reasons, these same Folder objects may be re-used in subsequent events. If an application wants to modify one of the Folder objects, or save its state for later use, it should first make a copy.

If an application wants to refresh the Folders associated with the original View object, it must do so by explicitly calling View.refreshFolders().

Returns:

The deepest folder that fully encompasses the change to the folder hierarchy.

See Also:

Folder, View.refreshFolders()

toString

public java.lang.String toString()

Gets a short description of this FolderTreeEvent.

Overrides:

toString in class java.util.EventObject

Returns:

A short description of this FolderTreeEvent.