com.starteam.events
Class ItemEvent

java.lang.Object
  extended by java.util.EventObject
      extended by com.starteam.events.ItemEvent
All Implemented Interfaces:
java.io.Serializable

public final class ItemEvent
extends java.util.EventObject

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

See Also:
ItemListener, View.addItemListener(com.starteam.events.IItemListener, com.starteam.Item.Type), Folder.addItemListener(com.starteam.events.IItemListener, com.starteam.Item.Type, int), ViewMemberListManager.addItemListener(com.starteam.events.IItemListener), Serialized Form

Method Summary
 Item getNewItem()
          Gets the Item in its new state.
 Item getOldItem()
          Gets the Item in its old state.
 java.lang.String toString()
          Gets a short description of this ItemEvent.
 
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

getNewItem

public Item getNewItem()
Gets the Item in its new state.

Used in itemAdded(), itemMoved() and itemChanged() events. In itemRemoved() events, getNewItem() returns null.

Item.getParentItem() will return a valid parent Folder object. For performance reasons, the same Folder object may be modified and re-used in subsequent events. If an application wants to modify the Folder, or save its state for later use, it should make its own private copy.

If an application wants to refresh the Items associated with the original Folder object, it must do so by explicitly calling Folder.refreshItems().

Returns:
The Item in its new state.
See Also:
ItemEvent.getOldItem(), Item, Folder.refreshItems(com.starteam.Item.Type, com.starteam.PropertyCollection, int)

getOldItem

public Item getOldItem()
Gets the Item in its old state.

Used in itemChanged(), itemMoved() and itemRemoved() events. In itemAdded() events, getOldItem() returns null.

Item.getParentItem() will return a valid parent Folder object. For performance reasons, the same Folder object may be modified and re-used in subsequent events. If an application wants to modify the Folder, or save its state for later use, it should make its own private copy.

Returns:
The Item in its old state.
See Also:
ItemEvent.getNewItem(), Item

toString

public java.lang.String toString()
Gets a short description of this ItemEvent.

Overrides:
toString in class java.util.EventObject
Returns:
A short description of this ItemEvent.


StarTeam SDK 14.0, Build 21
Copyright © 2003-2012 Borland Software Corporation. All rights reserved.