Search this API

y.module
Class CompactOrthogonalLayoutModule

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

public class CompactOrthogonalLayoutModule
extends LayoutModule

This module represents an interactive configurator and launcher for CompactOrthogonalLayouter.

See Also:
Section Compact Orthogonal Layout in the yFiles for Java Developer's Guide
 

Field Summary
protected static java.lang.String ITEM_ASPECT_RATIO
           
protected static java.lang.String ITEM_BEND_COST
           
protected static java.lang.String ITEM_CENTER_TO_SPACE_RATIO
           
protected static java.lang.String ITEM_EDGE_CROSSING_COST
           
protected static java.lang.String ITEM_EDGE_ROUTER
           
protected static java.lang.String ITEM_GRID
           
protected static java.lang.String ITEM_MINIMUM_DISTANCE
           
protected static java.lang.String ITEM_NODE_CROSSING_COST
           
protected static java.lang.String ITEM_ORTHOGONAL_LAYOUT_STYLE
           
protected static java.lang.String ITEM_PLACEMENT_STRATEGY
           
protected static java.lang.String ITEM_ROUTE_ALL_EDGES
           
protected static java.lang.String ITEM_USE_VIEW_ASPECT_RATIO
           
protected static java.lang.String MODULE_COMPACT_ORTHOGONAL
           
protected static java.lang.String TITLE_INTER_EDGE_ROUTER
           
protected static java.lang.String VALUE_EDGE_ROUTER_CHANNEL_FAST
           
protected static java.lang.String VALUE_EDGE_ROUTER_CHANNEL_HQ
           
protected static java.lang.String VALUE_EDGE_ROUTER_ORTHOGONAL
           
protected static java.lang.String VALUE_FIXED_BOX_NODES
           
protected static java.lang.String VALUE_FIXED_MIXED
           
protected static java.lang.String VALUE_NORMAL
           
protected static java.lang.String VALUE_NORMAL_TREE
           
protected static java.lang.String VALUE_STYLE_PACKED_COMPACT_RECTANGLE
           
protected static java.lang.String VALUE_STYLE_ROWS
           
 
Fields inherited from class y.module.YModule
FAILED, moduleListenerSupport, PRECONDITION_VIOLATED, SUCCESS
 
Constructor Summary
CompactOrthogonalLayoutModule()
          Creates an instance of this module.
 
Method Summary
protected  void configure(CompactOrthogonalLayouter 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

MODULE_COMPACT_ORTHOGONAL

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

ITEM_ORTHOGONAL_LAYOUT_STYLE

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

VALUE_NORMAL

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

VALUE_NORMAL_TREE

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

VALUE_FIXED_MIXED

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

VALUE_FIXED_BOX_NODES

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

ITEM_PLACEMENT_STRATEGY

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

VALUE_STYLE_ROWS

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

VALUE_STYLE_PACKED_COMPACT_RECTANGLE

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

ITEM_USE_VIEW_ASPECT_RATIO

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

ITEM_ASPECT_RATIO

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

ITEM_GRID

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

TITLE_INTER_EDGE_ROUTER

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

ITEM_EDGE_ROUTER

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

VALUE_EDGE_ROUTER_CHANNEL_FAST

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

VALUE_EDGE_ROUTER_CHANNEL_HQ

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

VALUE_EDGE_ROUTER_ORTHOGONAL

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

ITEM_ROUTE_ALL_EDGES

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

ITEM_BEND_COST

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

ITEM_NODE_CROSSING_COST

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

ITEM_MINIMUM_DISTANCE

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

ITEM_EDGE_CROSSING_COST

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

ITEM_CENTER_TO_SPACE_RATIO

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

CompactOrthogonalLayoutModule

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

Important: This method does also depend on the Graph2DView of this module in addition to the method's parameters.

Parameters:
orthogonal - the CompactOrthogonalLayouter to be configured
options - an OptionHandler providing the option-values referred to

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