Search this API

y.module
Class BalloonLayoutModule

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

public class BalloonLayoutModule
extends LayoutModule

This module represents an interactive configurator and launcher for BalloonLayouter.

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

Field Summary
protected static java.lang.String EDGE_BUNDLING_STRENGTH
           
protected static java.lang.String ITEM_ACT_ON_SELECTION_ONLY
           
protected static java.lang.String ITEM_ALLOW_OVERLAPS
           
protected static java.lang.String ITEM_BALLOON_FROM_SKETCH
           
protected static java.lang.String ITEM_COMPACTNESS_FACTOR
           
protected static java.lang.String ITEM_INTEGRATED_EDGE_LABELING
           
protected static java.lang.String ITEM_MINIMAL_EDGE_LENGTH
           
protected static java.lang.String ITEM_NODE_LABELING_STYLE
           
protected static java.lang.String ITEM_PLACE_CHILDREN_INTERLEAVED
           
protected static java.lang.String ITEM_PREFERRED_CHILD_WEDGE
           
protected static java.lang.String ITEM_PREFERRED_ROOT_WEDGE
           
protected static java.lang.String ITEM_ROOT_NODE_POLICY
           
protected static java.lang.String ITEM_ROUTING_STYLE_FOR_NON_TREE_EDGES
           
protected static java.lang.String ITEM_STRAIGHTEN_CHAINS
           
protected static java.lang.String MODULE_BALLOON
           
protected static java.lang.String SECTION_GENERAL
           
protected static java.lang.String SECTION_LABELING
           
protected static java.lang.String VALUE_CENTER_ROOT
           
protected static java.lang.String VALUE_DIRECTED_ROOT
           
protected static java.lang.String VALUE_NODE_LABELING_STYLE_CONSIDER_CURRENT_POSITION
           
protected static java.lang.String VALUE_NODE_LABELING_STYLE_HORIZONTAL
           
protected static java.lang.String VALUE_NODE_LABELING_STYLE_NONE
           
protected static java.lang.String VALUE_NODE_LABELING_STYLE_RAYLIKE_LEAVES
           
protected static java.lang.String VALUE_ROUTE_BUNDLED
           
protected static java.lang.String VALUE_ROUTE_ORGANIC
           
protected static java.lang.String VALUE_ROUTE_ORTHOGONAL
           
protected static java.lang.String VALUE_ROUTE_STRAIGHTLINE
           
protected static java.lang.String VALUE_SELECTED_ROOT
           
protected static java.lang.String VALUE_WEIGHTED_CENTER_ROOT
           
 
Fields inherited from class y.module.YModule
FAILED, moduleListenerSupport, PRECONDITION_VIOLATED, SUCCESS
 
Constructor Summary
BalloonLayoutModule()
          Creates an instance of this module.
 
Method Summary
protected  void configure(BalloonLayouter balloon, 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 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_BALLOON

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

SECTION_GENERAL

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

ITEM_ROOT_NODE_POLICY

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

VALUE_DIRECTED_ROOT

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

VALUE_CENTER_ROOT

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

VALUE_SELECTED_ROOT

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

VALUE_WEIGHTED_CENTER_ROOT

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

ITEM_ROUTING_STYLE_FOR_NON_TREE_EDGES

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

VALUE_ROUTE_ORGANIC

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

VALUE_ROUTE_ORTHOGONAL

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

VALUE_ROUTE_STRAIGHTLINE

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

VALUE_ROUTE_BUNDLED

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

ITEM_ACT_ON_SELECTION_ONLY

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

ITEM_PREFERRED_CHILD_WEDGE

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

ITEM_PREFERRED_ROOT_WEDGE

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

ITEM_MINIMAL_EDGE_LENGTH

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

ITEM_COMPACTNESS_FACTOR

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

ITEM_ALLOW_OVERLAPS

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

ITEM_BALLOON_FROM_SKETCH

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

ITEM_PLACE_CHILDREN_INTERLEAVED

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

ITEM_STRAIGHTEN_CHAINS

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

EDGE_BUNDLING_STRENGTH

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

SECTION_LABELING

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

ITEM_NODE_LABELING_STYLE

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

VALUE_NODE_LABELING_STYLE_NONE

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

VALUE_NODE_LABELING_STYLE_HORIZONTAL

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

VALUE_NODE_LABELING_STYLE_RAYLIKE_LEAVES

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

VALUE_NODE_LABELING_STYLE_CONSIDER_CURRENT_POSITION

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

ITEM_INTEGRATED_EDGE_LABELING

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

BalloonLayoutModule

public BalloonLayoutModule()
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

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

Parameters:
balloon - the BalloonLayouter to be configured
options - the layout options to set

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