com.yworks.yfiles.layout

Class BufferedLayout

java.lang.Object

com.yworks.yfiles.layout.AbstractLayoutStage

com.yworks.yfiles.layout.BufferedLayout

All Implemented Interfaces:

ILayoutAlgorithm, ILayoutStage

public class BufferedLayout
extends AbstractLayoutStage

A BufferedLayout is a hull algorithm that invokes its core layout algorithm on a copy of the input graph.

After the layout process has finished, the calculated layout will be written back to the original graph.

This class also provides the possibility to perform arbitrary layout algorithms merely on a graph interface plus associated graph layout. This comes in handy if an application has its own graph and only provides a graph interface adapter to the yFiles graph layout machinery.

It is recommended to run layout calculations on a copy of the original graph. Then, if for some reason the layout calculation fails, the graph won't be compromised.

Constructor Summary

Constructors

Constructor and Description
BufferedLayout() Creates a new BufferedLayout instance using the given core layout algorithm.
BufferedLayout(ILayoutAlgorithm coreLayouter) Creates a new BufferedLayout instance using the given core layout algorithm.

Method Summary

Modifier and Type	Method and Description
void	applyLayout(LayoutGraph graph) Applies the layout calculated by the core layout algorithm to the input graph.

Methods inherited from class com.yworks.yfiles.layout.AbstractLayoutStage

applyLayoutCore, getCoreLayout, setCoreLayout

Methods inherited from class java.lang.Object

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

Constructor Detail

BufferedLayout

public BufferedLayout()

Creates a new BufferedLayout instance using the given core layout algorithm.

BufferedLayout

public BufferedLayout(ILayoutAlgorithm coreLayouter)

Creates a new BufferedLayout instance using the given core layout algorithm.

Parameters:

coreLayouter - the core layout routine

Method Detail

applyLayout

public void applyLayout(LayoutGraph graph)

Applies the layout calculated by the core layout algorithm to the input graph.

The layout calculation is invoked on a copy of the given graph. Then, the calculated layout will be written back to the given graph.

Specified by:

applyLayout in interface ILayoutAlgorithm

Specified by:

applyLayout in class AbstractLayoutStage

Parameters:

graph - the input graph