Package org.cytoscape.event

Class AbstractCyEvent<T>

java.lang.Object
org.cytoscape.event.AbstractCyEvent<T>
Type Parameters:
T - the generic type of the AbstractCyEvent.
All Implemented Interfaces:
CyEvent<T>
Direct Known Subclasses:
AboutToRemoveColumnViewEvent, AboutToRemoveEdgesEvent, AboutToRemoveNodesEvent, AbstractCyPayloadEvent, AddedColumnViewEvent, AppsFinishedStartingEvent, ColumnCreatedEvent, ColumnDeletedEvent, ColumnNameChangedEvent, ColumnVisualStyleSetEvent, CyShutdownEvent, CyStartEvent, CytoPanelComponentSelectedEvent, CytoPanelStateChangedEvent, DataImportFinishedEvent, 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, RowsDeletedEvent, SearchFinishedEvent, SelectedNodesAndEdgesEvent, SessionAboutToBeLoadedEvent, SessionAboutToBeSavedEvent, SessionLoadCancelledEvent, SessionLoadedEvent, SessionSaveCancelledEvent, SessionSavedEvent, SetCurrentNetworkEvent, SetCurrentNetworkViewEvent, SetCurrentRenderingEngineEvent, SetCurrentTableEvent, SetCurrentVisualStyleEvent, SetNetworkPointerEvent, SetSelectedNetworksEvent, SetSelectedNetworkViewsEvent, TableAboutToBeDeletedEvent, TableAddedEvent, TableDeletedEvent, TablePrivacyChangedEvent, TableTitleChangedEvent, TableViewAboutToBeDestroyedEvent, TableViewAddedEvent, TableViewDestroyedEvent, UnsetNetworkPointerEvent, UpdateNetworkPresentationEvent, VisualPropertyDependencyChangedEvent, VisualStyleAboutToBeRemovedEvent, VisualStyleAddedEvent, VisualStyleSetEvent
public abstract class AbstractCyEvent<T> extends Object implements CyEvent<T>
A base implementation of CyEvent that can be used by events.

Cytoscape Backwards Compatibility (Abstract Class): This class is abstract and meant to be extended by users. This means that we may add methods for minor version updates. Methods will only be removed 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>

  • Constructor Details

    • AbstractCyEvent

      public AbstractCyEvent​(T source, Class<?> listenerClass)
      Constructor.
      Parameters:
      source - The source object that fires the event. May NOT be null.
      listenerClass - The Class that defines the listener interface. May NOT be null.

  • Method Details

    • getSource

      public T getSource()
      The object that fired the event.
      Specified by:
      getSource in interface CyEvent<T>
      Returns:
      The object that fired the event.

    • getListenerClass

      public Class<?> getListenerClass()
      The Class of the listener that is expected to handle this event.
      Specified by:
      getListenerClass in interface CyEvent<T>
      Returns:
      The Class of the listener that is expected to handle this event.