Package org.cytoscape.event

Interface CyEvent<T>

Type Parameters:
T - the generic type of the CyEvent.
All Known Subinterfaces:
CyPayloadEvent<S,P>
All Known Implementing Classes:
AboutToRemoveColumnViewEvent, AboutToRemoveEdgesEvent, AboutToRemoveEdgeViewsEvent, AboutToRemoveNodesEvent, AboutToRemoveNodeViewsEvent, AboutToRemoveRowViewsEvent, AbstractCyEvent, AbstractCyPayloadEvent, AddedColumnViewEvent, AddedEdgesEvent, AddedEdgeViewsEvent, AddedNodesEvent, AddedNodeViewsEvent, AddedRowViewsEvent, AppsFinishedStartingEvent, ColumnAssociatedVisualStyleSetEvent, ColumnCreatedEvent, ColumnDeletedEvent, ColumnNameChangedEvent, ColumnVisualStyleSetEvent, CyShutdownEvent, CyShutdownRequestedEvent, CyStartEvent, CytoPanelComponentSelectedEvent, CytoPanelStateChangedEvent, DataImportFinishedEvent, EquationFunctionAddedEvent, EquationFunctionRemovedEvent, FitContentEvent, FitSelectedEvent, GroupAboutToBeDestroyedEvent, GroupAboutToBeRemovedEvent, GroupAboutToCollapseEvent, GroupAddedEvent, GroupAddedToNetworkEvent, GroupCollapsedEvent, GroupEdgesAddedEvent, GroupEdgesRemovedEvent, GroupNodesAddedEvent, GroupNodesRemovedEvent, LexiconStateChangedEvent, NetworkAboutToBeDestroyedEvent, NetworkAddedEvent, NetworkDestroyedEvent, NetworkViewAboutToBeDestroyedEvent, NetworkViewAddedEvent, NetworkViewDestroyedEvent, PreferencesUpdatedEvent, PropertyUpdatedEvent, RemovedEdgesEvent, RemovedNodesEvent, RenderingEngineAboutToBeRemovedEvent, RenderingEngineAddedEvent, RowsCreatedEvent, RowsDeletedEvent, RowsSetEvent, SearchFinishedEvent, SelectedNodesAndEdgesEvent, SessionAboutToBeLoadedEvent, SessionAboutToBeSavedEvent, SessionLoadCancelledEvent, SessionLoadedEvent, SessionSaveCancelledEvent, SessionSavedEvent, SetCurrentNetworkEvent, SetCurrentNetworkViewEvent, SetCurrentRenderingEngineEvent, SetCurrentTableEvent, SetCurrentVisualStyleEvent, SetNetworkPointerEvent, SetSelectedNetworksEvent, SetSelectedNetworkViewsEvent, TableAboutToBeDeletedEvent, TableAddedEvent, TableDeletedEvent, TablePrivacyChangedEvent, TableTitleChangedEvent, TableViewAboutToBeDestroyedEvent, TableViewAddedEvent, TableViewChangedEvent, TableViewDestroyedEvent, UnsetNetworkPointerEvent, UpdateNetworkPresentationEvent, ViewChangedEvent, VisualMappingFunctionChangedEvent, VisualPropertyDependencyChangedEvent, VisualStyleAboutToBeRemovedEvent, VisualStyleAddedEvent, VisualStyleChangedEvent, VisualStyleSetEvent
public interface CyEvent<T>
All Cytoscape events should extend this interface. An implementing event can add additional methods to provide access to information relevant to that specific event.

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.

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>

  • Method Summary

    Modifier and Type
    Method
    Description
    Class<?>
    getListenerClass()
    The Class of the listener that is expected to handle this event.
    T
    getSource()
    The object that fired the event.

  • Method Details

    • getSource

      T getSource()
      The object that fired the event.
      Returns:
      The object that fired the event.

    • getListenerClass

      Class<?> getListenerClass()
      The Class of the listener that is expected to handle this event.
      Returns:
      The Class of the listener that is expected to handle this event.