com.yworks.yfiles.layout.hierarchic

Class DefaultLayeredComponentsMerger

java.lang.Object

com.yworks.yfiles.layout.hierarchic.DefaultLayeredComponentsMerger

All Implemented Interfaces:

ILayeredComponentsMerger

public class DefaultLayeredComponentsMerger
extends Object
implements ILayeredComponentsMerger

A default implementation of a ILayeredComponentsMerger that provides simple default behaviors.

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

Constructor Summary

Constructors

Constructor and Description
DefaultLayeredComponentsMerger() Creates a new instance of DefaultLayeredComponentsMerger with default settings.
DefaultLayeredComponentsMerger(MergingPolicy policy) Creates a new instance of DefaultLayeredComponentsMerger using the given merging policy.

Method Summary

Modifier and Type	Method and Description
MergingPolicy	getPolicy() Gets the merging policy constant as defined in DefaultLayeredComponentsMerger.
void	merge(LayoutGraph graph, ILayoutDataProvider ldp, ILayers srcLayers, ILayers targetLayers) Merges two ILayers instances.
void	setPolicy(MergingPolicy value) Sets the merging policy constant as defined in DefaultLayeredComponentsMerger.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultLayeredComponentsMerger

public DefaultLayeredComponentsMerger()

Creates a new instance of DefaultLayeredComponentsMerger with default settings.

DefaultLayeredComponentsMerger

public DefaultLayeredComponentsMerger(MergingPolicy policy)

Creates a new instance of DefaultLayeredComponentsMerger using the given merging policy.

Throws:

IllegalArgumentException - if an unknown policy is given

Parameters:

policy - one of the predefined merging constants

Method Detail

getPolicy

public MergingPolicy getPolicy()

Gets the merging policy constant as defined in DefaultLayeredComponentsMerger.

Throws:

IllegalArgumentException - if an unknown policy is given

Default Value:

The default value is MergingPolicy.ADD_RIGHT_TOP_ALIGNED. Nodes of the source layering are to the right of the target layering and all nodes are top-aligned.

Returns:

one of the predefined merging policy constants

See Also:

setPolicy(MergingPolicy)

merge

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

Description copied from interface: ILayeredComponentsMerger

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.

Specified by:

merge in interface ILayeredComponentsMerger

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

setPolicy

public void setPolicy(MergingPolicy value)

Sets the merging policy constant as defined in DefaultLayeredComponentsMerger.

Throws:

IllegalArgumentException - if an unknown policy is given

Default Value:

The default value is MergingPolicy.ADD_RIGHT_TOP_ALIGNED. Nodes of the source layering are to the right of the target layering and all nodes are top-aligned.

Parameters:

value - one of the predefined merging policy constants

See Also:

getPolicy()