Search this API

y.module
Class ParallelEdgeLayoutModule

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

public class ParallelEdgeLayoutModule
extends LayoutModule

This module represents an interactive configurator and launcher for ParallelEdgeLayouter.

 

Field Summary
protected static java.lang.String ITEM_CONSIDER_EDGE_DIRECTION
           
protected static java.lang.String ITEM_JOIN_DISTANCE
           
protected static java.lang.String ITEM_JOINS_ENDS
           
protected static java.lang.String ITEM_LINE_DISTANCE
           
protected static java.lang.String ITEM_SCOPE
           
protected static java.lang.String ITEM_USE_ADAPTIVE_LINE_DISTANCE
           
protected static java.lang.String ITEM_USE_SELECTED_EDGES_AS_MASTER
           
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
ParallelEdgeLayoutModule()
          Creates an instance of this module.
 
Method Summary
protected  void configure(ParallelEdgeLayouter parallel, OptionHandler options)
          Configures the module's layout algorithm according to the given options.
 OptionHandler createOptionHandler()
          Creates an OptionHandler and adds the option items used by this module.
 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

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_USE_SELECTED_EDGES_AS_MASTER

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

ITEM_CONSIDER_EDGE_DIRECTION

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

ITEM_USE_ADAPTIVE_LINE_DISTANCE

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

ITEM_LINE_DISTANCE

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

ITEM_JOINS_ENDS

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

ITEM_JOIN_DISTANCE

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

ParallelEdgeLayoutModule

public ParallelEdgeLayoutModule()
Creates an instance of this module.

Method Detail

createOptionHandler

public 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

public 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(ParallelEdgeLayouter parallel,
                         OptionHandler options)
Configures the module's layout algorithm according to the given options.

Parameters:
parallel - the ParallelEdgeLayouter to be configured
options - the layout options to set

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