Package org.cytoscape.view.presentation.events

Class RenderingEngineAboutToBeRemovedEvent

java.lang.Object

org.cytoscape.event.AbstractCyEvent<RenderingEngineManager>

org.cytoscape.view.presentation.events.RenderingEngineAboutToBeRemovedEvent

All Implemented Interfaces:

CyEvent<RenderingEngineManager>

public final class RenderingEngineAboutToBeRemovedEvent
extends AbstractCyEvent<RenderingEngineManager>

When presentation (rendered graphics) is destroyed, this event should be fired.

Module: presentation-api

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

<dependency>
    <groupId>org.cytoscape</groupId>
    <artifactId>presentation-api</artifactId>
</dependency>

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

Constructors

Constructor	Description
RenderingEngineAboutToBeRemovedEvent(RenderingEngineManager source, RenderingEngine<?> engine)	Construct an event for destroyed RenderingEngine.

Method Summary

Modifier and Type	Method	Description
RenderingEngine<?>	getRenderingEngine()	Returns the RenderingEngine associated with the deleted presentation.

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

RenderingEngineAboutToBeRemovedEvent

public RenderingEngineAboutToBeRemovedEvent(RenderingEngineManager source,
                                            RenderingEngine<?> engine)

Construct an event for destroyed RenderingEngine.

Parameters:

source - source of event. In theory, this can be anything, but in most cases, it will be an GUI components.

engine - RenderingEngine associated with the deleted presentation.

Method Detail

getRenderingEngine

public RenderingEngine<?> getRenderingEngine()

Returns the RenderingEngine associated with the deleted presentation.

Returns:

the RenderingEngine associated with the deleted presentation.