y.module
Class ChannelEdgeRouterModule

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

public class ChannelEdgeRouterModule
extends LayoutModule

This module represents an interactive configurator and launcher for ChannelEdgeRouter.

See Also:

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

Field Summary

Fields inherited from class y.module.YModule

FAILED, moduleListenerSupport, PRECONDITION_VIOLATED, SUCCESS

Constructor Summary

ChannelEdgeRouterModule()
Creates a new Instance of this Module.

Method Summary

void	configure(Layouter layouter) Configures an instance of ChannelEdgeRouter.
protected OptionHandler	createOptionHandler() Creates and initializes the Option Handler so that a convenient way for manipulating the parameters is at the user's hand.
protected void	dispose() Disposition code performed after the execution of YModule.mainrun() was finished.
protected void	init() Initialization code performed before calling YModule.mainrun().
void	initOptionHandler(Layouter layouter) Initializes the option handler of this module with the properties of the given router.
protected void	mainrun() Main execution code to be implemented by any subclassing module.

Methods inherited from class y.module.LayoutModule

createAnimationPlayer, createLayoutExecutor, createLayoutMorpher, getBufferedMode, getLayoutExecutor, isAbortable, isMorphingEnabled, isPortIntersectionCalculatorEnabled, launchLayouter, launchLayouter, setBufferedMode, setLayoutExecutor, setMorphingEnabled, setPortIntersectionCalculatorEnabled, useEventDispatchThread

Methods inherited from class y.module.YModule

addModuleListener, createThread, exceptionHappened, fitGraph2DView, getAuthor, getDescription, getExitStatus, getGraph2D, getGraph2DView, getModuleName, getOptionHandler, getTimer, getView, 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

Constructor Detail

ChannelEdgeRouterModule

public ChannelEdgeRouterModule()

Creates a new Instance of this Module.

Method Detail

init

protected void init()

Description copied from class: YModule

Initialization code performed before calling YModule.mainrun().

Overrides:

init in class YModule

configure

public void configure(Layouter layouter)

Configures an instance of ChannelEdgeRouter. The values provided by this module's option handler are being used for this purpose.

Parameters:

layouter - the layouter to be configured.

initOptionHandler

public void initOptionHandler(Layouter layouter)

Initializes the option handler of this module with the properties of the given router.

Parameters:

layouter - an instance of ChannelEdgeRouter.

dispose

protected void dispose()

Description copied from class: YModule

Disposition code performed after the execution of YModule.mainrun() was finished.

Overrides:

dispose in class YModule

createOptionHandler

protected OptionHandler createOptionHandler()

Creates and initializes the Option Handler so that a convenient way for manipulating the parameters is at the user's hand.

Overrides:

createOptionHandler in class YModule

Returns:

The option handler for this module, null by default.

mainrun

protected void mainrun()

Description copied from class: YModule

Main execution code to be implemented by any subclassing module.

Specified by:

mainrun in class YModule