org.cytoscape.view.presentation

Interface RenderingEngineManager

public interface RenderingEngineManager

Manager for RenderingEngine objects. All RenderingEngine objects created by RenderingEngineFactory should be registered to this manager.

Register/unregister engines are handled through RenderingEngineAddedEvents.

Cytoscape Backwards Compatibility (API Interface): We expect that this interface will be used but not implemented by developers using this interface. As such, we reserve the right to add methods to the interface as part of minor version upgrades. We will not remove methods for any changes other than major version upgrades.

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>

Method Summary

Modifier and Type	Method and Description
void	addRenderingEngine(RenderingEngine<?> engine) Add new RenderingEngine to this manager.
Collection<RenderingEngine<?>>	getAllRenderingEngines() Get all RenderingEngines registered in this manager.
VisualLexicon	getDefaultVisualLexicon() Provide default VisualLexicon from a default engine factory.
Collection<RenderingEngine<?>>	getRenderingEngines(View<?> viewModel) Get rendering engines for the given view model.
void	removeRenderingEngine(RenderingEngine<?> engine) Remove a rendering engine.

Method Detail

getDefaultVisualLexicon

VisualLexicon getDefaultVisualLexicon()

Provide default VisualLexicon from a default engine factory. In current implementation, this is always DING's lexicon.

Returns:

default VisualLexicon.

getRenderingEngines

Collection<RenderingEngine<?>> getRenderingEngines(View<?> viewModel)

Get rendering engines for the given view model.

Parameters:

viewModel - View model for the presentation.

Returns:

Rendering engines (presentations) associated with the view model.

getAllRenderingEngines

Collection<RenderingEngine<?>> getAllRenderingEngines()

Get all RenderingEngines registered in this manager.

Returns:

all rendering engines.

addRenderingEngine

void addRenderingEngine(RenderingEngine<?> engine)

Add new RenderingEngine to this manager.

This method fires RenderingEngineAddedEvent.

Parameters:

engine - New engine to be added.

removeRenderingEngine

void removeRenderingEngine(RenderingEngine<?> engine)

Remove a rendering engine.

This method fires RenderingEngineAboutToBeRemovedEvent.

Parameters:

engine - engine to be removed.