- Type Parameters:
S - The event source type.P - The payload type.
- All Superinterfaces:
- CyEvent<S>
- 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.
Module: event-api
To use this in your app, include the following dependency in your POM:
<dependency>
<groupId>org.cytoscape</groupId>
<artifactId>event-api</artifactId>
</dependency>
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.