com.yworks.yfiles.layout.hierarchic

Class ConstraintIncrementalLayerer

java.lang.Object

com.yworks.yfiles.layout.hierarchic.ConstraintIncrementalLayerer

All Implemented Interfaces:

ILayerer

public class ConstraintIncrementalLayerer
extends Object
implements ILayerer

This class is a ILayerer implementation that observes relative and absolute layering constraints defined by the layer constraint factory.

Furthermore, it can handle the edge directedness as specified by IDataProvider key HierarchicLayout.EDGE_DIRECTEDNESS_DPKEY.

For a given graph instance, the layer constraint factory can be created using method HierarchicLayout.createLayerConstraintFactory(Graph). The ILayerer can be used for both common layering and layering of incremental nodes.

Sample output of applying ConstraintIncrementalLayerer. The red colored node should reside in the topmost layer, blue nodes in the medium layer while green nodes in the bottommost layer. Sample output of applying ConstraintIncrementalLayerer on a graph with a PartitionGrid. Same colors represent nodes that belong to the same partition grid cell and should be layered with respect to the partition grid cell to which they belong.

This ILayerer is always applied automatically if the graph instance has constraints created with the layering constraint factory.

See Also:

ILayerConstraintFactory, HierarchicLayout

Field Summary

Fields

Modifier and Type	Field and Description
static EdgeDpKey<Integer>	ADDITIONAL_EDGE_WEIGHT_DPKEY A DataProvider key for assigning additional edge weights The ILayerer tries to maintain edges with higher weights short.

Constructor Summary

Constructors

Constructor and Description
ConstraintIncrementalLayerer(ILayerer coreLayerer) Creates a new ConstraintIncrementalLayerer with the given ILayerer instance.

Method Summary

Modifier and Type	Method and Description
void	assignLayers(LayoutGraph graph, ILayers layers, ILayoutDataProvider ldp) Assigns all nodes of the graph to layers and adds them to the ILayers instance based on relative and absolute layering constraints defined by the given layering constraints.
protected void	checkConstraints() Checks if the current setting of constraints is consistent (i.e.
boolean	isSameLayerEdgesAllowed() Gets whether or not same-layer edges can be created by this ILayerer instance.
void	setSameLayerEdgesAllowed(boolean value) Sets whether or not same-layer edges can be created by this ILayerer instance.

Methods inherited from class java.lang.Object

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

Field Detail

ADDITIONAL_EDGE_WEIGHT_DPKEY

public static final EdgeDpKey<Integer> ADDITIONAL_EDGE_WEIGHT_DPKEY

A DataProvider key for assigning additional edge weights

The ILayerer tries to maintain edges with higher weights short.

Constructor Detail

ConstraintIncrementalLayerer

public ConstraintIncrementalLayerer(ILayerer coreLayerer)

Creates a new ConstraintIncrementalLayerer with the given ILayerer instance.

Parameters:

coreLayerer - the given ILayerer instance

Method Detail

assignLayers

public void assignLayers(LayoutGraph graph,
                         ILayers layers,
                         ILayoutDataProvider ldp)

Assigns all nodes of the graph to layers and adds them to the ILayers instance based on relative and absolute layering constraints defined by the given layering constraints.

Specified by:

assignLayers in interface ILayerer

A ILayers structure will be filled by the ILayerer. If the ILayerer instance is used for layering incremental nodes, the ILayers structure already has to contain all non-incremental nodes.

Parameters:

graph - the input graph

layers - the ILayers instance that will be filled with the results of the calculation

ldp - the ILayoutDataProvider used for query information about the nodes and edges

See Also:

ILayers.insert(com.yworks.yfiles.layout.hierarchic.LayerType, int), ILayer.add(com.yworks.yfiles.algorithms.Node)

checkConstraints

protected void checkConstraints()

Checks if the current setting of constraints is consistent (i.e.

the induced constraint graph has no cycles).

Throws:

IllegalArgumentException - if the constraint graph is inconsistent

isSameLayerEdgesAllowed

public boolean isSameLayerEdgesAllowed()

Gets whether or not same-layer edges can be created by this ILayerer instance.

This only concerns edges between nodes that have no hard constraints that will force a same-layer edge (i.e. a same-layer constraint).

Default Value:

The default value is false. Same-layer edges cannot be created by this ILayerer instance.

Returns:

true if same-layer edges can be created, false otherwise

See Also:

setSameLayerEdgesAllowed(boolean)

setSameLayerEdgesAllowed

public void setSameLayerEdgesAllowed(boolean value)

Sets whether or not same-layer edges can be created by this ILayerer instance.

This only concerns edges between nodes that have no hard constraints that will force a same-layer edge (i.e. a same-layer constraint).

Default Value:

The default value is false. Same-layer edges cannot be created by this ILayerer instance.

Parameters:

value - true if same-layer edges can be created, false otherwise

See Also:

isSameLayerEdgesAllowed()