org.eclipse.gef4.layout.algorithms

Class CompositeLayoutAlgorithm

java.lang.Object

org.eclipse.gef4.layout.algorithms.CompositeLayoutAlgorithm

All Implemented Interfaces:

ILayoutAlgorithm

public class CompositeLayoutAlgorithm
extends java.lang.Object
implements ILayoutAlgorithm

The CompositeLayoutAlgorithm combines multiple ILayoutAlgorithms. When doing a layout-pass, all the algorithms are applied in sequence.

Constructor Summary

Constructors

Constructor and Description
CompositeLayoutAlgorithm(ILayoutAlgorithm[] algorithms) Constructs a new CompositeLayoutAlgorithm that combines the given ILayoutAlgorithms.

Method Summary

Modifier and Type	Method and Description
void	applyLayout(boolean clean) Makes this algorithm perform layout computation and apply it to its context.
ILayoutContext	getLayoutContext() Returns the previously set ILayoutContext.
void	setLayoutContext(ILayoutContext context) Sets the layout context for this algorithm.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositeLayoutAlgorithm

public CompositeLayoutAlgorithm(ILayoutAlgorithm[] algorithms)

Constructs a new CompositeLayoutAlgorithm that combines the given ILayoutAlgorithms.

Parameters:

algorithms - The ILayoutAlgorithms that are combined by this CompositeLayoutAlgorithm.

Method Detail

applyLayout

public void applyLayout(boolean clean)

Description copied from interface: ILayoutAlgorithm

Makes this algorithm perform layout computation and apply it to its context.

Specified by:

applyLayout in interface ILayoutAlgorithm

Parameters:

clean - if true the receiver should assume that the layout context has changed significantly and recompute the whole layout even if it keeps track of changes with listeners. False can be used after dynamic layout in a context is turned back on so that layout algorithm working in background can apply accumulated changes. Static layout algorithm can ignore this call entirely if clean is false.

setLayoutContext

public void setLayoutContext(ILayoutContext context)

Description copied from interface: ILayoutAlgorithm

Sets the layout context for this algorithm. The receiver will unregister from its previous layout context and register to the new one (registration means for example adding listeners). After a call to this method, the receiving algorithm can compute and cache internal data related to given context and perform an initial layout.

Specified by:

setLayoutContext in interface ILayoutAlgorithm

Parameters:

context - a new layout context or null if this algorithm should not perform any layout

getLayoutContext

public ILayoutContext getLayoutContext()

Description copied from interface: ILayoutAlgorithm

Returns the previously set ILayoutContext.

Specified by:

getLayoutContext in interface ILayoutAlgorithm

Returns:

the previously set ILayoutContext