Cytoscape 3.0.1 API

org.cytoscape.session.events
Class SessionLoadedEvent

java.lang.Object
  extended by org.cytoscape.event.AbstractCyEvent<CySessionManager>
      extended by 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.

Constructor Summary
SessionLoadedEvent(CySessionManager source, CySession session, String fileName)
          Constructor.
 
Method Summary
 String getLoadedFileName()
          Returns the file name of the session just loaded.
 CySession getLoadedSession()
          Returns the session that was just loaded.
 
Methods inherited from class org.cytoscape.event.AbstractCyEvent
getListenerClass, getSource
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SessionLoadedEvent

public SessionLoadedEvent(CySessionManager source,
                          CySession session,
                          String fileName)
Constructor.

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 Detail

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.

Cytoscape 3.0.1 API

Copyright 2011 Cytoscape Consortium. All rights reserved.