Cytoscape 3.0.1 API

Interface CyPayloadEvent<S,P>

Type Parameters:
S - The event source type.
P - The payload type.
All Superinterfaces:
All Known Implementing Classes:
AboutToRemoveEdgeViewsEvent, AboutToRemoveNodeViewsEvent, AbstractCyPayloadEvent, AddedEdgesEvent, AddedEdgeViewsEvent, AddedNodesEvent, AddedNodeViewsEvent, RowsCreatedEvent, RowsSetEvent, VisualMappingFunctionChangedEvent, VisualStyleChangedEvent

public interface CyPayloadEvent<S,P>
extends CyEvent<S>

An extension of CyEvent specifically for payload events. A payload event is a single event that contains a collection of payload objects, which represent the state change of the event. Payload events are used in cases where many small changes can be combined into a single event object (such as node creation or table row modification). The goal is to prevent too many events from being fired.

Cytoscape Backwards Compatibility (SPI Interface): We expect that this interface will be implemented. Therefore to maintain backwards compatibility this interface will only be modified for major version updates.

Method Summary
 Collection<P> getPayloadCollection()
          Returns a collection of payload objects.
Methods inherited from interface org.cytoscape.event.CyEvent
getListenerClass, getSource

Method Detail


Collection<P> getPayloadCollection()
Returns a collection of payload objects.

a collection of payload objects.

Cytoscape 3.0.1 API

Copyright 2011 Cytoscape Consortium. All rights reserved.