Search this API

y.module
Class OrthogonalLayoutModule

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

public class OrthogonalLayoutModule
extends LayoutModule

This module represents an interactive configurator and launcher for OrthogonalLayouter and OrthogonalGroupLayouter respectively.

See Also:
Section Advanced Layout Concepts in the yFiles for Java Developer's Guide, Section Layout Stages in the yFiles for Java Developer's Guide, Section Orthogonal Layout of Grouped Graphs in the yFiles for Java Developer's Guide, Section Orthogonal Layout in the yFiles for Java Developer's Guide
 

Field Summary
protected static java.lang.String ITEM_ALIGN_DEGREE_ONE_NODES
           
protected static java.lang.String ITEM_CHAIN_STYLE
           
protected static java.lang.String ITEM_CONSIDER_NODE_LABELS
           
protected static java.lang.String ITEM_CYCLE_STYLE
           
protected static java.lang.String ITEM_EDGE_LABEL_MODEL
           
protected static java.lang.String ITEM_EDGE_LABELING
           
protected static java.lang.String ITEM_GRID
           
protected static java.lang.String ITEM_GROUP_POLICY
           
protected static java.lang.String ITEM_MAXIMUM_DURATION
           
protected static java.lang.String ITEM_MINIMUM_CHAIN_SIZE
           
protected static java.lang.String ITEM_MINIMUM_CYCLE_SIZE
           
protected static java.lang.String ITEM_MINIMUM_FIRST_SEGMENT_LENGTH
           
protected static java.lang.String ITEM_MINIMUM_LAST_SEGMENT_LENGTH
           
protected static java.lang.String ITEM_MINIMUM_SEGMENT_LENGTH
           
protected static java.lang.String ITEM_MINIMUM_TREE_SIZE
           
protected static java.lang.String ITEM_STYLE
           
protected static java.lang.String ITEM_TREE_ORIENTATION
           
protected static java.lang.String ITEM_TREE_STYLE
           
protected static java.lang.String ITEM_UNIFORM_PORT_ASSIGNMENT
           
protected static java.lang.String ITEM_USE_EXISTING_DRAWING_AS_SKETCH
           
protected static java.lang.String MODULE_ORTHOGONAL
           
protected static java.lang.String SECTION_GROUPING
           
protected static java.lang.String SECTION_LABELING
           
protected static java.lang.String SECTION_LAYOUT
           
protected static java.lang.String SECTION_SUBSTRUCTURE_CONFIGURATION
           
protected static java.lang.String VALUE_AS_IS
           
protected static java.lang.String VALUE_AUTOMATIC
           
protected static java.lang.String VALUE_BEST
           
protected static java.lang.String VALUE_BOTTOM_TO_TOP
           
protected static java.lang.String VALUE_BOX_NODES
           
protected static java.lang.String VALUE_CENTER_SLIDER
           
protected static java.lang.String VALUE_CHAIN_STYLE_NONE
           
protected static java.lang.String VALUE_CHAIN_STYLE_WRAPPED_AT_EDGES
           
protected static java.lang.String VALUE_CHAIN_STYLE_WRAPPED_AT_NODES
           
protected static java.lang.String VALUE_CYCLE_STYLE_CIRCULAR_BENDS_AT_CORNERS
           
protected static java.lang.String VALUE_CYCLE_STYLE_CIRCULAR_NODES_AT_CORNERS
           
protected static java.lang.String VALUE_CYCLE_STYLE_NONE
           
protected static java.lang.String VALUE_FIX_GROUPS
           
protected static java.lang.String VALUE_FIXED_BOX_NODES
           
protected static java.lang.String VALUE_FIXED_MIXED
           
protected static java.lang.String VALUE_FREE
           
protected static java.lang.String VALUE_GENERIC
           
protected static java.lang.String VALUE_IGNORE_GROUPS
           
protected static java.lang.String VALUE_INTEGRATED
           
protected static java.lang.String VALUE_LAYOUT_GROUPS
           
protected static java.lang.String VALUE_LEFT_TO_RIGHT
           
protected static java.lang.String VALUE_MIXED
           
protected static java.lang.String VALUE_NONE
           
protected static java.lang.String VALUE_NORMAL
           
protected static java.lang.String VALUE_RIGHT_TO_LEFT
           
protected static java.lang.String VALUE_SIDE_SLIDER
           
protected static java.lang.String VALUE_TOP_TO_BOTTOM
           
protected static java.lang.String VALUE_TREE_STYLE_COMPACT
           
protected static java.lang.String VALUE_TREE_STYLE_LAYERED
           
protected static java.lang.String VALUE_TREE_STYLE_NONE
           
protected static java.lang.String VALUE_UNIFORM_NODES
           
 
Fields inherited from class y.module.YModule
FAILED, moduleListenerSupport, PRECONDITION_VIOLATED, SUCCESS
 
Constructor Summary
OrthogonalLayoutModule()
          Creates an instance of this module.
 
Method Summary
protected  void configure(OrthogonalGroupLayouter orthogonalGroup, OptionHandler options)
          This method configures the modules underlying algorithm with options found in the given OptionHandler.
protected  void configure(OrthogonalLayouter 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_ORTHOGONAL

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

SECTION_LAYOUT

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

ITEM_STYLE

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

VALUE_NORMAL

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

VALUE_UNIFORM_NODES

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

VALUE_BOX_NODES

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

VALUE_MIXED

protected static final java.lang.String VALUE_MIXED
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_GRID

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

ITEM_USE_EXISTING_DRAWING_AS_SKETCH

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

ITEM_ALIGN_DEGREE_ONE_NODES

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

ITEM_MINIMUM_FIRST_SEGMENT_LENGTH

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

ITEM_MINIMUM_LAST_SEGMENT_LENGTH

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

ITEM_MINIMUM_SEGMENT_LENGTH

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

ITEM_UNIFORM_PORT_ASSIGNMENT

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

SECTION_SUBSTRUCTURE_CONFIGURATION

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

ITEM_TREE_STYLE

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

VALUE_TREE_STYLE_NONE

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

VALUE_TREE_STYLE_LAYERED

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

VALUE_TREE_STYLE_COMPACT

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

ITEM_MINIMUM_TREE_SIZE

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

ITEM_TREE_ORIENTATION

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

VALUE_AUTOMATIC

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

VALUE_TOP_TO_BOTTOM

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

VALUE_LEFT_TO_RIGHT

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

VALUE_BOTTOM_TO_TOP

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

VALUE_RIGHT_TO_LEFT

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

ITEM_CHAIN_STYLE

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

VALUE_CHAIN_STYLE_NONE

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

VALUE_CHAIN_STYLE_WRAPPED_AT_NODES

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

VALUE_CHAIN_STYLE_WRAPPED_AT_EDGES

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

ITEM_MINIMUM_CHAIN_SIZE

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

ITEM_CYCLE_STYLE

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

VALUE_CYCLE_STYLE_NONE

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

VALUE_CYCLE_STYLE_CIRCULAR_NODES_AT_CORNERS

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

VALUE_CYCLE_STYLE_CIRCULAR_BENDS_AT_CORNERS

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

ITEM_MINIMUM_CYCLE_SIZE

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

ITEM_MAXIMUM_DURATION

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

SECTION_LABELING

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

ITEM_EDGE_LABELING

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

VALUE_NONE

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

VALUE_INTEGRATED

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

VALUE_GENERIC

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

ITEM_EDGE_LABEL_MODEL

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

VALUE_BEST

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

VALUE_AS_IS

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

VALUE_CENTER_SLIDER

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

VALUE_SIDE_SLIDER

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

VALUE_FREE

protected static final java.lang.String VALUE_FREE
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_GROUPING

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

ITEM_GROUP_POLICY

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

VALUE_LAYOUT_GROUPS

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

VALUE_FIX_GROUPS

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

VALUE_IGNORE_GROUPS

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

OrthogonalLayoutModule

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

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

Parameters:
orthogonal - the OrthogonalLayouter to be configured
options - the layout options to set

configure

protected void configure(OrthogonalGroupLayouter orthogonalGroup,
                         OptionHandler options)
This method configures the modules underlying algorithm with options found in the given OptionHandler.

Parameters:
orthogonalGroup - the OrthogonalGroupLayouter to be configured
options - an OptionHandler providing the option-values referred to

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