y.module
Class IncrementalHierarchicLayoutModule

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

public class IncrementalHierarchicLayoutModule
extends LayoutModule

This module represents an interactive configurator and launcher for IncrementalHierarchicLayouter.

See Also:

Section Applicable Layout Stages in the yFiles for Java Developer's Guide, Section Advanced Layout Concepts in the yFiles for Java Developer's Guide

Field Summary

protected static java.lang.String	ITEM_AUTOMATIC_BUS_ROUTING_ENABLED
protected static java.lang.String	ITEM_AUTOMATIC_EDGE_GROUPING_ENABLED
protected static java.lang.String	ITEM_BACKLOOP_ROUTING
protected static java.lang.String	ITEM_BACKLOOP_ROUTING_SELFLOOPS
protected static java.lang.String	ITEM_COMPACT_EDGE_LABEL_PLACEMENT
protected static java.lang.String	ITEM_COMPONENT_ARRANGEMENT_POLICY
protected static java.lang.String	ITEM_CONSIDER_EDGE_DIRECTION
protected static java.lang.String	ITEM_CONSIDER_EDGE_THICKNESS
protected static java.lang.String	ITEM_CONSIDER_NODE_LABELS
protected static java.lang.String	ITEM_CURVE_CONNECTION_STYLE
protected static java.lang.String	ITEM_CURVE_U_TURN_SYMMETRY
protected static java.lang.String	ITEM_EDGE_LABEL_MODEL
protected static java.lang.String	ITEM_EDGE_LABELING
protected static java.lang.String	ITEM_EDGE_ROUTING
protected static java.lang.String	ITEM_EDGE_STRAIGHTENING_OPTIMIZATION_ENABLED
protected static java.lang.String	ITEM_EDGE_TO_EDGE_DISTANCE
protected static java.lang.String	ITEM_GROUP_ALIGNMENT
protected static java.lang.String	ITEM_GROUP_ENABLE_COMPACTION
protected static java.lang.String	ITEM_GROUP_HORIZONTAL_COMPACTION
protected static java.lang.String	ITEM_GROUP_LAYERING_STRATEGY
protected static java.lang.String	ITEM_HALO
protected static java.lang.String	ITEM_LAYER_ALIGNMENT
protected static java.lang.String	ITEM_LAYOUT_COMPONENTS_SEPARATELY
protected static java.lang.String	ITEM_MAXIMAL_DURATION
protected static java.lang.String	ITEM_MAXIMUM_SIZE
protected static java.lang.String	ITEM_MINIMUM_EDGE_DISTANCE
protected static java.lang.String	ITEM_MINIMUM_EDGE_LENGTH
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_LAYER_DISTANCE
protected static java.lang.String	ITEM_MINIMUM_SIZE
protected static java.lang.String	ITEM_MINIMUM_SLOPE
protected static java.lang.String	ITEM_NODE_COMPACTION_ENABLED
protected static java.lang.String	ITEM_NODE_TO_EDGE_DISTANCE
protected static java.lang.String	ITEM_NODE_TO_NODE_DISTANCE
protected static java.lang.String	ITEM_NODE_TYPES
protected static java.lang.String	ITEM_ORIENTATION
protected static java.lang.String	ITEM_PC_OPTIMIZATION_ENABLED
protected static java.lang.String	ITEM_RANKING_POLICY
protected static java.lang.String	ITEM_RECURSIVE_EDGE_ROUTING
protected static java.lang.String	ITEM_SCALE
protected static java.lang.String	ITEM_SELECTED_ELEMENTS_INCREMENTALLY
protected static java.lang.String	ITEM_SWIMLANE_SPACING
protected static java.lang.String	ITEM_SYMMETRIC_PLACEMENT
protected static java.lang.String	ITEM_TREAT_ROOT_GROUPS_AS_SWIMLANES
protected static java.lang.String	ITEM_UNIFORM_PORTS_AT_GROUPS
protected static java.lang.String	ITEM_USE_DRAWING_AS_SKETCH
protected static java.lang.String	ITEM_USE_ORDER_FROM_SKETCH
protected static java.lang.String	MODULE_INCREMENTAL_HIERARCHIC
protected static java.lang.String	SECTION_EDGE_SETTINGS
protected static java.lang.String	SECTION_GENERAL
protected static java.lang.String	SECTION_GROUPING
protected static java.lang.String	SECTION_LABELING
protected static java.lang.String	SECTION_RANKS
protected static java.lang.String	SECTION_SWIMLANES
protected static java.lang.String	TITLE_EDGE_PROPERTIES
protected static java.lang.String	TITLE_FROM_SKETCH_PROPERTIES
protected static java.lang.String	TITLE_INTERACTION
protected static java.lang.String	TITLE_MINIMUM_DISTANCES
protected static java.lang.String	TITLE_NODE_PROPERTIES
protected static java.lang.String	VALUE_BFS_LAYERS
protected static java.lang.String	VALUE_BOTTOM
protected static java.lang.String	VALUE_BOTTOM_TO_TOP
protected static java.lang.String	VALUE_CENTER
protected static java.lang.String	VALUE_CURVE_CONNECTION_STYLE_HIERARCHIC
protected static java.lang.String	VALUE_CURVE_CONNECTION_STYLE_ORGANIC
protected static java.lang.String	VALUE_EDGE_LABEL_MODEL_AS_IS
protected static java.lang.String	VALUE_EDGE_LABEL_MODEL_BEST
protected static java.lang.String	VALUE_EDGE_LABEL_MODEL_CENTER_SLIDER
protected static java.lang.String	VALUE_EDGE_LABEL_MODEL_FREE
protected static java.lang.String	VALUE_EDGE_LABEL_MODEL_SIDE_SLIDER
protected static java.lang.String	VALUE_EDGE_LABELING_GENERIC
protected static java.lang.String	VALUE_EDGE_LABELING_HIERARCHIC
protected static java.lang.String	VALUE_EDGE_LABELING_NONE
protected static java.lang.String	VALUE_EDGE_ROUTING_CURVED
protected static java.lang.String	VALUE_EDGE_ROUTING_OCTILINEAR
protected static java.lang.String	VALUE_EDGE_ROUTING_ORTHOGONAL
protected static java.lang.String	VALUE_EDGE_ROUTING_POLYLINE
protected static java.lang.String	VALUE_FROM_SKETCH
protected static java.lang.String	VALUE_GLOBAL_LAYERING
protected static java.lang.String	VALUE_GROUP_ALIGN_BOTTOM
protected static java.lang.String	VALUE_GROUP_ALIGN_CENTER
protected static java.lang.String	VALUE_GROUP_ALIGN_TOP
protected static java.lang.String	VALUE_GROUP_HORIZONTAL_COMPACTION_MAX
protected static java.lang.String	VALUE_GROUP_HORIZONTAL_COMPACTION_NONE
protected static java.lang.String	VALUE_HIERARCHICAL_OPTIMAL
protected static java.lang.String	VALUE_HIERARCHICAL_TIGHT_TREE_HEURISTIC
protected static java.lang.String	VALUE_HIERARCHICAL_TOPMOST
protected static java.lang.String	VALUE_LEFT_TO_RIGHT
protected static java.lang.String	VALUE_NODE_TYPES_DEFINED_BY_COLOR
protected static java.lang.String	VALUE_NODE_TYPES_DEFINED_BY_LABEL
protected static java.lang.String	VALUE_NODE_TYPES_NONE
protected static java.lang.String	VALUE_POLICY_COMPACT
protected static java.lang.String	VALUE_POLICY_TOPMOST
protected static java.lang.String	VALUE_RECURSIVE_EDGE_ROUTING_DIRECTED
protected static java.lang.String	VALUE_RECURSIVE_EDGE_ROUTING_OFF
protected static java.lang.String	VALUE_RECURSIVE_EDGE_ROUTING_UNDIRECTED
protected static java.lang.String	VALUE_RECURSIVE_LAYERING
protected static java.lang.String	VALUE_RIGHT_TO_LEFT
protected static java.lang.String	VALUE_TOP
protected static java.lang.String	VALUE_TOP_TO_BOTTOM

Fields inherited from class y.module.YModule

FAILED, moduleListenerSupport, PRECONDITION_VIOLATED, SUCCESS

Constructor Summary

IncrementalHierarchicLayoutModule()
Creates an instance of this module.

Method Summary

protected void	configure(IncrementalHierarchicLayouter hierarchic, 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.
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

MODULE_INCREMENTAL_HIERARCHIC

protected static final java.lang.String MODULE_INCREMENTAL_HIERARCHIC

See Also:

Constant Field Values

SECTION_GENERAL

protected static final java.lang.String SECTION_GENERAL

See Also:

Constant Field Values

TITLE_INTERACTION

protected static final java.lang.String TITLE_INTERACTION

See Also:

Constant Field Values

ITEM_SELECTED_ELEMENTS_INCREMENTALLY

protected static final java.lang.String ITEM_SELECTED_ELEMENTS_INCREMENTALLY

See Also:

Constant Field Values

ITEM_USE_DRAWING_AS_SKETCH

protected static final java.lang.String ITEM_USE_DRAWING_AS_SKETCH

See Also:

Constant Field Values

ITEM_ORIENTATION

protected static final java.lang.String ITEM_ORIENTATION

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_LAYOUT_COMPONENTS_SEPARATELY

protected static final java.lang.String ITEM_LAYOUT_COMPONENTS_SEPARATELY

See Also:

Constant Field Values

ITEM_SYMMETRIC_PLACEMENT

protected static final java.lang.String ITEM_SYMMETRIC_PLACEMENT

See Also:

Constant Field Values

ITEM_MAXIMAL_DURATION

protected static final java.lang.String ITEM_MAXIMAL_DURATION

See Also:

Constant Field Values

TITLE_MINIMUM_DISTANCES

protected static final java.lang.String TITLE_MINIMUM_DISTANCES

See Also:

Constant Field Values

ITEM_NODE_TO_NODE_DISTANCE

protected static final java.lang.String ITEM_NODE_TO_NODE_DISTANCE

See Also:

Constant Field Values

ITEM_NODE_TO_EDGE_DISTANCE

protected static final java.lang.String ITEM_NODE_TO_EDGE_DISTANCE

See Also:

Constant Field Values

ITEM_EDGE_TO_EDGE_DISTANCE

protected static final java.lang.String ITEM_EDGE_TO_EDGE_DISTANCE

See Also:

Constant Field Values

ITEM_MINIMUM_LAYER_DISTANCE

protected static final java.lang.String ITEM_MINIMUM_LAYER_DISTANCE

See Also:

Constant Field Values

ITEM_NODE_TYPES

protected static final java.lang.String ITEM_NODE_TYPES

See Also:

Constant Field Values

VALUE_NODE_TYPES_NONE

protected static final java.lang.String VALUE_NODE_TYPES_NONE

See Also:

Constant Field Values

VALUE_NODE_TYPES_DEFINED_BY_COLOR

protected static final java.lang.String VALUE_NODE_TYPES_DEFINED_BY_COLOR

See Also:

Constant Field Values

VALUE_NODE_TYPES_DEFINED_BY_LABEL

protected static final java.lang.String VALUE_NODE_TYPES_DEFINED_BY_LABEL

See Also:

Constant Field Values

SECTION_EDGE_SETTINGS

protected static final java.lang.String SECTION_EDGE_SETTINGS

See Also:

Constant Field Values

ITEM_EDGE_ROUTING

protected static final java.lang.String ITEM_EDGE_ROUTING

See Also:

Constant Field Values

VALUE_EDGE_ROUTING_ORTHOGONAL

protected static final java.lang.String VALUE_EDGE_ROUTING_ORTHOGONAL

See Also:

Constant Field Values

VALUE_EDGE_ROUTING_POLYLINE

protected static final java.lang.String VALUE_EDGE_ROUTING_POLYLINE

See Also:

Constant Field Values

VALUE_EDGE_ROUTING_OCTILINEAR

protected static final java.lang.String VALUE_EDGE_ROUTING_OCTILINEAR

See Also:

Constant Field Values

VALUE_EDGE_ROUTING_CURVED

protected static final java.lang.String VALUE_EDGE_ROUTING_CURVED

See Also:

Constant Field Values

ITEM_CURVE_U_TURN_SYMMETRY

protected static final java.lang.String ITEM_CURVE_U_TURN_SYMMETRY

See Also:

Constant Field Values

ITEM_BACKLOOP_ROUTING

protected static final java.lang.String ITEM_BACKLOOP_ROUTING

See Also:

Constant Field Values

ITEM_BACKLOOP_ROUTING_SELFLOOPS

protected static final java.lang.String ITEM_BACKLOOP_ROUTING_SELFLOOPS

See Also:

Constant Field Values

ITEM_AUTOMATIC_EDGE_GROUPING_ENABLED

protected static final java.lang.String ITEM_AUTOMATIC_EDGE_GROUPING_ENABLED

See Also:

Constant Field Values

ITEM_AUTOMATIC_BUS_ROUTING_ENABLED

protected static final java.lang.String ITEM_AUTOMATIC_BUS_ROUTING_ENABLED

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_EDGE_LENGTH

protected static final java.lang.String ITEM_MINIMUM_EDGE_LENGTH

See Also:

Constant Field Values

ITEM_MINIMUM_EDGE_DISTANCE

protected static final java.lang.String ITEM_MINIMUM_EDGE_DISTANCE

See Also:

Constant Field Values

ITEM_MINIMUM_SLOPE

protected static final java.lang.String ITEM_MINIMUM_SLOPE

See Also:

Constant Field Values

ITEM_CURVE_CONNECTION_STYLE

protected static final java.lang.String ITEM_CURVE_CONNECTION_STYLE

See Also:

Constant Field Values

VALUE_CURVE_CONNECTION_STYLE_HIERARCHIC

protected static final java.lang.String VALUE_CURVE_CONNECTION_STYLE_HIERARCHIC

See Also:

Constant Field Values

VALUE_CURVE_CONNECTION_STYLE_ORGANIC

protected static final java.lang.String VALUE_CURVE_CONNECTION_STYLE_ORGANIC

See Also:

Constant Field Values

ITEM_PC_OPTIMIZATION_ENABLED

protected static final java.lang.String ITEM_PC_OPTIMIZATION_ENABLED

See Also:

Constant Field Values

ITEM_EDGE_STRAIGHTENING_OPTIMIZATION_ENABLED

protected static final java.lang.String ITEM_EDGE_STRAIGHTENING_OPTIMIZATION_ENABLED

See Also:

Constant Field Values

ITEM_RECURSIVE_EDGE_ROUTING

protected static final java.lang.String ITEM_RECURSIVE_EDGE_ROUTING

See Also:

Constant Field Values

VALUE_RECURSIVE_EDGE_ROUTING_OFF

protected static final java.lang.String VALUE_RECURSIVE_EDGE_ROUTING_OFF

See Also:

Constant Field Values

VALUE_RECURSIVE_EDGE_ROUTING_DIRECTED

protected static final java.lang.String VALUE_RECURSIVE_EDGE_ROUTING_DIRECTED

See Also:

Constant Field Values

VALUE_RECURSIVE_EDGE_ROUTING_UNDIRECTED

protected static final java.lang.String VALUE_RECURSIVE_EDGE_ROUTING_UNDIRECTED

See Also:

Constant Field Values

ITEM_CONSIDER_EDGE_THICKNESS

protected static final java.lang.String ITEM_CONSIDER_EDGE_THICKNESS

See Also:

Constant Field Values

ITEM_CONSIDER_EDGE_DIRECTION

protected static final java.lang.String ITEM_CONSIDER_EDGE_DIRECTION

See Also:

Constant Field Values

SECTION_RANKS

protected static final java.lang.String SECTION_RANKS

See Also:

Constant Field Values

ITEM_RANKING_POLICY

protected static final java.lang.String ITEM_RANKING_POLICY

See Also:

Constant Field Values

VALUE_HIERARCHICAL_OPTIMAL

protected static final java.lang.String VALUE_HIERARCHICAL_OPTIMAL

See Also:

Constant Field Values

VALUE_HIERARCHICAL_TIGHT_TREE_HEURISTIC

protected static final java.lang.String VALUE_HIERARCHICAL_TIGHT_TREE_HEURISTIC

See Also:

Constant Field Values

VALUE_BFS_LAYERS

protected static final java.lang.String VALUE_BFS_LAYERS

See Also:

Constant Field Values

VALUE_FROM_SKETCH

protected static final java.lang.String VALUE_FROM_SKETCH

See Also:

Constant Field Values

VALUE_HIERARCHICAL_TOPMOST

protected static final java.lang.String VALUE_HIERARCHICAL_TOPMOST

See Also:

Constant Field Values

ITEM_LAYER_ALIGNMENT

protected static final java.lang.String ITEM_LAYER_ALIGNMENT

See Also:

Constant Field Values

VALUE_TOP

protected static final java.lang.String VALUE_TOP

See Also:

Constant Field Values

VALUE_CENTER

protected static final java.lang.String VALUE_CENTER

See Also:

Constant Field Values

VALUE_BOTTOM

protected static final java.lang.String VALUE_BOTTOM

See Also:

Constant Field Values

ITEM_COMPONENT_ARRANGEMENT_POLICY

protected static final java.lang.String ITEM_COMPONENT_ARRANGEMENT_POLICY

See Also:

Constant Field Values

VALUE_POLICY_COMPACT

protected static final java.lang.String VALUE_POLICY_COMPACT

See Also:

Constant Field Values

VALUE_POLICY_TOPMOST

protected static final java.lang.String VALUE_POLICY_TOPMOST

See Also:

Constant Field Values

TITLE_FROM_SKETCH_PROPERTIES

protected static final java.lang.String TITLE_FROM_SKETCH_PROPERTIES

See Also:

Constant Field Values

ITEM_SCALE

protected static final java.lang.String ITEM_SCALE

See Also:

Constant Field Values

ITEM_HALO

protected static final java.lang.String ITEM_HALO

See Also:

Constant Field Values

ITEM_MINIMUM_SIZE

protected static final java.lang.String ITEM_MINIMUM_SIZE

See Also:

Constant Field Values

ITEM_MAXIMUM_SIZE

protected static final java.lang.String ITEM_MAXIMUM_SIZE

See Also:

Constant Field Values

ITEM_NODE_COMPACTION_ENABLED

protected static final java.lang.String ITEM_NODE_COMPACTION_ENABLED

See Also:

Constant Field Values

SECTION_LABELING

protected static final java.lang.String SECTION_LABELING

See Also:

Constant Field Values

TITLE_NODE_PROPERTIES

protected static final java.lang.String TITLE_NODE_PROPERTIES

See Also:

Constant Field Values

ITEM_CONSIDER_NODE_LABELS

protected static final java.lang.String ITEM_CONSIDER_NODE_LABELS

See Also:

Constant Field Values

TITLE_EDGE_PROPERTIES

protected static final java.lang.String TITLE_EDGE_PROPERTIES

See Also:

Constant Field Values

ITEM_EDGE_LABELING

protected static final java.lang.String ITEM_EDGE_LABELING

See Also:

Constant Field Values

VALUE_EDGE_LABELING_NONE

protected static final java.lang.String VALUE_EDGE_LABELING_NONE

See Also:

Constant Field Values

VALUE_EDGE_LABELING_GENERIC

protected static final java.lang.String VALUE_EDGE_LABELING_GENERIC

See Also:

Constant Field Values

VALUE_EDGE_LABELING_HIERARCHIC

protected static final java.lang.String VALUE_EDGE_LABELING_HIERARCHIC

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_EDGE_LABEL_MODEL_BEST

protected static final java.lang.String VALUE_EDGE_LABEL_MODEL_BEST

See Also:

Constant Field Values

VALUE_EDGE_LABEL_MODEL_AS_IS

protected static final java.lang.String VALUE_EDGE_LABEL_MODEL_AS_IS

See Also:

Constant Field Values

VALUE_EDGE_LABEL_MODEL_CENTER_SLIDER

protected static final java.lang.String VALUE_EDGE_LABEL_MODEL_CENTER_SLIDER

See Also:

Constant Field Values

VALUE_EDGE_LABEL_MODEL_SIDE_SLIDER

protected static final java.lang.String VALUE_EDGE_LABEL_MODEL_SIDE_SLIDER

See Also:

Constant Field Values

VALUE_EDGE_LABEL_MODEL_FREE

protected static final java.lang.String VALUE_EDGE_LABEL_MODEL_FREE

See Also:

Constant Field Values

ITEM_COMPACT_EDGE_LABEL_PLACEMENT

protected static final java.lang.String ITEM_COMPACT_EDGE_LABEL_PLACEMENT

See Also:

Constant Field Values

SECTION_GROUPING

protected static final java.lang.String SECTION_GROUPING

See Also:

Constant Field Values

ITEM_GROUP_LAYERING_STRATEGY

protected static final java.lang.String ITEM_GROUP_LAYERING_STRATEGY

See Also:

Constant Field Values

VALUE_GLOBAL_LAYERING

protected static final java.lang.String VALUE_GLOBAL_LAYERING

See Also:

Constant Field Values

VALUE_RECURSIVE_LAYERING

protected static final java.lang.String VALUE_RECURSIVE_LAYERING

See Also:

Constant Field Values

ITEM_GROUP_ENABLE_COMPACTION

protected static final java.lang.String ITEM_GROUP_ENABLE_COMPACTION

See Also:

Constant Field Values

ITEM_GROUP_ALIGNMENT

protected static final java.lang.String ITEM_GROUP_ALIGNMENT

See Also:

Constant Field Values

VALUE_GROUP_ALIGN_TOP

protected static final java.lang.String VALUE_GROUP_ALIGN_TOP

See Also:

Constant Field Values

VALUE_GROUP_ALIGN_CENTER

protected static final java.lang.String VALUE_GROUP_ALIGN_CENTER

See Also:

Constant Field Values

VALUE_GROUP_ALIGN_BOTTOM

protected static final java.lang.String VALUE_GROUP_ALIGN_BOTTOM

See Also:

Constant Field Values

ITEM_GROUP_HORIZONTAL_COMPACTION

protected static final java.lang.String ITEM_GROUP_HORIZONTAL_COMPACTION

See Also:

Constant Field Values

VALUE_GROUP_HORIZONTAL_COMPACTION_NONE

protected static final java.lang.String VALUE_GROUP_HORIZONTAL_COMPACTION_NONE

See Also:

Constant Field Values

VALUE_GROUP_HORIZONTAL_COMPACTION_MAX

protected static final java.lang.String VALUE_GROUP_HORIZONTAL_COMPACTION_MAX

See Also:

Constant Field Values

ITEM_UNIFORM_PORTS_AT_GROUPS

protected static final java.lang.String ITEM_UNIFORM_PORTS_AT_GROUPS

See Also:

Constant Field Values

SECTION_SWIMLANES

protected static final java.lang.String SECTION_SWIMLANES

See Also:

Constant Field Values

ITEM_TREAT_ROOT_GROUPS_AS_SWIMLANES

protected static final java.lang.String ITEM_TREAT_ROOT_GROUPS_AS_SWIMLANES

See Also:

Constant Field Values

ITEM_USE_ORDER_FROM_SKETCH

protected static final java.lang.String ITEM_USE_ORDER_FROM_SKETCH

See Also:

Constant Field Values

ITEM_SWIMLANE_SPACING

protected static final java.lang.String ITEM_SWIMLANE_SPACING

See Also:

Constant Field Values

Constructor Detail

IncrementalHierarchicLayoutModule

public IncrementalHierarchicLayoutModule()

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

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(IncrementalHierarchicLayouter hierarchic,
                         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:

hierarchic - the IncrementalHierarchicLayouter to be configured

options - the layout options to set