com.nomagic.magicdraw.uml.symbols.layout

Class HierarchicDiagramLayouter

java.lang.Object

com.nomagic.magicdraw.uml.symbols.layout.AbstractDiagramLayouter

com.nomagic.magicdraw.uml.symbols.layout.HierarchicDiagramLayouter

All Implemented Interfaces:

DiagramLayouter

Direct Known Subclasses:

ActivityDiagramLayouter, CompositeStructureDiagramLayouter, StateDiagramLayouter

@OpenApiAll
public class HierarchicDiagramLayouter
extends AbstractDiagramLayouter

Hierarchic layouter.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	HierarchicDiagramLayouter.PEXComparator Comparator for sorting presentation elements by their x position.

Constructor Summary

Constructors

Constructor and Description
HierarchicDiagramLayouter() Construct HierarchicDiagramLayouter
HierarchicDiagramLayouter(java.lang.String optionId) Construct HierarchicDiagramLayouter

Method Summary

Modifier and Type	Method and Description
protected void	afterLayout(AbstractDiagramLayouterOptionsGroup options, DiagramPresentationElement dpe, UMLGraph graph, com.nomagic.magicdraw.commands.MacroCommand mc)
protected y.layout.ComponentLayouter	createComponentLayouter(UMLGraph graph, y.layout.Layouter coreLayouter, HierarchicLayouterOptionsGroup opt) Creates a component layouter if possible.
protected void	fixOnFrameElements(UMLGraph graph, DiagramPresentationElement dpe, HierarchicLayouterOptionsGroup o) Fixes, moves, sorts overlapping shapes on diagram frame.
java.util.Collection<com.nomagic.magicdraw.uml.symbols.layout.PathRerouteCollector>	getPathRerouteCollectors()
protected y.layout.hierarchic.IncrementalHierarchicLayouter	initDefaultHierarchicSettings(HierarchicLayouterOptionsGroup opt, UMLGraph graph) Initializes hierarchic layouter settings: - Enables backlooping - Sets group compaction enabled - Aligns groups in center - Sets routing style to orthogonal - Adds group node insets - Enables label layout - Sets the node sequence within layer.
protected boolean	layout(AbstractDiagramLayouterOptionsGroup opt, DiagramPresentationElement dpe, UMLGraph graph) Layouts a diagram
protected void	preProcessing(AbstractDiagramLayouterOptionsGroup options, DiagramPresentationElement dpe, com.nomagic.magicdraw.commands.MacroCommand mc)
void	registerPathRerouteCollector(com.nomagic.magicdraw.uml.symbols.layout.PathRerouteCollector collector)
protected void	resizeOnEdgeElements(UMLGraph graph, AbstractDiagramLayouterOptionsGroup options) Resizes elements on edge to the minimal size.
protected void	routeNonRoutedPaths(UMLGraph graph, DiagramPresentationElement dpe, AbstractDiagramLayouterOptionsGroup options, com.nomagic.magicdraw.commands.MacroCommand mc, java.util.Collection<com.nomagic.magicdraw.uml.symbols.layout.PathRerouteCollector> rerouteCollectors)
protected y.layout.Layouter	wrapToAccordingGroupLayouter(UMLGraph graph, y.layout.hierarchic.IncrementalHierarchicLayouter layouter, HierarchicLayouterOptionsGroup opt)

Methods inherited from class com.nomagic.magicdraw.uml.symbols.layout.AbstractDiagramLayouter

createGraph, createGraph, getSelected, isSubgraphLayout, isTypeSupported, setSubgraphLayout

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.nomagic.magicdraw.uml.symbols.layout.DiagramLayouter

canLayout, drawLayoutResults, getOptionsID

Constructor Detail

HierarchicDiagramLayouter

public HierarchicDiagramLayouter()

Construct HierarchicDiagramLayouter

HierarchicDiagramLayouter

public HierarchicDiagramLayouter(java.lang.String optionId)

Construct HierarchicDiagramLayouter

Parameters:

optionId - hierarchic diagram layouter options id

Method Detail

initDefaultHierarchicSettings

protected y.layout.hierarchic.IncrementalHierarchicLayouter initDefaultHierarchicSettings(HierarchicLayouterOptionsGroup opt,
                                                                                          UMLGraph graph)

Initializes hierarchic layouter settings: - Enables backlooping - Sets group compaction enabled - Aligns groups in center - Sets routing style to orthogonal - Adds group node insets - Enables label layout - Sets the node sequence within layer.

Parameters:

opt - options

graph - current graph that should be layouted

wrapToAccordingGroupLayouter

protected y.layout.Layouter wrapToAccordingGroupLayouter(UMLGraph graph,
                                                         y.layout.hierarchic.IncrementalHierarchicLayouter layouter,
                                                         HierarchicLayouterOptionsGroup opt)

createComponentLayouter

@CheckForNull
protected y.layout.ComponentLayouter createComponentLayouter(UMLGraph graph,
                                                                           y.layout.Layouter coreLayouter,
                                                                           HierarchicLayouterOptionsGroup opt)

Creates a component layouter if possible. Sub-graphs that can be identified as separate components will be processed and placed to a more convenient location. It may not be possible to create component layouter if sequencing, swimlane partitions etc. are used

Parameters:

graph - layouted graph

coreLayouter - the core layouter for component layouter

opt - hierarchic options

Returns:

a component layouter if possible.

layout

protected boolean layout(AbstractDiagramLayouterOptionsGroup opt,
                         DiagramPresentationElement dpe,
                         UMLGraph graph)

Description copied from class: AbstractDiagramLayouter

Layouts a diagram

Specified by:

layout in class AbstractDiagramLayouter

Parameters:

opt - layouter options

dpe - diagram to layout

graph - a constructed graph from the diagram

Returns:

true if it was layouted successfully , false otherwise.

resizeOnEdgeElements

protected void resizeOnEdgeElements(UMLGraph graph,
                                    AbstractDiagramLayouterOptionsGroup options)

Resizes elements on edge to the minimal size.

Parameters:

graph - layouted graph

options - options that may be regarded while adjusting

preProcessing

protected void preProcessing(AbstractDiagramLayouterOptionsGroup options,
                             DiagramPresentationElement dpe,
                             @CheckForNull
                             com.nomagic.magicdraw.commands.MacroCommand mc)

Overrides:

preProcessing in class AbstractDiagramLayouter

afterLayout

protected void afterLayout(AbstractDiagramLayouterOptionsGroup options,
                           DiagramPresentationElement dpe,
                           UMLGraph graph,
                           com.nomagic.magicdraw.commands.MacroCommand mc)

Overrides:

afterLayout in class AbstractDiagramLayouter

routeNonRoutedPaths

protected void routeNonRoutedPaths(UMLGraph graph,
                                   DiagramPresentationElement dpe,
                                   @CheckForNull
                                   AbstractDiagramLayouterOptionsGroup options,
                                   com.nomagic.magicdraw.commands.MacroCommand mc,
                                   java.util.Collection<com.nomagic.magicdraw.uml.symbols.layout.PathRerouteCollector> rerouteCollectors)

fixOnFrameElements

protected void fixOnFrameElements(UMLGraph graph,
                                  DiagramPresentationElement dpe,
                                  HierarchicLayouterOptionsGroup o)

Fixes, moves, sorts overlapping shapes on diagram frame.

Parameters:

graph - the graph that is layouted

dpe - diagram

o - options group

registerPathRerouteCollector

public final void registerPathRerouteCollector(com.nomagic.magicdraw.uml.symbols.layout.PathRerouteCollector collector)

getPathRerouteCollectors

public java.util.Collection<com.nomagic.magicdraw.uml.symbols.layout.PathRerouteCollector> getPathRerouteCollectors()