Package com.nomagic.magicdraw.uml.symbols.layout

Class AbstractHierarchicDiagramLayouter

java.lang.Object

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

com.nomagic.magicdraw.uml.symbols.layout.AbstractHierarchicDiagramLayouter

All Implemented Interfaces:

DiagramLayouter, Cloneable

Direct Known Subclasses:

HierarchicDiagramLayouter

@OpenApi
@Deprecated
public abstract class AbstractHierarchicDiagramLayouter
extends AbstractDiagramLayouter

Deprecated.

use Layouting class for layouting a diagram

Field Summary

Fields

Modifier and Type	Field	Description
protected com.dassault_systemes.modeler.magic.diagram.ylayout.candidates.AbstractCustomCandidates	can	Deprecated.
protected Collection<com.dassault_systemes.modeler.magic.diagram.ylayout.PathRerouteCollector>	pathRerouteCollectors	Deprecated.

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

layoutParameters

Constructor Summary

Constructors

Constructor	Description
AbstractHierarchicDiagramLayouter(String optionId)	Deprecated, for removal: This API element is subject to removal in a future version. use no-arg constructor

Method Summary

Modifier and Type	Method	Description
protected void	addPathRerouteCollector(com.dassault_systemes.modeler.magic.diagram.ylayout.PathRerouteCollector collector)	Deprecated.
protected void	afterLayout(AbstractDiagramLayouterOptionsGroup options, AbstractDiagramPresentationElement dpe, BaseGraph graph, com.dassault_systemes.modeler.foundation.editing.CompositeCommand mc)	Deprecated.
protected boolean	canSetLocationForOnEdgeShape(ShapeElement shapeElement)	Deprecated.
AbstractHierarchicDiagramLayouter	clone()	Deprecated.
protected void	collectOnEdgeElementsRecursively(Collection<ShapeElement> collectTo, ShapeElement collectFrom)	Deprecated.
protected List<ShapeElement>	collectOnEdgeToResize(BaseGraph graph, AbstractDiagramLayouterOptionsGroup options)	Deprecated.
protected boolean	containsSelectedFromTheSameParent(AbstractDiagramPresentationElement dpe)	Deprecated. Activity layouter should also consider when nodes in TableShapeViews are selected and layouted.
protected y.layout.ComponentLayouter	createComponentLayouter(BaseGraph graph, y.layout.grouping.RecursiveGroupLayouter coreLayouter, HierarchicLayouterOptionsGroup opt)	Deprecated. Creates a component layouter if possible.
protected void	createPathRerouteCollectors()	Deprecated.
protected void	dispose(BaseGraph graph)	Deprecated.
protected void	fixOnFrameElements(BaseGraph graph, AbstractDiagramPresentationElement dpe, HierarchicLayouterOptionsGroup o)	Deprecated. Fixes, moves, sorts overlapping shapes on diagram frame.
Collection<com.dassault_systemes.modeler.magic.diagram.ylayout.PathRerouteCollector>	getPathRerouteCollectors()	Deprecated.
protected Collection<com.nomagic.magicdraw.uml.symbols.shapes.TableShapeView>	getTableShapeViewsInFirstLevel(AbstractDiagramPresentationElement dpe)	Deprecated.
protected y.layout.hierarchic.IncrementalHierarchicLayouter	initDefaultHierarchicSettings(HierarchicLayouterOptionsGroup opt, BaseGraph graph)	Deprecated. 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 static boolean	isLayoutAsGrid(BaseGraph graph)	Deprecated. Checks if the graph should be layouted as grid
protected boolean	layout(AbstractDiagramLayouterOptionsGroup opt, AbstractDiagramPresentationElement dpe, BaseGraph graph)	Deprecated, for removal: This API element is subject to removal in a future version.
protected void	moveOutOfFrameHeader(AbstractDiagramPresentationElement diagram, HierarchicLayouterOptionsGroup o)	Deprecated. Moves elements of the diagram frame header view, so that they would not overlap
protected void	preProcessing(AbstractDiagramLayouterOptionsGroup options, AbstractDiagramPresentationElement dpe, com.dassault_systemes.modeler.foundation.editing.CompositeCommand mc)	Deprecated.
protected void	resizeOnEdgeElements(BaseGraph graph, AbstractDiagramLayouterOptionsGroup options)	Deprecated. Resizes elements on edge to the minimal size.
protected void	resizeOnEdgeShapes(AbstractDiagramLayouterOptionsGroup options, Collection<ShapeElement> shapesToResize)	Deprecated.
protected void	routeNonRoutedPaths(BaseGraph graph, AbstractDiagramPresentationElement dpe, AbstractDiagramLayouterOptionsGroup options, com.dassault_systemes.modeler.foundation.editing.CompositeCommand mc, Collection<com.dassault_systemes.modeler.magic.diagram.ylayout.PathRerouteCollector> rerouteCollectors)	Deprecated.
protected void	runIHLLayoutSeries(y.layout.hierarchic.IncrementalHierarchicLayouter ihl, BaseGraph graph, HierarchicLayouterOptionsGroup options)	Deprecated.
protected y.layout.Layouter	wrapToAccordingGroupLayouter(BaseGraph graph, y.layout.hierarchic.IncrementalHierarchicLayouter layouter, HierarchicLayouterOptionsGroup opt, boolean fromSketch)	Deprecated.

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

afterLayout, canLayout, clearOldRectangles, createCommands, createGraph, createGraph, createGraph, drawLayoutResults, getAnchoredPresentationElement, getDiagramLayouterAbortHandler, getLayoutParameter, getOptionsID, getSelected, isTypeSupported, layout, layoutGraph, placeLegendAndInfo, postprocessing, resizeOuterBoundaryIfNecessary, setAnchoredPresentationElement, setDefaultLayoutParameters, setLabelConsiderationMode, setLayoutParameter

Methods inherited from class java.lang.Object

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

Field Details

can

@CheckForNull
protected com.dassault_systemes.modeler.magic.diagram.ylayout.candidates.AbstractCustomCandidates can

Deprecated.

pathRerouteCollectors

protected Collection<com.dassault_systemes.modeler.magic.diagram.ylayout.PathRerouteCollector> pathRerouteCollectors

Deprecated.

Constructor Details

AbstractHierarchicDiagramLayouter

@OpenApi
@Deprecated(since="2024x Refresh3",
            forRemoval=true)
public AbstractHierarchicDiagramLayouter(String optionId)

Deprecated, for removal: This API element is subject to removal in a future version.

use no-arg constructor

Method Details

initDefaultHierarchicSettings

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

Deprecated.

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

runIHLLayoutSeries

protected void runIHLLayoutSeries(y.layout.hierarchic.IncrementalHierarchicLayouter ihl,
 BaseGraph graph,
 HierarchicLayouterOptionsGroup options)

Deprecated.

wrapToAccordingGroupLayouter

protected y.layout.Layouter wrapToAccordingGroupLayouter(BaseGraph graph,
 y.layout.hierarchic.IncrementalHierarchicLayouter layouter,
 HierarchicLayouterOptionsGroup opt,
 boolean fromSketch)

Deprecated.

createComponentLayouter

@CheckForNull
protected y.layout.ComponentLayouter createComponentLayouter(BaseGraph graph,
 y.layout.grouping.RecursiveGroupLayouter coreLayouter,
 HierarchicLayouterOptionsGroup opt)

Deprecated.

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, tableShape partitions etc. are used

Parameters:

graph - layouted graph

coreLayouter - the core layouter for component layouter

opt - hierarchic options

Returns:

a component layouter if possible.

isLayoutAsGrid

protected static boolean isLayoutAsGrid(BaseGraph graph)

Deprecated.

Checks if the graph should be layouted as grid

Parameters:

graph - graph to check

Returns:

true if should layout the graph as grid, false otherwise

layout

@OpenApi
@Deprecated(since="2024x Refresh3",
            forRemoval=true)
protected boolean layout(AbstractDiagramLayouterOptionsGroup opt,
 AbstractDiagramPresentationElement dpe,
 BaseGraph graph)

Deprecated, for removal: This API element is subject to removal in a future version.

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(BaseGraph graph,
 AbstractDiagramLayouterOptionsGroup options)

Deprecated.

Resizes elements on edge to the minimal size.

Parameters:

graph - layouted graph

options - options that may be regarded while adjusting

collectOnEdgeToResize

protected List<ShapeElement> collectOnEdgeToResize(BaseGraph graph,
 AbstractDiagramLayouterOptionsGroup options)

Deprecated.

resizeOnEdgeShapes

protected void resizeOnEdgeShapes(AbstractDiagramLayouterOptionsGroup options,
 Collection<ShapeElement> shapesToResize)

Deprecated.

canSetLocationForOnEdgeShape

protected boolean canSetLocationForOnEdgeShape(ShapeElement shapeElement)

Deprecated.

collectOnEdgeElementsRecursively

protected void collectOnEdgeElementsRecursively(Collection<ShapeElement> collectTo,
 ShapeElement collectFrom)

Deprecated.

preProcessing

protected void preProcessing(AbstractDiagramLayouterOptionsGroup options,
 AbstractDiagramPresentationElement dpe,
 @CheckForNull
 com.dassault_systemes.modeler.foundation.editing.CompositeCommand mc)

Deprecated.

Overrides:

preProcessing in class AbstractDiagramLayouter

afterLayout

protected void afterLayout(AbstractDiagramLayouterOptionsGroup options,
 AbstractDiagramPresentationElement dpe,
 BaseGraph graph,
 com.dassault_systemes.modeler.foundation.editing.CompositeCommand mc)

Deprecated.

Overrides:

afterLayout in class AbstractDiagramLayouter

routeNonRoutedPaths

protected void routeNonRoutedPaths(BaseGraph graph,
 AbstractDiagramPresentationElement dpe,
 @CheckForNull
 AbstractDiagramLayouterOptionsGroup options,
 com.dassault_systemes.modeler.foundation.editing.CompositeCommand mc,
 Collection<com.dassault_systemes.modeler.magic.diagram.ylayout.PathRerouteCollector> rerouteCollectors)

Deprecated.

fixOnFrameElements

protected void fixOnFrameElements(BaseGraph graph,
 AbstractDiagramPresentationElement dpe,
 HierarchicLayouterOptionsGroup o)

Deprecated.

Fixes, moves, sorts overlapping shapes on diagram frame.

Parameters:

graph - the graph that is layouted

dpe - diagram

o - options group

moveOutOfFrameHeader

protected void moveOutOfFrameHeader(AbstractDiagramPresentationElement diagram,
 HierarchicLayouterOptionsGroup o)

Deprecated.

Moves elements of the diagram frame header view, so that they would not overlap

Parameters:

diagram - the diagram

createPathRerouteCollectors

protected void createPathRerouteCollectors()

Deprecated.

addPathRerouteCollector

protected void addPathRerouteCollector(com.dassault_systemes.modeler.magic.diagram.ylayout.PathRerouteCollector collector)

Deprecated.

getPathRerouteCollectors

public Collection<com.dassault_systemes.modeler.magic.diagram.ylayout.PathRerouteCollector> getPathRerouteCollectors()

Deprecated.

dispose

protected void dispose(BaseGraph graph)

Deprecated.

Overrides:

dispose in class AbstractDiagramLayouter

clone

public AbstractHierarchicDiagramLayouter clone()

Deprecated.

Overrides:

clone in class AbstractDiagramLayouter

getTableShapeViewsInFirstLevel

protected Collection<com.nomagic.magicdraw.uml.symbols.shapes.TableShapeView> getTableShapeViewsInFirstLevel(AbstractDiagramPresentationElement dpe)

Deprecated.

containsSelectedFromTheSameParent

protected boolean containsSelectedFromTheSameParent(AbstractDiagramPresentationElement dpe)

Deprecated.

Activity layouter should also consider when nodes in TableShapeViews are selected and layouted.

Overrides:

containsSelectedFromTheSameParent in class AbstractDiagramLayouter

Parameters:

dpe - diagram

Returns:

true if selected in same cell(can also have elements that are owned by whole tableShape)