com.nomagic.magicdraw.uml.symbols.layout

Class AbstractDiagramLayouter

java.lang.Object

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

All Implemented Interfaces:

DiagramLayouter

Direct Known Subclasses:

AbstractLinkDiagramLayouter, CircularDiagramLayouter, HierarchicDiagramLayouter, OrganicDiagramLayouter, OrthogonalDiagramLayouter, TreeDiagramLayouter

@OpenApi
public abstract class AbstractDiagramLayouter
extends java.lang.Object
implements DiagramLayouter

Abstract diagram layouter contains post processing, preprocessing and other important methods for layouting diagrams.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDiagramLayouter(java.lang.String optionId) Constructor
protected	AbstractDiagramLayouter(java.lang.String optionId, boolean supportsSubgraph) Constructor
protected	AbstractDiagramLayouter(java.lang.String optionId, boolean nodes, boolean paths, boolean supportsSubgraph) Constructor

Method Summary

Modifier and Type	Method and Description
protected UMLGraph	createGraph(com.nomagic.magicdraw.uml.symbols.DiagramPresentationElement dpe, boolean useIntegratedLabels) Constructs a graph for layout
protected java.util.Set<com.nomagic.magicdraw.uml.symbols.PresentationElement>	getSelected(com.nomagic.magicdraw.uml.symbols.DiagramPresentationElement diagramView) Collects a set of selected presentation elements in a diagram
boolean	isSubgraphLayout() Test is graph layout.
boolean	isTypeSupported(DiagramType type) Test the given type is supported.
protected abstract boolean	layout(AbstractDiagramLayouterOptionsGroup opt, com.nomagic.magicdraw.uml.symbols.DiagramPresentationElement dpe, UMLGraph graph) Layouts a diagram
void	setSubgraphLayout(boolean subgraphLayout) Set sub graph layout.

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

AbstractDiagramLayouter

@OpenApi
protected AbstractDiagramLayouter(java.lang.String optionId,
                                           boolean nodes,
                                           boolean paths,
                                           boolean supportsSubgraph)

Constructor

Parameters:

optionId - layouter options id

nodes - true if should layout nodes

paths - true if should layout edges

supportsSubgraph - determines if supports subgraph layout

AbstractDiagramLayouter

@OpenApi
protected AbstractDiagramLayouter(java.lang.String optionId,
                                           boolean supportsSubgraph)

Constructor

Parameters:

optionId - layouter options id

supportsSubgraph - determines if supports subgraph layout

AbstractDiagramLayouter

@OpenApi
protected AbstractDiagramLayouter(java.lang.String optionId)

Constructor

Parameters:

optionId - layouter options id

Method Detail

createGraph

@OpenApi
protected UMLGraph createGraph(com.nomagic.magicdraw.uml.symbols.DiagramPresentationElement dpe,
                                        boolean useIntegratedLabels)

Constructs a graph for layout

Parameters:

dpe - shapes and edges are taken from this diagram

Returns:

a created UMLGraph

getSelected

@OpenApi
protected java.util.Set<com.nomagic.magicdraw.uml.symbols.PresentationElement> getSelected(com.nomagic.magicdraw.uml.symbols.DiagramPresentationElement diagramView)

Collects a set of selected presentation elements in a diagram

Parameters:

diagramView - the diagram that elements were selected in

Returns:

a set of selected presentation elements in a diagram

layout

@OpenApi
protected abstract boolean layout(AbstractDiagramLayouterOptionsGroup opt,
                                           com.nomagic.magicdraw.uml.symbols.DiagramPresentationElement dpe,
                                           UMLGraph graph)

Layouts a diagram

Parameters:

opt - layouter options

dpe - diagram to layout

graph - a constructed graph from the diagram

Returns:

true if it was layouted successfully , false otherwise.

isTypeSupported

@OpenApi
public boolean isTypeSupported(DiagramType type)

Test the given type is supported.

Parameters:

type - The given type.

Returns:

true, if diagram type is supported

isSubgraphLayout

@OpenApi
public boolean isSubgraphLayout()

Test is graph layout.

Returns:

true if layouted graph is a subgraph

setSubgraphLayout

@OpenApi
public void setSubgraphLayout(boolean subgraphLayout)

Set sub graph layout.

Parameters:

subgraphLayout - is sub-graph