com.yworks.yfiles.layout.hierarchic

Interface ILayeredComponentsMerger

All Known Implementing Classes:

DefaultLayeredComponentsMerger

public interface ILayeredComponentsMerger

This interface merges two ILayers instances whose nodes reside in the same graph.

Implementations of this interface may provide different strategies for merging.

Default implementations of this interface are used internally by HierarchicLayoutCore and MultiComponentLayerer when e.g. the graph is grouped or it consists of more than one connected component.

Method Summary

Modifier and Type	Method and Description
void	merge(LayoutGraph graph, ILayoutDataProvider ldp, ILayers srcLayers, ILayers targetLayers) Merges two ILayers instances.

Method Detail

merge

void merge(LayoutGraph graph,
           ILayoutDataProvider ldp,
           ILayers srcLayers,
           ILayers targetLayers)

Merges two ILayers instances.

All nodes that belong to the source and target ILayers are part of the graph at the moment of invocation.

The state of the source ILayers instance is discarded after this call and does not need to be updated to reflect the changes. The target ILayers instance must be updated accordingly.

Parameters:

graph - the graph containing the nodes of source and target ILayers instances

ldp - the ILayoutDataProvider used for querying the layer indices

srcLayers - the source ILayers instance that will be merged into the target ILayers instance

targetLayers - the ILayers instance that will be modified to contain the resulting layering