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, com.nomagic.magicdraw.uml.symbols.DiagramPresentationElement dpe, UMLGraph graph, com.nomagic.magicdraw.commands.MacroCommand mc)
boolean	canIntegrateLabels() Determines if a layouter can integrate labels(change symbol positions in a graph) into layout calculation
java.util.List<PathElement>	collectOutgoingFromNonNode(com.nomagic.magicdraw.uml.symbols.DiagramPresentationElement dpe)
java.util.List<PathElement>	collectPathsOneEndLayoutedOtherNot(com.nomagic.magicdraw.uml.symbols.DiagramPresentationElement dpe, UMLGraph umlGraph)
protected java.util.Set<PathElement>	findPathToRelayout(UMLGraph umlGraph, com.nomagic.magicdraw.uml.symbols.DiagramPresentationElement dpe)
protected void	fixOnFrameElements(UMLGraph graph, com.nomagic.magicdraw.uml.symbols.DiagramPresentationElement dpe, HierarchicLayouterOptionsGroup o) Fixes, moves, sorts overlapping shapes on diagram frame.
java.util.Vector<com.nomagic.magicdraw.uml.symbols.PresentationElement>	getAllUnlayoutableSymbols(com.nomagic.magicdraw.uml.symbols.DiagramPresentationElement dpe)
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, com.nomagic.magicdraw.uml.symbols.DiagramPresentationElement dpe, UMLGraph graph) Layouts a diagram
protected void	preProcessing(AbstractDiagramLayouterOptionsGroup options, com.nomagic.magicdraw.uml.symbols.DiagramPresentationElement dpe, com.nomagic.magicdraw.commands.MacroCommand mc)
protected void	resizeOnEdgeElements(UMLGraph graph) Resizes elements on edge to the minimal size.
protected void	routeNonRoutedPaths(UMLGraph graph, com.nomagic.magicdraw.uml.symbols.DiagramPresentationElement dpe, HierarchicLayouterOptionsGroup o, com.nomagic.magicdraw.commands.MacroCommand mc, java.util.Set<PathElement> pathToReroute) Routes paths from unlayouted to layouted parts of diagram, from diagram frame, etc.
protected y.layout.grouping.RecursiveGroupLayouter	wrapToAccordingGroupLayouter(UMLGraph graph, y.layout.hierarchic.IncrementalHierarchicLayouter layouter)

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

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.grouping.RecursiveGroupLayouter wrapToAccordingGroupLayouter(UMLGraph graph,
                                                                                y.layout.hierarchic.IncrementalHierarchicLayouter layouter)

layout

protected boolean layout(AbstractDiagramLayouterOptionsGroup opt,
                         com.nomagic.magicdraw.uml.symbols.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)

Resizes elements on edge to the minimal size.

Parameters:

graph - layouted graph

preProcessing

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

Overrides:

preProcessing in class AbstractDiagramLayouter

afterLayout

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

Overrides:

afterLayout in class AbstractDiagramLayouter

canIntegrateLabels

public boolean canIntegrateLabels()

Description copied from class: AbstractDiagramLayouter

Determines if a layouter can integrate labels(change symbol positions in a graph) into layout calculation

Overrides:

canIntegrateLabels in class AbstractDiagramLayouter

Returns:

true if labels can be integrated (also allows association class layouting as a label)

fixOnFrameElements

protected void fixOnFrameElements(UMLGraph graph,
                                  com.nomagic.magicdraw.uml.symbols.DiagramPresentationElement dpe,
                                  HierarchicLayouterOptionsGroup o)

Fixes, moves, sorts overlapping shapes on diagram frame.

Parameters:

graph - the graph that is layouted

dpe - diagram

o - options group

routeNonRoutedPaths

protected void routeNonRoutedPaths(UMLGraph graph,
                                   com.nomagic.magicdraw.uml.symbols.DiagramPresentationElement dpe,
                                   @CheckForNull
                                   HierarchicLayouterOptionsGroup o,
                                   com.nomagic.magicdraw.commands.MacroCommand mc,
                                   java.util.Set<PathElement> pathToReroute)

Routes paths from unlayouted to layouted parts of diagram, from diagram frame, etc.

Parameters:

graph - the graph that is layouted

dpe - diagram

o - options group

mc - macro command

findPathToRelayout

@Nonnull
protected java.util.Set<PathElement> findPathToRelayout(UMLGraph umlGraph,
                                                                 com.nomagic.magicdraw.uml.symbols.DiagramPresentationElement dpe)

collectPathsOneEndLayoutedOtherNot

public java.util.List<PathElement> collectPathsOneEndLayoutedOtherNot(com.nomagic.magicdraw.uml.symbols.DiagramPresentationElement dpe,
                                                                      UMLGraph umlGraph)

collectOutgoingFromNonNode

public java.util.List<PathElement> collectOutgoingFromNonNode(com.nomagic.magicdraw.uml.symbols.DiagramPresentationElement dpe)

getAllUnlayoutableSymbols

public java.util.Vector<com.nomagic.magicdraw.uml.symbols.PresentationElement> getAllUnlayoutableSymbols(com.nomagic.magicdraw.uml.symbols.DiagramPresentationElement dpe)