Package org.cytoscape.view.presentation

Interface RenderingEngineManager

public interface RenderingEngineManager
Manager for network RenderingEngine objects. All RenderingEngine objects created by RenderingEngineFactory for networks should be registered to this manager.

Register/unregister engines are handled through RenderingEngineAddedEvents.

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 (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 Details

    • getDefaultVisualLexicon

      VisualLexicon getDefaultVisualLexicon()
      Provide default network VisualLexicon from a default engine factory. In current implementation, this is always DING's lexicon. Note: this does not return the visual lexicon used for table styles.
      Returns:
      default network VisualLexicon.

    • getDefaultTableVisualLexicon

      VisualLexicon getDefaultTableVisualLexicon()
      Provide default table VisualLexicon from a default engine factory. In current implementation, this is the lexicon used by the table browser.
      Returns:
      default table 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.