Class UMLGraphLayout

java.lang.Object

org.tquadrat.foundation.javadoc.umlgraph.UMLGraphLayout

@ClassVersion(sourceVersion="$Id: UMLGraphLayout.java 1165 2026-03-22 19:30:59Z tquadrat $")
@API(status=INTERNAL,
     since="0.0.5")
public final class UMLGraphLayout
extends Object

This class is used to lay out the UML graph.

Author:

Thomas Thrien - thomas.thrien@tquadrat.org

Version:

$Id: UMLGraphLayout.java 1165 2026-03-22 19:30:59Z tquadrat $

Since:

0.0.5

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	UMLGraphLayout.UMLGraphLayoutRow	This class is used to lay out the UML graph.

Field Summary

Fields

Modifier and Type	Field	Description
private UMLGraphLayout.UMLGraphLayoutRow	m_CurrentRow	The current row.
private final UMLDocument	m_Document	The UML document.
private final Map<String, List<UMLConnector>>	m_EndingConnectors	The registry of connectors that will be terminated by the class with the given name.
private final UMLGraphLayout.UMLGraphLayoutRow	m_NoParentRow	The row for class objects that do not have parents.
private final List<UMLGraphLayout.UMLGraphLayoutRow>	m_Rows	The rows for this layout.
private final Map<String, List<UMLConnector>>	m_StartingConnectors	The registry of connectors that will originate at the class with the given name.

Constructor Summary

Constructors

Constructor	Description
UMLGraphLayout(UMLDocument document)	Creates a new UMLGraphLayout object.

Method Summary

Modifier and Type	Method	Description
final String	addClippath(double x, double y, double width, double height)	Creates a clippath from the given coordinates and add that to the UML document.
final void	addEndingConnector(TypeSymbol typeSymbol, UMLConnector connector)	Adds a connector to the registry of connectors ending on the given type symbol.
final void	addStartingConnector(TypeSymbol typeSymbol, UMLConnector connector)	Adds a connector to the registry of connectors starting at the given type symbol.
final void	createConnector(TypeSymbol parent, TypeSymbol child)	Creates a connector for the given parent and child.
final void	distribute()	Distribute the elements in the layout.
final void	finishRow(boolean atEnd)	Call this method if all elements were added to the current row.
final UMLDocument	getDocument()	Returns a reference to the UMLDocument this instance of layout was created with.
final UMLGraphLayout.UMLGraphLayoutRow	getNoParentRow()	Returns a reference to the row that holds the class objects that does not have parents.
final UMLGraphLayout.UMLGraphLayoutRow	newRow()	Creates a new row for the layout; it is not yet added.

Methods inherited from class Object

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

Field Details

m_CurrentRow

private UMLGraphLayout.UMLGraphLayoutRow m_CurrentRow

The current row.

m_Document

private final UMLDocument m_Document

The UML document.

m_EndingConnectors

private final Map<String, List<UMLConnector>> m_EndingConnectors

The registry of connectors that will be terminated by the class with the given name.

m_NoParentRow

private final UMLGraphLayout.UMLGraphLayoutRow m_NoParentRow

The row for class objects that do not have parents. These are the class Object and all interfaces that do not extend other interfaces.

m_Rows

private final List<UMLGraphLayout.UMLGraphLayoutRow> m_Rows

The rows for this layout.

m_StartingConnectors

private final Map<String, List<UMLConnector>> m_StartingConnectors

The registry of connectors that will originate at the class with the given name.

Constructor Details

UMLGraphLayout

public UMLGraphLayout(UMLDocument document)

Creates a new UMLGraphLayout object.

Parameters:

document - The UML document.

Method Details

addEndingConnector

public final void addEndingConnector(TypeSymbol typeSymbol,
 UMLConnector connector)

Adds a connector to the registry of connectors ending on the given type symbol.

Parameters:

typeSymbol - The symbol.

connector - The connector.

addClippath

public final String addClippath(double x,
 double y,
 double width,
 double height)

Creates a clippath from the given coordinates and add that to the UML document.

Parameters:

x - The x coordinate of the upper left corner of the rectangle.

y - The y coordinate of the upper left corner of the rectangle.

width - The width of the rectangle.

height - The height of the rectangle.

Returns:

The id for the clippath element.

addStartingConnector

public final void addStartingConnector(TypeSymbol typeSymbol,
 UMLConnector connector)

Adds a connector to the registry of connectors starting at the given type symbol.

Parameters:

typeSymbol - The class symbol.

connector - The connector.

createConnector

public final void createConnector(TypeSymbol parent,
 TypeSymbol child)

Creates a connector for the given parent and child.

Parameters:

parent - The parent.

child - The child.

distribute

public final void distribute()

Distribute the elements in the layout.

finishRow

public final void finishRow(boolean atEnd)

Call this method if all elements were added to the current row.

Parameters:

atEnd - true if the row should be added to the end, false if it should be added to the beginning of the row's list.

getDocument

public final UMLDocument getDocument()

Returns a reference to the UMLDocument this instance of layout was created with.

Returns:

The UML document.

getNoParentRow

public final UMLGraphLayout.UMLGraphLayoutRow getNoParentRow()

Returns a reference to the row that holds the class objects that does not have parents.

Returns:

The row for parent-less class objects.

newRow

public final UMLGraphLayout.UMLGraphLayoutRow newRow()

Creates a new row for the layout; it is not yet added.

Returns:

The new row.