Package org.cytoscape.application.events

Class SetCurrentRenderingEngineEvent

java.lang.Object

org.cytoscape.event.AbstractCyEvent<CyApplicationManager>

org.cytoscape.application.events.SetCurrentRenderingEngineEvent

All Implemented Interfaces:

CyEvent<CyApplicationManager>

public final class SetCurrentRenderingEngineEvent
extends AbstractCyEvent<CyApplicationManager>

This event signals that a RenderingEngine has been set as current.

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>

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
SetCurrentRenderingEngineEvent(CyApplicationManager source, RenderingEngine<CyNetwork> engine)	Constructor.

Method Summary

Modifier and Type	Method	Description
RenderingEngine<CyNetwork>	getRenderingEngine()	Return the rendering engine (presentation) that has been set as current.

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

SetCurrentRenderingEngineEvent

public SetCurrentRenderingEngineEvent(CyApplicationManager source,
                                      RenderingEngine<CyNetwork> engine)

Constructor.

Parameters:

source - The application manager firing this event.

engine - The rendering engine (presentation) that has been set as current.

Method Detail

getRenderingEngine

public RenderingEngine<CyNetwork> getRenderingEngine()

Return the rendering engine (presentation) that has been set as current.

Returns:

the rendering engine (presentation) that has been set as current.