com.nomagic.magicdraw.uml.symbols.layout

Class AbstractLinkDiagramLayouter

java.lang.Object

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

com.nomagic.magicdraw.uml.symbols.layout.AbstractLinkDiagramLayouter

All Implemented Interfaces:

DiagramLayouter

Direct Known Subclasses:

OrganicLinkDiagramLayouter, OrthogonalLinkDiagramLayouter

@OpenApiAll
public abstract class AbstractLinkDiagramLayouter
extends AbstractDiagramLayouter

Layout the diagram symbols in diagram.

Constructor Summary

Constructors

Constructor and Description
AbstractLinkDiagramLayouter(java.lang.String optionId, boolean nodes, boolean paths, boolean supportsSubgraph) Construct AbstractLinkDiagramLayouter with the given argument.

Method Summary

Modifier and Type	Method and Description
protected void	clearOldRectangles(UMLGraph graph) Clears old rectangles for shapes.
protected boolean	containsSelectedFromTheSameParent(DiagramPresentationElement dpe) Checks if selected elements have the same parent.
protected UMLGraph	createGraph(DiagramPresentationElement dpe, AbstractDiagramLayouterOptionsGroup optionsGroup) Constructs a graph for layout
static java.util.Set<PresentationElement>	getConnectedPaths(DiagramPresentationElement diagramView) Gets the selected paths and any paths that are connected to selected shapes.
protected java.util.Set<PresentationElement>	getSelected(DiagramPresentationElement diagramView) Collects a set of selected presentation elements in a diagram
protected void	placeLegendAndInfo(DiagramPresentationElement diagram, UMLGraph graph) Places diagram legends and infos.
protected void	postprocessing(UMLGraph graph, com.nomagic.magicdraw.commands.MacroCommand mc) Does some post processing after layout.
protected void	resizeFrameIfNecessary(DiagramPresentationElement dpe, UMLGraph graph, com.nomagic.magicdraw.commands.MacroCommand mc) Resizes diagram frame if there are no elements selected.

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

createGraph, isSubgraphLayout, isTypeSupported, layout, 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

AbstractLinkDiagramLayouter

public AbstractLinkDiagramLayouter(java.lang.String optionId,
                                   boolean nodes,
                                   boolean paths,
                                   boolean supportsSubgraph)

Construct AbstractLinkDiagramLayouter with the given argument.

Parameters:

optionId - String.

nodes - boolean.

paths - boolean.

supportsSubgraph - boolean.

Method Detail

createGraph

@OpenApi
protected UMLGraph createGraph(DiagramPresentationElement dpe,
                                        AbstractDiagramLayouterOptionsGroup optionsGroup)

Constructs a graph for layout

Overrides:

createGraph in class AbstractDiagramLayouter

Parameters:

dpe - shapes and edges are taken from this diagram

optionsGroup - layouter options

Returns:

a created UMLGraph

resizeFrameIfNecessary

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

Description copied from class: AbstractDiagramLayouter

Resizes diagram frame if there are no elements selected.

Overrides:

resizeFrameIfNecessary in class AbstractDiagramLayouter

Parameters:

dpe - diagram

mc - macro command

postprocessing

protected void postprocessing(UMLGraph graph,
                              com.nomagic.magicdraw.commands.MacroCommand mc)

Description copied from class: AbstractDiagramLayouter

Does some post processing after layout. Moves the graph, layouts swimlanes.

Overrides:

postprocessing in class AbstractDiagramLayouter

Parameters:

graph - the graph data for post processing

containsSelectedFromTheSameParent

protected boolean containsSelectedFromTheSameParent(DiagramPresentationElement dpe)

Description copied from class: AbstractDiagramLayouter

Checks if selected elements have the same parent. if nothing is selected return true

Overrides:

containsSelectedFromTheSameParent in class AbstractDiagramLayouter

getSelected

protected java.util.Set<PresentationElement> getSelected(DiagramPresentationElement diagramView)

Description copied from class: AbstractDiagramLayouter

Collects a set of selected presentation elements in a diagram

Overrides:

getSelected in class AbstractDiagramLayouter

Parameters:

diagramView - the diagram that elements were selected in

Returns:

a set of selected presentation elements in a diagram

getConnectedPaths

public static java.util.Set<PresentationElement> getConnectedPaths(DiagramPresentationElement diagramView)

Gets the selected paths and any paths that are connected to selected shapes. Paths connected by other shape element on shape edge are also included

Parameters:

diagramView - diagram

Returns:

a set of path elements that should be processed

clearOldRectangles

protected void clearOldRectangles(UMLGraph graph)

Description copied from class: AbstractDiagramLayouter

Clears old rectangles for shapes. The old rectangle is used for link placement in movePath, MoveManager.

Overrides:

clearOldRectangles in class AbstractDiagramLayouter

Parameters:

graph - layouted graph

placeLegendAndInfo

protected void placeLegendAndInfo(DiagramPresentationElement diagram,
                                  UMLGraph graph)

Description copied from class: AbstractDiagramLayouter

Places diagram legends and infos.

Overrides:

placeLegendAndInfo in class AbstractDiagramLayouter

Parameters:

diagram - diagram