org.cytoscape.view.presentation.events

Class RenderingEngineAddedEvent

java.lang.Object

org.cytoscape.event.AbstractCyEvent<RenderingEngineManager>

org.cytoscape.view.presentation.events.RenderingEngineAddedEvent

All Implemented Interfaces:

CyEvent<RenderingEngineManager>

public final class RenderingEngineAddedEvent
extends AbstractCyEvent<RenderingEngineManager>

When new presentation is created, its factory always creates a RenderingEngine). The engine should be added to RenderingEngineManager and it fires this event.

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: 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>

Constructor Summary

Constructors

Constructor and Description
RenderingEngineAddedEvent(RenderingEngineManager source, RenderingEngine<?> engine) Create an event for newly created presentation.

Method Summary

Modifier and Type	Method and Description
RenderingEngine<?>	getRenderingEngine() Get new rendering engine.

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

RenderingEngineAddedEvent

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

Create an event for newly created presentation.

Parameters:

source - manager holding reference to this new rendering engine

engine - New RenderingEngine just created.

Method Detail

getRenderingEngine

public RenderingEngine<?> getRenderingEngine()

Get new rendering engine.

Returns:

new rendering engine.