com.tensegrity.composite.event.view
Class ViewCompositeOrderChangeEvent

java.lang.Object
  com.tensegrity.composite.event.view.AbstractCompositeViewEvent
      com.tensegrity.composite.event.view.ViewCompositeOrderChangeEvent

All Implemented Interfaces:

CompositeRootEvent, CompositeViewEvent

public class ViewCompositeOrderChangeEvent

extends AbstractCompositeViewEvent

A ViewCompositeOrderChangeEvent occurs whenever the internal order of BaseComposite objects changes within a CompositeView.

Version:

$Id$

Author:

MKegel

See Also:

CompositeViewEvent, CompositeViewListener

Field Summary

Fields inherited from class com.tensegrity.composite.event.view.AbstractCompositeViewEvent

composite, composites, compositeView

Constructor Summary

ViewCompositeOrderChangeEvent(CompositeView compositeView, java.util.List composites, java.util.Map composite2PrecursorOld, java.util.Map composite2PrecursorNew)
Constructor for ViewCompositeOrderChangeEvent.

Method Summary

java.util.List	getComposites() Returns the List of BaseComposite objects which have caused the change in the order.
BaseComposite	getPrecursorNew(BaseComposite basecomposite) Returns the new predecessor of the given BaseComposite object or null in case the given BaseComposite object is either the first one in the internal order or is not part of the List returned by getComposites().
BaseComposite	getPrecursorOld(BaseComposite basecomposite) Returns the old predecessor of the given BaseComposite object or null in case the given BaseComposite object was either the first one in the internal order or is not part of the List returned by getComposites().

Methods inherited from class com.tensegrity.composite.event.view.AbstractCompositeViewEvent

getCompositeView

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ViewCompositeOrderChangeEvent

public ViewCompositeOrderChangeEvent(CompositeView compositeView,
                                     java.util.List composites,
                                     java.util.Map composite2PrecursorOld,
                                     java.util.Map composite2PrecursorNew)

Constructor for ViewCompositeOrderChangeEvent.

Parameters:

compositeView - the CompositeView this event should be raised for

composites - the List of BaseComposite objects which have caused the change in the order

Method Detail

getComposites

public final java.util.List getComposites()

Returns the List of BaseComposite objects which have caused the change in the order.

Returns:

List the List of BaseComposite objects which caused the change in the order

getPrecursorOld

public final BaseComposite getPrecursorOld(BaseComposite basecomposite)

Returns the old predecessor of the given BaseComposite object or null in case the given BaseComposite object was either the first one in the internal order or is not part of the List returned by getComposites().

Returns:

BaseComposite the old predecessor or null

getPrecursorNew

public final BaseComposite getPrecursorNew(BaseComposite basecomposite)

Returns the new predecessor of the given BaseComposite object or null in case the given BaseComposite object is either the first one in the internal order or is not part of the List returned by getComposites().

Returns:

BaseComposite the new predecessor or null