Class SessionLoadedEvent

java.lang.Object
org.cytoscape.event.AbstractCyEvent<CySessionManager>
org.cytoscape.session.events.SessionLoadedEvent
All Implemented Interfaces:
CyEvent<CySessionManager>

public final class SessionLoadedEvent extends AbstractCyEvent<CySessionManager>
This event is fired after a new session has been set in the CySessionManager.setCurrentSession(CySession, String) method and is used to notify interested parties in the change of state.

Cytoscape Backwards Compatibility (Final Class): This class is final and therefore can't 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: session-api

To use this in your app, include the following dependency in your POM:

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>session-api</artifactId>
</dependency>
  • Constructor Details

    • SessionLoadedEvent

      public SessionLoadedEvent(CySessionManager source, CySession session, String fileName)
      Parameters:
      source - The CySessionManager that is the source of this event.
      session - The CySession object that was just loaded.
      fileName - the name of the file representing the session.
  • Method Details

    • getLoadedSession

      public CySession getLoadedSession()
      Returns the session that was just loaded.
      Returns:
      The session that was just loaded.
    • getLoadedFileName

      public String getLoadedFileName()
      Returns the file name of the session just loaded.
      Returns:
      The file name of the session just loaded.