com.starteam.events

Class FolderEvent

java.lang.Object

java.util.EventObject

com.starteam.events.FolderEvent

All Implemented Interfaces:

java.io.Serializable

public final class FolderEvent
extends java.util.EventObject

An event triggered whenever a Folder is added, moved, changed or deleted in a View. An application must enable MPX to receive this event

See Also:

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

Method Summary

Modifier and Type	Method and Description
Folder	getNewFolder() Gets the Folder in its new state.
Folder	getOldFolder() Gets the Folder in its old state.
java.lang.String	toString() Gets a short description of this FolderEvent.

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

getNewFolder

public Folder getNewFolder()

Gets the Folder in its new state.

Used in folderAdded(), folderMoved() and folderChanged() events. In folderRemoved() events, getNewFolder() null.

Returns a 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 correct as of the time the event was triggered. In fact, the entire Folder hierarchy is valid. For performance reasons, these same Folder objects may be modified and 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 make its own private 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 Folder in its new state.

See Also:

FolderEvent.getOldFolder(), Folder, View.refreshFolders()

getOldFolder

public Folder getOldFolder()

Gets the Folder in its old state.

Used in folderChanged(), folderMoved() and folderRemoved() events. In folderAdded() events, getOldFolder() returns null.

Returns a 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 correctly represent the old state of the folder. In fact, the entire Folder hierarchy is valid. For performance reasons, these same Folder objects may be modified and 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 make its own private copy.

Returns:

The Folder in its old state.

See Also:

FolderEvent.getNewFolder(), Folder

toString

public java.lang.String toString()

Gets a short description of this FolderEvent.

Overrides:

toString in class java.util.EventObject

Returns:

A short description of this FolderEvent.