CMI documentation

com.sap.tc.cmi.util
Interface ICMIObservableListChangeListener


public interface ICMIObservableListChangeListener

Methods a listener must implement to be informed about list changes. This type can be called, extended or implemented by applications or frameworks using CMI.

Version:
$Id: //tc/CommonModelInterface/630_VAL_REL/src/_cmi_api/java/com/sap/tc/cmi/util/ICMIObservableListChangeListener.java#1 $

Method Summary
 void complexChange(CMIObservableListEvent event)
          Event which is fired when the list has changed in a more complex way.
 void elementAdded(CMIObservableListEvent event)
          Event which is fired when a single element is added.
 void elementChanged(CMIObservableListEvent event)
          Event which is fired when a single element is changed.
 void elementRemoved(CMIObservableListEvent event)
          Event which is fired when a single element has been removed.
 

Method Detail

elementAdded

public void elementAdded(CMIObservableListEvent event)
Event which is fired when a single element is added.

The event object must contain the added element, the index where the element has been added (as both fromIndex and toIndex) and the event type must be ELEMENT_ADDED.

This event implies an index change for any existing elements after the inserted element.

Parameters:
event - an event object that describes the added element

elementChanged

public void elementChanged(CMIObservableListEvent event)
Event which is fired when a single element is changed.

Changed means, that the referenced object at an already existing position in the list has changed without modifying the length of the list.

The event object must contain the changed element (old value, new one can be retrieved from event source), the index where the element has been changed (as both fromIndex and toIndex) and the event type must be ELEMENT_CHANGED.

Parameters:
event - an event object that describes the added element

elementRemoved

public void elementRemoved(CMIObservableListEvent event)
Event which is fired when a single element has been removed.

The event object must contain the removed element (old value), the index where the element has been removed (as both fromIndex and toIndex) and the event type must be ELEMENT_REMOVED.

This change implies an index change for any existing elements after the removed element.

Parameters:
event - an event object that describes the added element

complexChange

public void complexChange(CMIObservableListEvent event)
Event which is fired when the list has changed in a more complex way.

The event object must at least contain the event type. Depending on the event type, further data can be supplied. See CMIObservableListEvent for details.

Parameters:
event - an event object that describes the added element

CMI documentation

Copyright © 2002 SAP AG. Automatically generated Thu Mar 3 2005, 21:53