Search this API

y.module
Class OrganicEdgeRouterModule

java.lang.Object
  extended by y.module.YModule
      extended by y.module.LayoutModule
          extended by y.module.OrganicEdgeRouterModule

public class OrganicEdgeRouterModule
extends LayoutModule

This module represents an interactive configurator and launcher for OrganicEdgeRouter.

 

Field Summary
protected static java.lang.String ITEM_ALLOW_MOVING_NODES
           
protected static java.lang.String ITEM_MINIMAL_NODE_DISTANCE
           
protected static java.lang.String ITEM_ROUTE_ONLY_NECESSARY
           
protected static java.lang.String ITEM_SELECTION_ONLY
           
protected static java.lang.String ITEM_USE_BENDS
           
protected static java.lang.String MODULE_ORGANIC_EDGE_ROUTER
           
protected static java.lang.String TITLE_LAYOUT_OPTIONS
           
 
Fields inherited from class y.module.YModule
FAILED, moduleListenerSupport, PRECONDITION_VIOLATED, SUCCESS
 
Constructor Summary
OrganicEdgeRouterModule()
          Creates an instance of this module.
 
Method Summary
protected  void configure(OrganicEdgeRouter organic, OptionHandler options)
          Configures the module's layout algorithm according to the given options.
protected  OptionHandler createOptionHandler()
          Creates an OptionHandler and adds the option items used by this module.
protected  void mainrun()
          Main module execution routine.
protected  void prepareGraph(Graph2D graph, OptionHandler options)
          Prepares a graph depending on the given options for the module's layout algorithm.
protected  void restoreGraph(Graph2D graph, OptionHandler options)
          Restores the given graph by freeing up resources created by prepareGraph(y.view.Graph2D, y.option.OptionHandler).
 
Methods inherited from class y.module.LayoutModule
backupDataProvider, createAnimationPlayer, createLayoutExecutor, createLayoutMorpher, getBufferedMode, getLayoutExecutor, isAbortable, isMorphingEnabled, isPortIntersectionCalculatorEnabled, launchLayouter, launchLayouter, restoreDataProvider, setBufferedMode, setLayoutExecutor, setMorphingEnabled, setPortIntersectionCalculatorEnabled, useEventDispatchThread
 
Methods inherited from class y.module.YModule
addModuleListener, createThread, dispose, exceptionHappened, fitGraph2DView, getAuthor, getDescription, getExitStatus, getGraph2D, getGraph2DView, getModuleListeners, getModuleName, getOptionHandler, getTimer, getView, init, initGuiFactory, isBackupRealizersEnabled, removeModuleListener, run, setBackupRealizersEnabled, setExitStatus, setGraph2D, setModuleName, setOptionHandler, start, startAsThread
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MODULE_ORGANIC_EDGE_ROUTER

protected static final java.lang.String MODULE_ORGANIC_EDGE_ROUTER
See Also:
Constant Field Values

TITLE_LAYOUT_OPTIONS

protected static final java.lang.String TITLE_LAYOUT_OPTIONS
See Also:
Constant Field Values

ITEM_SELECTION_ONLY

protected static final java.lang.String ITEM_SELECTION_ONLY
See Also:
Constant Field Values

ITEM_MINIMAL_NODE_DISTANCE

protected static final java.lang.String ITEM_MINIMAL_NODE_DISTANCE
See Also:
Constant Field Values

ITEM_USE_BENDS

protected static final java.lang.String ITEM_USE_BENDS
See Also:
Constant Field Values

ITEM_ROUTE_ONLY_NECESSARY

protected static final java.lang.String ITEM_ROUTE_ONLY_NECESSARY
See Also:
Constant Field Values

ITEM_ALLOW_MOVING_NODES

protected static final java.lang.String ITEM_ALLOW_MOVING_NODES
See Also:
Constant Field Values
Constructor Detail

OrganicEdgeRouterModule

public OrganicEdgeRouterModule()
Creates an instance of this module.

Method Detail

createOptionHandler

protected OptionHandler createOptionHandler()
Creates an OptionHandler and adds the option items used by this module.

Overrides:
createOptionHandler in class YModule
Returns:
the created OptionHandler providing module related options

mainrun

protected void mainrun()
Main module execution routine. Launches the module's underlying algorithm on the module's graph based on user options.

Specified by:
mainrun in class YModule

prepareGraph

protected void prepareGraph(Graph2D graph,
                            OptionHandler options)
Prepares a graph depending on the given options for the module's layout algorithm.
Additional resources created by this method have to be freed up by calling restoreGraph(y.view.Graph2D, y.option.OptionHandler) after layout calculation.

Parameters:
graph - the graph to be prepared
options - the options for the module's layout algorithm

restoreGraph

protected void restoreGraph(Graph2D graph,
                            OptionHandler options)
Restores the given graph by freeing up resources created by prepareGraph(y.view.Graph2D, y.option.OptionHandler).

Parameters:
graph - the graph for which prepareGraph has been called
options - the options for the module's layout algorithm

configure

protected void configure(OrganicEdgeRouter organic,
                         OptionHandler options)
Configures the module's layout algorithm according to the given options.

Parameters:
organic - the OrganicEdgeRouter to be configured
options - the layout options to set

© Copyright 2000-2021,
yWorks GmbH.
All rights reserved.