y.module
Class PartialLayoutModule

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

public class PartialLayoutModule
extends LayoutModule

This module represents an interactive configurator and launcher for PartialLayouter.

See Also:

Section Partial Layout in the yFiles for Java Developer's Guide

Field Summary

protected static java.lang.String	ITEM_CONSIDER_EDGE_DIRECTION
protected static java.lang.String	ITEM_CONSIDER_SNAPLINES
protected static java.lang.String	ITEM_ELEMENT_COLOR
protected static java.lang.String	ITEM_MIN_NODE_DIST
protected static java.lang.String	ITEM_MODE_COMPONENT_ASSIGNMENT
protected static java.lang.String	ITEM_MOVING_FIXED_ELEMENTS_ALLOWED
protected static java.lang.String	ITEM_ORIENTATION_MAIN_GRAPH
protected static java.lang.String	ITEM_ROUTING_TO_SUBGRAPH
protected static java.lang.String	ITEM_SELECTION
protected static java.lang.String	ITEM_SUBGRAPH_LAYOUTER
protected static java.lang.String	ITEM_SUBGRAPH_POSITION_STRATEGY
protected static java.lang.String	ITEM_USE_AS_CRITERIA
protected static java.lang.String	MODULE_PARTIAL
protected static java.lang.String	SECTION_GENERAL
protected static java.lang.String	TITLE_IDENTIFY_PARTIAL_ELEMENTS
protected static java.lang.String	VALUE_MODE_COMPONENT_CLUSTERING
protected static java.lang.String	VALUE_MODE_COMPONENT_CONNECTED
protected static java.lang.String	VALUE_MODE_COMPONENT_CUSTOMIZED
protected static java.lang.String	VALUE_MODE_COMPONENT_SINGLE
protected static java.lang.String	VALUE_ORIENTATION_MAIN_GRAPH_AUTO_DETECT
protected static java.lang.String	VALUE_ORIENTATION_MAIN_GRAPH_DOWN_TO_TOP
protected static java.lang.String	VALUE_ORIENTATION_MAIN_GRAPH_LEFT_TO_RIGHT
protected static java.lang.String	VALUE_ORIENTATION_MAIN_GRAPH_NONE
protected static java.lang.String	VALUE_ORIENTATION_MAIN_GRAPH_RIGHT_TO_LEFT
protected static java.lang.String	VALUE_ORIENTATION_MAIN_GRAPH_TOP_TO_DOWN
protected static java.lang.String	VALUE_ROUTING_TO_SUBGRAPH_AUTO
protected static java.lang.String	VALUE_ROUTING_TO_SUBGRAPH_ORGANIC
protected static java.lang.String	VALUE_ROUTING_TO_SUBGRAPH_ORTHOGONALLY
protected static java.lang.String	VALUE_ROUTING_TO_SUBGRAPH_POLYLINE
protected static java.lang.String	VALUE_ROUTING_TO_SUBGRAPH_STRAIGHT_LINE
protected static java.lang.String	VALUE_SUBGRAPH_LAYOUTER_CIRCULAR
protected static java.lang.String	VALUE_SUBGRAPH_LAYOUTER_IHL
protected static java.lang.String	VALUE_SUBGRAPH_LAYOUTER_NO_LAYOUT
protected static java.lang.String	VALUE_SUBGRAPH_LAYOUTER_ORGANIC
protected static java.lang.String	VALUE_SUBGRAPH_LAYOUTER_ORTHOGONAL
protected static java.lang.String	VALUE_SUBGRAPH_POSITIONING_STRATEGY_BARYCENTER
protected static java.lang.String	VALUE_SUBGRAPH_POSITIONING_STRATEGY_FROM_SKETCH

Fields inherited from class y.module.YModule

FAILED, moduleListenerSupport, PRECONDITION_VIOLATED, SUCCESS

Constructor Summary

PartialLayoutModule()
Creates an instance of this module.

Method Summary

protected void	configure(PartialLayouter partial, 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_PARTIAL

protected static final java.lang.String MODULE_PARTIAL

See Also:

Constant Field Values

SECTION_GENERAL

protected static final java.lang.String SECTION_GENERAL

See Also:

Constant Field Values

ITEM_ROUTING_TO_SUBGRAPH

protected static final java.lang.String ITEM_ROUTING_TO_SUBGRAPH

See Also:

Constant Field Values

VALUE_ROUTING_TO_SUBGRAPH_AUTO

protected static final java.lang.String VALUE_ROUTING_TO_SUBGRAPH_AUTO

See Also:

Constant Field Values

VALUE_ROUTING_TO_SUBGRAPH_STRAIGHT_LINE

protected static final java.lang.String VALUE_ROUTING_TO_SUBGRAPH_STRAIGHT_LINE

See Also:

Constant Field Values

VALUE_ROUTING_TO_SUBGRAPH_POLYLINE

protected static final java.lang.String VALUE_ROUTING_TO_SUBGRAPH_POLYLINE

See Also:

Constant Field Values

VALUE_ROUTING_TO_SUBGRAPH_ORTHOGONALLY

protected static final java.lang.String VALUE_ROUTING_TO_SUBGRAPH_ORTHOGONALLY

See Also:

Constant Field Values

VALUE_ROUTING_TO_SUBGRAPH_ORGANIC

protected static final java.lang.String VALUE_ROUTING_TO_SUBGRAPH_ORGANIC

See Also:

Constant Field Values

ITEM_MODE_COMPONENT_ASSIGNMENT

protected static final java.lang.String ITEM_MODE_COMPONENT_ASSIGNMENT

See Also:

Constant Field Values

VALUE_MODE_COMPONENT_CONNECTED

protected static final java.lang.String VALUE_MODE_COMPONENT_CONNECTED

See Also:

Constant Field Values

VALUE_MODE_COMPONENT_SINGLE

protected static final java.lang.String VALUE_MODE_COMPONENT_SINGLE

See Also:

Constant Field Values

VALUE_MODE_COMPONENT_CLUSTERING

protected static final java.lang.String VALUE_MODE_COMPONENT_CLUSTERING

See Also:

Constant Field Values

VALUE_MODE_COMPONENT_CUSTOMIZED

protected static final java.lang.String VALUE_MODE_COMPONENT_CUSTOMIZED

See Also:

Constant Field Values

ITEM_SUBGRAPH_LAYOUTER

protected static final java.lang.String ITEM_SUBGRAPH_LAYOUTER

See Also:

Constant Field Values

VALUE_SUBGRAPH_LAYOUTER_IHL

protected static final java.lang.String VALUE_SUBGRAPH_LAYOUTER_IHL

See Also:

Constant Field Values

VALUE_SUBGRAPH_LAYOUTER_ORGANIC

protected static final java.lang.String VALUE_SUBGRAPH_LAYOUTER_ORGANIC

See Also:

Constant Field Values

VALUE_SUBGRAPH_LAYOUTER_CIRCULAR

protected static final java.lang.String VALUE_SUBGRAPH_LAYOUTER_CIRCULAR

See Also:

Constant Field Values

VALUE_SUBGRAPH_LAYOUTER_ORTHOGONAL

protected static final java.lang.String VALUE_SUBGRAPH_LAYOUTER_ORTHOGONAL

See Also:

Constant Field Values

VALUE_SUBGRAPH_LAYOUTER_NO_LAYOUT

protected static final java.lang.String VALUE_SUBGRAPH_LAYOUTER_NO_LAYOUT

See Also:

Constant Field Values

ITEM_SUBGRAPH_POSITION_STRATEGY

protected static final java.lang.String ITEM_SUBGRAPH_POSITION_STRATEGY

See Also:

Constant Field Values

VALUE_SUBGRAPH_POSITIONING_STRATEGY_BARYCENTER

protected static final java.lang.String VALUE_SUBGRAPH_POSITIONING_STRATEGY_BARYCENTER

See Also:

Constant Field Values

VALUE_SUBGRAPH_POSITIONING_STRATEGY_FROM_SKETCH

protected static final java.lang.String VALUE_SUBGRAPH_POSITIONING_STRATEGY_FROM_SKETCH

See Also:

Constant Field Values

ITEM_MIN_NODE_DIST

protected static final java.lang.String ITEM_MIN_NODE_DIST

See Also:

Constant Field Values

ITEM_ORIENTATION_MAIN_GRAPH

protected static final java.lang.String ITEM_ORIENTATION_MAIN_GRAPH

See Also:

Constant Field Values

VALUE_ORIENTATION_MAIN_GRAPH_AUTO_DETECT

protected static final java.lang.String VALUE_ORIENTATION_MAIN_GRAPH_AUTO_DETECT

See Also:

Constant Field Values

VALUE_ORIENTATION_MAIN_GRAPH_TOP_TO_DOWN

protected static final java.lang.String VALUE_ORIENTATION_MAIN_GRAPH_TOP_TO_DOWN

See Also:

Constant Field Values

VALUE_ORIENTATION_MAIN_GRAPH_DOWN_TO_TOP

protected static final java.lang.String VALUE_ORIENTATION_MAIN_GRAPH_DOWN_TO_TOP

See Also:

Constant Field Values

VALUE_ORIENTATION_MAIN_GRAPH_LEFT_TO_RIGHT

protected static final java.lang.String VALUE_ORIENTATION_MAIN_GRAPH_LEFT_TO_RIGHT

See Also:

Constant Field Values

VALUE_ORIENTATION_MAIN_GRAPH_RIGHT_TO_LEFT

protected static final java.lang.String VALUE_ORIENTATION_MAIN_GRAPH_RIGHT_TO_LEFT

See Also:

Constant Field Values

VALUE_ORIENTATION_MAIN_GRAPH_NONE

protected static final java.lang.String VALUE_ORIENTATION_MAIN_GRAPH_NONE

See Also:

Constant Field Values

ITEM_CONSIDER_SNAPLINES

protected static final java.lang.String ITEM_CONSIDER_SNAPLINES

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_MOVING_FIXED_ELEMENTS_ALLOWED

protected static final java.lang.String ITEM_MOVING_FIXED_ELEMENTS_ALLOWED

See Also:

Constant Field Values

TITLE_IDENTIFY_PARTIAL_ELEMENTS

protected static final java.lang.String TITLE_IDENTIFY_PARTIAL_ELEMENTS

See Also:

Constant Field Values

ITEM_USE_AS_CRITERIA

protected static final java.lang.String ITEM_USE_AS_CRITERIA

See Also:

Constant Field Values

ITEM_ELEMENT_COLOR

protected static final java.lang.String ITEM_ELEMENT_COLOR

See Also:

Constant Field Values

ITEM_SELECTION

protected static final java.lang.String ITEM_SELECTION

See Also:

Constant Field Values

Constructor Detail

PartialLayoutModule

public PartialLayoutModule()

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(PartialLayouter partial,
                         OptionHandler options)

Configures the module's layout algorithm according to the given options.

Parameters:

partial - the PartialLayouter to be configured

options - the layout options to set