y.module
Class BusRouterModule

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

public class BusRouterModule
extends LayoutModule

Module for the BusRouter.

There are more scopes in this module than in BusRouter. Each additional scope is mapped to an appropriate combinations of scope and fixed edges in BusRouter.

ALL

Maps to BusRouter.SCOPE_ALL. All edges are in scope, and all of them are movable.

SUBSET

Maps to BusRouter.SCOPE_SUBSET. The selected edges are in scope, and all of them are movable.

SUBSET_BUS

Each bus with at least one selected edge is in scope, and all of their edges are movable.

PARTIAL

Each bus with at least one selected node is in scope, and only the adjacent edges of the selected nodes are movable.

See Also:

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

Field Summary

protected boolean	optionsLayout Specifies whether the options of group layout are used.
protected boolean	optionsRouting Specifies whether the options for routing and recombination are used.
protected boolean	optionsSelection Specifies whether the options for initial backbone selection are used.

Fields inherited from class y.module.YModule

FAILED, moduleListenerSupport, PRECONDITION_VIOLATED, SUCCESS

Constructor Summary

BusRouterModule()
Creates a new instance of this module.

Method Summary

protected void	addOptionItems(OptionHandler oh) Adds the option items used by this module to the given OptionHandler.
void	configure(BusRouter busRouter) Configures an instance of BusRouter.
protected OptionHandler	createOptionHandler() Creates an option handler for this module.
protected void	dispose() Disposes this module after mainrun().
protected BusRouter	getBusRouter() Returns the bus router used by this module.
protected void	init() Prepares this module for mainrun().
protected void	initOptionHandler(OptionHandler oh, BusRouter busRouter) Sets the option items of the given option handler to the settings of the given BusRouter.
protected void	mainrun() Launches the layouter of this 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

Field Detail

optionsLayout

protected boolean optionsLayout

Specifies whether the options of group layout are used.

optionsSelection

protected boolean optionsSelection

Specifies whether the options for initial backbone selection are used.

optionsRouting

protected boolean optionsRouting

Specifies whether the options for routing and recombination are used.

Constructor Detail

BusRouterModule

public BusRouterModule()

Creates a new instance of this module.

Method Detail

createOptionHandler

protected OptionHandler createOptionHandler()

Creates an option handler for this module.

Overrides:

createOptionHandler in class YModule

Returns:

The option handler for this module, null by default.

addOptionItems

protected void addOptionItems(OptionHandler oh)

Adds the option items used by this module to the given OptionHandler.

Parameters:

oh - the OptionHandler to add the items to

initOptionHandler

protected void initOptionHandler(OptionHandler oh,
                                 BusRouter busRouter)

Sets the option items of the given option handler to the settings of the given BusRouter.

Parameters:

oh - the option handler

busRouter - the bus router

configure

public void configure(BusRouter busRouter)

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

Parameters:

busRouter - the BusRouter to be configured.

getBusRouter

protected BusRouter getBusRouter()

Returns the bus router used by this module.

Returns:

the bus router used by this modul

mainrun

protected void mainrun()

Launches the layouter of this module.

Specified by:

mainrun in class YModule

init

protected void init()

Prepares this module for mainrun().

Overrides:

init in class YModule

dispose

protected void dispose()

Disposes this module after mainrun().

Overrides:

dispose in class YModule