com.yworks.yfiles.layout

Class SequentialLayout

java.lang.Object

com.yworks.yfiles.layout.SequentialLayout

All Implemented Interfaces:

ILayoutAlgorithm

public class SequentialLayout
extends Object
implements ILayoutAlgorithm

A SequentialLayout allows for chaining multiple layout algorithms.

The layout algorithms are invoked one after the other in the order in which they were added to the chain. They all run independently of each other, i.e., they only influence each other by the changed input graph. Hence, the sequence determines the result.

One possible application would be to bundle several layout algorithms and pass a single ILayoutAlgorithm instance to a BufferedLayout.

Constructor Summary

Constructors

Constructor and Description
SequentialLayout() Creates a new SequentialLayout instance with an empty chain of layout algorithms.

Method Summary

Modifier and Type	Method and Description
void	appendLayout(ILayoutAlgorithm layouter) Appends the given layout algorithm to the end of the chain.
void	appendLayouts(Collection<ILayoutAlgorithm> layouters) Appends the specified list of layout algorithms to the end of the chain.
void	applyLayout(LayoutGraph graph) Executes all layout algorithms in the chain, one after the other.
List<ILayoutAlgorithm>	getLayouts() Gets the chain of layout algorithms.
void	removeAll() Clears the current chain of layout algorithms and therefore removes all layout algorithms.
void	setLayouts(List<ILayoutAlgorithm> value) Sets the chain of layout algorithms.

Methods inherited from class java.lang.Object

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

Constructor Detail

SequentialLayout

public SequentialLayout()

Creates a new SequentialLayout instance with an empty chain of layout algorithms.

Method Detail

appendLayout

public void appendLayout(ILayoutAlgorithm layouter)

Appends the given layout algorithm to the end of the chain.

Parameters:

layouter - the layout algorithm to append

appendLayouts

public void appendLayouts(Collection<ILayoutAlgorithm> layouters)

Appends the specified list of layout algorithms to the end of the chain.

Parameters:

layouters - the list of layout algorithms to append

applyLayout

public void applyLayout(LayoutGraph graph)

Executes all layout algorithms in the chain, one after the other.

The order of the layout algorithms is defined by the order in which they were appended.

Specified by:

applyLayout in interface ILayoutAlgorithm

Parameters:

graph - the input graph

getLayouts

public List<ILayoutAlgorithm> getLayouts()

Gets the chain of layout algorithms.

The current chain is replaced by the specified layout algorithms.

Returns:

the list of layout algorithms that are invoked one after the other

See Also:

appendLayout(ILayoutAlgorithm), appendLayouts(Collection), setLayouts(List)

removeAll

public void removeAll()

Clears the current chain of layout algorithms and therefore removes all layout algorithms.

setLayouts

public void setLayouts(List<ILayoutAlgorithm> value)

Sets the chain of layout algorithms.

The current chain is replaced by the specified layout algorithms.

Parameters:

value - the list of layout algorithms that are invoked one after the other

See Also:

appendLayout(ILayoutAlgorithm), appendLayouts(Collection), getLayouts()