Package org.cytoscape.view.presentation
Interface RenderingEngineManager
-
public interface RenderingEngineManagerManager for RenderingEngine objects. All RenderingEngine objects created by RenderingEngineFactory should be registered to this manager.Register/unregister engines are handled through RenderingEngineAddedEvents.
Module:
presentation-apiTo 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 (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.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description voidaddRenderingEngine(RenderingEngine<?> engine)Add newRenderingEngineto this manager.Collection<RenderingEngine<?>>getAllRenderingEngines()Get allRenderingEngines registered in this manager.VisualLexicongetDefaultVisualLexicon()Provide defaultVisualLexiconfrom a default engine factory.Collection<RenderingEngine<?>>getRenderingEngines(View<?> viewModel)Get rendering engines for the given view model.voidremoveRenderingEngine(RenderingEngine<?> engine)Remove a rendering engine.
-
-
-
Method Detail
-
getDefaultVisualLexicon
VisualLexicon getDefaultVisualLexicon()
Provide defaultVisualLexiconfrom 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 allRenderingEngines registered in this manager.- Returns:
- all rendering engines.
-
addRenderingEngine
void addRenderingEngine(RenderingEngine<?> engine)
Add newRenderingEngineto 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.
-
-