com.yworks.yfiles.layout.hierarchic

Interface ILayerConstraintFactory

public interface ILayerConstraintFactory

This interface provides methods for creating layering constraints.

If you manually register a IDataProvider with the graph with key LayoutKeys.NODE_ID_DPKEY, you must use the corresponding node IDs stored in this IDataProvider as arguments for all methods that create a constraint. Otherwise, you can just use the node instances themselves.

Method Summary

Modifier and Type	Method and Description
ILayerConstraint	addPlaceNodeAboveConstraint(Object referenceId, Object aboveId) Adds a constraint that forces the Node with ID aboveId to lie above the Node with ID referenceId.
default ILayerConstraint	addPlaceNodeAboveConstraint(Object referenceId, Object aboveId, int minDistance) Adds a constraint that forces the Node with ID aboveId to lie at least minDistance layers above the Node with ID referenceId with a given weight penalty for larger layer differences.
ILayerConstraint	addPlaceNodeAboveConstraint(Object referenceId, Object aboveId, int minDistance, int weight) Adds a constraint that forces the Node with ID aboveId to lie at least minDistance layers above the Node with ID referenceId with a given weight penalty for larger layer differences.
ILayerConstraint	addPlaceNodeAtBottomConstraint(Object nodeId) Adds a constraint that places a Node on the bottom layer.
ILayerConstraint	addPlaceNodeAtTopConstraint(Object nodeId) Adds a constraint that places a Node on the topmost layer.
ILayerConstraint	addPlaceNodeBelowConstraint(Object referenceId, Object belowId) Adds a constraint that forces a Node with ID belowId to lie below the Node with ID referenceId.
default ILayerConstraint	addPlaceNodeBelowConstraint(Object referenceId, Object belowId, int minDistance) Adds a constraint that forces the Node with ID belowId to lie at least minDistance layers below the Node with ID referenceId with a given weight penalty for larger layer differences.
ILayerConstraint	addPlaceNodeBelowConstraint(Object referenceId, Object belowId, int minDistance, int weight) Adds a constraint that forces the Node with ID belowId to lie at least minDistance layers below the Node with ID referenceId with a given weight penalty for larger layer differences.
ILayerConstraint	addPlaceNodeInSameLayerConstraint(Object referenceId, Object sameLayerId) Adds a constraint that forces the Node with ID sameLayerId to lie in the same layer as the Node with ID referenceId.
void	dispose() Disposes this factory.
Object	getMemento() Gets a token that allows to bind a constraint factory to a graph instance after creation.
void	removeConstraints(Object nodeId) Clears all constraints for a given Node.

Method Detail

addPlaceNodeAboveConstraint

ILayerConstraint addPlaceNodeAboveConstraint(Object referenceId,
                                             Object aboveId)

Adds a constraint that forces the Node with ID aboveId to lie above the Node with ID referenceId.

Parameters:

referenceId - the ID of the reference node

aboveId - the ID of the node that should lie above

Returns:

a ILayerConstraint object that represents the constraint

See Also:

ILayerConstraint

addPlaceNodeAboveConstraint

default ILayerConstraint addPlaceNodeAboveConstraint(Object referenceId,
                                                     Object aboveId,
                                                     int minDistance)

Adds a constraint that forces the Node with ID aboveId to lie at least minDistance layers above the Node with ID referenceId with a given weight penalty for larger layer differences.

The minimum distance includes potentially empty layers that are removed by the ILayerer instance. In that case, the actual layer difference may be smaller than the minimum distance.

Parameters:

referenceId - the ID of the reference node

aboveId - the ID of the node that should lie above

minDistance - the minimum layer distance between the node and its reference node

Returns:

a ILayerConstraint object that represents the constraint

See Also:

ILayerConstraint

addPlaceNodeAboveConstraint

ILayerConstraint addPlaceNodeAboveConstraint(Object referenceId,
                                             Object aboveId,
                                             int minDistance,
                                             int weight)

Adds a constraint that forces the Node with ID aboveId to lie at least minDistance layers above the Node with ID referenceId with a given weight penalty for larger layer differences.

The minimum distance includes potentially empty layers that are removed by the ILayerer instance. In that case, the actual layer difference may be smaller than the minimum distance.

Parameters:

referenceId - the ID of the reference node

aboveId - the ID of the node that should lie above

minDistance - the minimum layer distance between the node and its reference node

weight - the weight penalty for larger layer differences

Returns:

a ILayerConstraint object that represents the constraint

See Also:

ILayerConstraint

addPlaceNodeAtBottomConstraint

ILayerConstraint addPlaceNodeAtBottomConstraint(Object nodeId)

Adds a constraint that places a Node on the bottom layer.

Parameters:

nodeId - the ID of the node that should lie on the bottom layer

Returns:

a ILayerConstraint object that represents the constraint

See Also:

ILayerConstraint

addPlaceNodeAtTopConstraint

ILayerConstraint addPlaceNodeAtTopConstraint(Object nodeId)

Adds a constraint that places a Node on the topmost layer.

Parameters:

nodeId - the ID of the node that should lie on the top layer

Returns:

a ILayerConstraint object that represents the constraint

See Also:

ILayerConstraint

addPlaceNodeBelowConstraint

ILayerConstraint addPlaceNodeBelowConstraint(Object referenceId,
                                             Object belowId)

Adds a constraint that forces a Node with ID belowId to lie below the Node with ID referenceId.

Parameters:

referenceId - the ID of the reference node

belowId - the ID of the node that should lie below

Returns:

a ILayerConstraint object that represents the constraint

See Also:

ILayerConstraint

addPlaceNodeBelowConstraint

default ILayerConstraint addPlaceNodeBelowConstraint(Object referenceId,
                                                     Object belowId,
                                                     int minDistance)

Adds a constraint that forces the Node with ID belowId to lie at least minDistance layers below the Node with ID referenceId with a given weight penalty for larger layer differences.

The minimum distance includes potentially empty layers that are removed by the ILayerer instance. In that case, the actual layer difference may be smaller than the minimum distance.

Parameters:

referenceId - the ID of the reference node

belowId - the ID of the node that should lie below

minDistance - the minimum layer distance between the node and its reference node

Returns:

a ILayerConstraint object that represents the constraint

See Also:

ILayerConstraint

addPlaceNodeBelowConstraint

ILayerConstraint addPlaceNodeBelowConstraint(Object referenceId,
                                             Object belowId,
                                             int minDistance,
                                             int weight)

Adds a constraint that forces the Node with ID belowId to lie at least minDistance layers below the Node with ID referenceId with a given weight penalty for larger layer differences.

The minimum distance includes potentially empty layers that are removed by the ILayerer instance. In that case, the actual layer difference may be smaller than the minimum distance.

Parameters:

referenceId - the ID of the reference node

belowId - the ID of the node that should lie below

minDistance - the minimum layer distance between the node and its reference node

weight - the weight penalty for larger layer differences

Returns:

a ILayerConstraint object that represents the constraint

See Also:

ILayerConstraint

addPlaceNodeInSameLayerConstraint

ILayerConstraint addPlaceNodeInSameLayerConstraint(Object referenceId,
                                                   Object sameLayerId)

Adds a constraint that forces the Node with ID sameLayerId to lie in the same layer as the Node with ID referenceId.

Parameters:

referenceId - the ID of the reference node

sameLayerId - the ID of the node that should lie in the same layer

Returns:

a ILayerConstraint object that represents the constraint

See Also:

ILayerConstraint

dispose

void dispose()

Disposes this factory.

This method should be called when this factory is not needed anymore, i.e. after the layout has been calculated. Calling this method also clears all constraints.

getMemento

Object getMemento()

Gets a token that allows to bind a constraint factory to a graph instance after creation.

This method should only be used if the constraint factory is not bound to a graph instance initially. It allows to bind this factory to a graph instance after creation. See the factory methods that create instances of this interface for a description.

Returns:

a token that allows to bind the constraint factory to a graph instance

See Also:

HierarchicLayout.createLayerConstraintFactory(com.yworks.yfiles.algorithms.Graph)

removeConstraints

void removeConstraints(Object nodeId)

Clears all constraints for a given Node.

Parameters:

nodeId - the ID of the node for which all constraints should be cleared

See Also:

ILayerConstraint