Package org.cytoscape.application.events
Class CyShutdownEvent
An event fired immediately before Cytoscape will be shutdown. This
event provides methods for listeners processing this event to
abort the shutdown. This event should only be fired synchronously
to allow all listeners time to clean up.
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: application-api
To use this in your app, include the following dependency in your POM:
<dependency> <groupId>org.cytoscape</groupId> <artifactId>application-api</artifactId> </dependency>
-
Constructor Summary
ConstructorDescriptionCyShutdownEvent(Object source)
Constructor.CyShutdownEvent(Object source, boolean force)
Constructor. -
Method Summary
Modifier and TypeMethodDescriptionvoid
abortShutdown(String why)
A callback to the firing class that allows a listener to abort the shutdown.Returns the reason that the application should not be shut down.boolean
Returns true if no reason is provided to abort the shutdown and false if anyone processing this event wants to prevent shutdown.boolean
Returns true if we want to force the shutdown without any user promptMethods inherited from class org.cytoscape.event.AbstractCyEvent
getListenerClass, getSource
-
Constructor Details
-
CyShutdownEvent
Constructor.- Parameters:
source
- The object firing this event.force
- If true, force the shutdown (no user prompt)
-
CyShutdownEvent
Constructor.- Parameters:
source
- The object firing this event.
-
-
Method Details
-
abortShutdown
A callback to the firing class that allows a listener to abort the shutdown. This can cause conflicts if abused.- Parameters:
why
- A user comprehensible message describing why the shutdown was aborted.
-
abortShutdownReason
Returns the reason that the application should not be shut down.- Returns:
- The reason that the application should not be shut down.
-
actuallyShutdown
public boolean actuallyShutdown()Returns true if no reason is provided to abort the shutdown and false if anyone processing this event wants to prevent shutdown.- Returns:
- true if no reason is provided to abort the shutdown and false if anyone processing this event wants to prevent shutdown.
-
forceShutdown
public boolean forceShutdown()Returns true if we want to force the shutdown without any user prompt
-