Search this API

y.module
Class FamilyTreeLayoutModule

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

public class FamilyTreeLayoutModule
extends LayoutModule

This module represents an interactive configurator and launcher for FamilyTreeLayouter.

 

Field Summary
protected static java.lang.String ITEM_COMPONENT_DISTANCE
           
protected static java.lang.String ITEM_COMPONENT_STYLE
           
protected static java.lang.String ITEM_FAMILIES_ALWAYS_BELOW
           
protected static java.lang.String ITEM_FAMILY_COLOR
           
protected static java.lang.String ITEM_FEMALE_COLOR
           
protected static java.lang.String ITEM_HORIZONTAL_SPACING
           
protected static java.lang.String ITEM_MALE_COLOR
           
protected static java.lang.String ITEM_MINIMUM_FIRST_SEGMENT
           
protected static java.lang.String ITEM_MINIMUM_LAST_SEGMENT
           
protected static java.lang.String ITEM_MINIMUM_LAYER_DISTANCE
           
protected static java.lang.String ITEM_NODE_ALIGNMENT
           
protected static java.lang.String ITEM_NODE_TO_NODE_DISTANCE
           
protected static java.lang.String ITEM_ORIENTATION
           
protected static java.lang.String ITEM_SINGLE_DIRECT_BELOW
           
protected static java.lang.String ITEM_SORT_BY_SEX
           
protected static java.lang.String ITEM_USE_COMPONENT_LAYOUTER
           
protected static java.lang.String ITEM_VERTICAL_SPACING
           
protected static java.lang.String MODULE_FAMILY_TREE_LAYOUTER
           
protected static java.lang.String SECTION_ADVANCED_LAYOUT
           
protected static java.lang.String SECTION_DISTANCES
           
protected static java.lang.String SECTION_FAMILY_PROPERTIES
           
protected static java.lang.String SECTION_LAYOUT
           
protected static java.lang.String TITLE_COMPONENT_LAYOUTER
           
protected static java.lang.String TITLE_GENERATION_DISTANCES
           
protected static java.lang.String TITLE_SIBLING_DISTANCES
           
protected static java.lang.String VALUE_BOTTOM_TO_TOP
           
protected static java.lang.String VALUE_COMPONENT_STYLE_NONE
           
protected static java.lang.String VALUE_COMPONENT_STYLE_PACKED_CIRCLE
           
protected static java.lang.String VALUE_COMPONENT_STYLE_PACKED_COMPACT_CIRCLE
           
protected static java.lang.String VALUE_COMPONENT_STYLE_PACKED_COMPACT_RECTANGLE
           
protected static java.lang.String VALUE_COMPONENT_STYLE_PACKED_RECTANGLE
           
protected static java.lang.String VALUE_COMPONENT_STYLE_ROWS
           
protected static java.lang.String VALUE_COMPONENT_STYLE_SINGLE_COLUMN
           
protected static java.lang.String VALUE_COMPONENT_STYLE_SINGLE_ROW
           
protected static java.lang.String VALUE_DO_NOT_SORT
           
protected static java.lang.String VALUE_FEMALE_ALWAYS_LEFT
           
protected static java.lang.String VALUE_FEMALE_LEFT
           
protected static java.lang.String VALUE_LEFT_TO_RIGHT
           
protected static java.lang.String VALUE_MALE_ALWAYS_LEFT
           
protected static java.lang.String VALUE_MALE_LEFT
           
protected static java.lang.String VALUE_NODE_ALIGN_BOTTOM
           
protected static java.lang.String VALUE_NODE_ALIGN_CENTER
           
protected static java.lang.String VALUE_NODE_ALIGN_TOP
           
protected static java.lang.String VALUE_RIGHT_TO_LEFT
           
protected static java.lang.String VALUE_TOP_TO_BOTTOM
           
 
Fields inherited from class y.module.YModule
FAILED, moduleListenerSupport, PRECONDITION_VIOLATED, SUCCESS
 
Constructor Summary
FamilyTreeLayoutModule()
          Creates an instance of this module.
 
Method Summary
protected  void configure(FamilyTreeLayouter familyTree, 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_FAMILY_TREE_LAYOUTER

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

SECTION_FAMILY_PROPERTIES

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

ITEM_FAMILY_COLOR

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

ITEM_MALE_COLOR

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

ITEM_FEMALE_COLOR

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

SECTION_LAYOUT

protected static final java.lang.String SECTION_LAYOUT
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_SINGLE_DIRECT_BELOW

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

ITEM_FAMILIES_ALWAYS_BELOW

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

ITEM_NODE_ALIGNMENT

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

VALUE_NODE_ALIGN_TOP

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

VALUE_NODE_ALIGN_CENTER

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

VALUE_NODE_ALIGN_BOTTOM

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

ITEM_SORT_BY_SEX

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

VALUE_DO_NOT_SORT

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

VALUE_FEMALE_LEFT

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

VALUE_FEMALE_ALWAYS_LEFT

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

VALUE_MALE_LEFT

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

VALUE_MALE_ALWAYS_LEFT

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

SECTION_DISTANCES

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

TITLE_SIBLING_DISTANCES

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

ITEM_HORIZONTAL_SPACING

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

TITLE_GENERATION_DISTANCES

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

ITEM_VERTICAL_SPACING

protected static final java.lang.String ITEM_VERTICAL_SPACING
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_MINIMUM_FIRST_SEGMENT

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

ITEM_MINIMUM_LAST_SEGMENT

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

SECTION_ADVANCED_LAYOUT

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

ITEM_USE_COMPONENT_LAYOUTER

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

TITLE_COMPONENT_LAYOUTER

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

ITEM_COMPONENT_DISTANCE

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

ITEM_COMPONENT_STYLE

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

VALUE_COMPONENT_STYLE_NONE

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

VALUE_COMPONENT_STYLE_ROWS

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

VALUE_COMPONENT_STYLE_SINGLE_ROW

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

VALUE_COMPONENT_STYLE_SINGLE_COLUMN

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

VALUE_COMPONENT_STYLE_PACKED_RECTANGLE

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

VALUE_COMPONENT_STYLE_PACKED_COMPACT_RECTANGLE

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

VALUE_COMPONENT_STYLE_PACKED_CIRCLE

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

VALUE_COMPONENT_STYLE_PACKED_COMPACT_CIRCLE

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

FamilyTreeLayoutModule

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

Parameters:
familyTree - the FamilyTreeLayouter to be configured
options - the layout options to set

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