y.module
Class OrthogonalEdgeRouterModule

java.lang.Object
  y.module.YModule
      y.module.LayoutModule
          y.module.OrthogonalEdgeRouterModule

public class OrthogonalEdgeRouterModule
extends LayoutModule

This module represents an interactive configurator and launcher for OrthogonalEdgeRouter.

See Also:

Section Orthogonal Edge Routing in the yFiles for Java Developer's Guide

Field Summary

protected static java.lang.String	ITEM_CONSIDER_NODE_LABELS
protected static java.lang.String	ITEM_CROSSING_COST
protected static java.lang.String	ITEM_CUSTOM_MINIMUM_DISTANCE_TO_NODE
protected static java.lang.String	ITEM_ENFORCE_MONOTONIC_RESTRICTIONS
protected static java.lang.String	ITEM_GRID_SPACING
protected static java.lang.String	ITEM_LOCAL_CROSSING_MINIMIZATION
protected static java.lang.String	ITEM_MINIMUM_DISTANCE_TO_EDGE
protected static java.lang.String	ITEM_MONOTONIC_RESTRICTION
protected static java.lang.String	ITEM_REROUTING_ENABLED
protected static java.lang.String	ITEM_ROUTE_ON_GRID
protected static java.lang.String	ITEM_SCOPE
protected static java.lang.String	ITEM_SPACE_DRIVEN_VS_CENTER_DRIVEN_SEARCH
protected static java.lang.String	ITEM_USE_CUSTOM_MINIMUM_DISTANCE_TO_NODE
protected static java.lang.String	SECTION_LAYOUT_OPTIONS
protected static java.lang.String	SECTION_SECTION_CROSSING_MINIMIZATION
protected static java.lang.String	VALUE_MONOTONIC_BOTH
protected static java.lang.String	VALUE_MONOTONIC_HORIZONTAL
protected static java.lang.String	VALUE_MONOTONIC_NONE
protected static java.lang.String	VALUE_MONOTONIC_VERTICAL
protected static java.lang.String	VALUE_SCOPE_ALL_EDGES
protected static java.lang.String	VALUE_SCOPE_AT_SELECTED_NODES
protected static java.lang.String	VALUE_SCOPE_SELECTED_EDGES

Fields inherited from class y.module.YModule

FAILED, moduleListenerSupport, PRECONDITION_VIOLATED, SUCCESS

Constructor Summary

OrthogonalEdgeRouterModule()
Creates an instance of this module.

Method Summary

protected void	configure(OrthogonalEdgeRouter orthogonal, 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.

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

SECTION_LAYOUT_OPTIONS

protected static final java.lang.String SECTION_LAYOUT_OPTIONS

See Also:

Constant Field Values

ITEM_SCOPE

protected static final java.lang.String ITEM_SCOPE

See Also:

Constant Field Values

VALUE_SCOPE_ALL_EDGES

protected static final java.lang.String VALUE_SCOPE_ALL_EDGES

See Also:

Constant Field Values

VALUE_SCOPE_SELECTED_EDGES

protected static final java.lang.String VALUE_SCOPE_SELECTED_EDGES

See Also:

Constant Field Values

VALUE_SCOPE_AT_SELECTED_NODES

protected static final java.lang.String VALUE_SCOPE_AT_SELECTED_NODES

See Also:

Constant Field Values

ITEM_MONOTONIC_RESTRICTION

protected static final java.lang.String ITEM_MONOTONIC_RESTRICTION

See Also:

Constant Field Values

VALUE_MONOTONIC_NONE

protected static final java.lang.String VALUE_MONOTONIC_NONE

See Also:

Constant Field Values

VALUE_MONOTONIC_HORIZONTAL

protected static final java.lang.String VALUE_MONOTONIC_HORIZONTAL

See Also:

Constant Field Values

VALUE_MONOTONIC_VERTICAL

protected static final java.lang.String VALUE_MONOTONIC_VERTICAL

See Also:

Constant Field Values

VALUE_MONOTONIC_BOTH

protected static final java.lang.String VALUE_MONOTONIC_BOTH

See Also:

Constant Field Values

ITEM_ENFORCE_MONOTONIC_RESTRICTIONS

protected static final java.lang.String ITEM_ENFORCE_MONOTONIC_RESTRICTIONS

See Also:

Constant Field Values

ITEM_MINIMUM_DISTANCE_TO_EDGE

protected static final java.lang.String ITEM_MINIMUM_DISTANCE_TO_EDGE

See Also:

Constant Field Values

ITEM_USE_CUSTOM_MINIMUM_DISTANCE_TO_NODE

protected static final java.lang.String ITEM_USE_CUSTOM_MINIMUM_DISTANCE_TO_NODE

See Also:

Constant Field Values

ITEM_CUSTOM_MINIMUM_DISTANCE_TO_NODE

protected static final java.lang.String ITEM_CUSTOM_MINIMUM_DISTANCE_TO_NODE

See Also:

Constant Field Values

ITEM_ROUTE_ON_GRID

protected static final java.lang.String ITEM_ROUTE_ON_GRID

See Also:

Constant Field Values

ITEM_GRID_SPACING

protected static final java.lang.String ITEM_GRID_SPACING

See Also:

Constant Field Values

ITEM_SPACE_DRIVEN_VS_CENTER_DRIVEN_SEARCH

protected static final java.lang.String ITEM_SPACE_DRIVEN_VS_CENTER_DRIVEN_SEARCH

See Also:

Constant Field Values

ITEM_CONSIDER_NODE_LABELS

protected static final java.lang.String ITEM_CONSIDER_NODE_LABELS

See Also:

Constant Field Values

SECTION_SECTION_CROSSING_MINIMIZATION

protected static final java.lang.String SECTION_SECTION_CROSSING_MINIMIZATION

See Also:

Constant Field Values

ITEM_LOCAL_CROSSING_MINIMIZATION

protected static final java.lang.String ITEM_LOCAL_CROSSING_MINIMIZATION

See Also:

Constant Field Values

ITEM_CROSSING_COST

protected static final java.lang.String ITEM_CROSSING_COST

See Also:

Constant Field Values

ITEM_REROUTING_ENABLED

protected static final java.lang.String ITEM_REROUTING_ENABLED

See Also:

Constant Field Values

Constructor Detail

OrthogonalEdgeRouterModule

public OrthogonalEdgeRouterModule()

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

configure

protected void configure(OrthogonalEdgeRouter orthogonal,
                         OptionHandler options)

Configures the module's layout algorithm according to the given options.

Parameters:

orthogonal - the OrthogonalEdgeRouter to be configured

options - the layout options to set