|
Cytoscape 3.1.1 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.cytoscape.event.AbstractCyEvent<CySessionManager>
org.cytoscape.session.events.SessionAboutToBeSavedEvent
public final class SessionAboutToBeSavedEvent
This event is fired synchronously by the CySessionManager
at beginning of the
CySessionManager.getCurrentSession()
method. The intent is to allow
listeners to provide information to this event object or to update their
state before that state is interrogated by the CySessionManager.
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 Summary | |
---|---|
SessionAboutToBeSavedEvent(CySessionManager source)
Constructor. |
Method Summary | |
---|---|
void |
addAppFiles(String appName,
List<File> files)
A method that allows apps to specify a list of files that should be stored in the session. |
Map<String,List<File>> |
getAppFileListMap()
This method is not meant to be used by listeners for this event, although you can and no harm should come to you. |
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 |
---|
public SessionAboutToBeSavedEvent(CySessionManager source)
source
- The CySessionManager
that will be saving the session.Method Detail |
---|
public void addAppFiles(String appName, List<File> files) throws Exception
appName
- The name of the app that these files should be stored for.files
- The list of File objects to be stored in the session file.
Exception
public Map<String,List<File>> getAppFileListMap()
CySessionManager
to retrieve the list of files from
apps.
|
Cytoscape 3.1.1 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |