com.yworks.yfiles.layout.hierarchic

Class AbstractPortConstraintOptimizer

java.lang.Object

com.yworks.yfiles.layout.hierarchic.AbstractPortConstraintOptimizer

All Implemented Interfaces:

IPortConstraintOptimizer

Direct Known Subclasses:

PortCandidateOptimizer

public abstract class AbstractPortConstraintOptimizer
extends Object
implements IPortConstraintOptimizer

This class is an abstract implementation of the IPortConstraintOptimizer interface that minimizes the effort required to modify the port assignment after the sequencing phase of hierarchic layout algorithm.

The callback method invoked after sequencing performs the following three steps:

1. Restores temporarily all same-layer edges which are not currently present in the layout graph at this time of the layout algorithm.
2. Invokes the hook in which the custom port assignment should be done.
3. Restores the original state of the layout graph by removing the temporary same-layer edges added in Step 1.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractPortConstraintOptimizer.SameLayerData This static class provides information about the same-layer structures created by class AbstractPortConstraintOptimizer.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPortConstraintOptimizer() Creates a new AbstractPortConstraintOptimizer instance with default settings.

Method Summary

Modifier and Type	Method and Description
LayoutOrientation	getLayoutOrientation() Gets the layout orientation.
MirrorModes	getMirrorMode() Gets the mirror mask that defines which orientations should be mirrored.
protected AbstractPortConstraintOptimizer.SameLayerData	insertSameLayerStructures(LayoutGraph graph, ILayers layers, ILayoutDataProvider ldp, IItemFactory itemFactory) Inserts a same-layer edge structure for each same-layer edge of the original graph.
abstract void	optimizeAfterLayering(LayoutGraph graph, ILayers layers, ILayoutDataProvider ldp, IItemFactory itemFactory) Assigns new temporary port constraints after the nodes have been assigned to layers.
protected void	optimizeAfterSequencing(Comparator<Object> inEdgeOrder, Comparator<Object> outEdgeOrder, LayoutGraph graph, ILayers layers, ILayoutDataProvider ldp, IItemFactory itemFactory) Assigns new temporary port constraints after the order of the nodes in each layer has been determined.
void	optimizeAfterSequencing(LayoutGraph graph, ILayers layers, ILayoutDataProvider ldp, IItemFactory itemFactory) Assigns new temporary port constraints after the order of the nodes in each layer has been determined.
protected abstract void	optimizeAfterSequencing(Node node, Comparator<Object> inEdgeOrder, Comparator<Object> outEdgeOrder, LayoutGraph graph, ILayoutDataProvider ldp, IItemFactory itemFactory) Assigns new temporary port constraints to a given node of the graph after the order of the nodes in each layer has been determined.
protected void	removeSameLayerStructures(AbstractPortConstraintOptimizer.SameLayerData sameLayerData, LayoutGraph graph, ILayoutDataProvider ldp, IItemFactory itemFactory) Removes the same-layer edge structure created using insertSameLayerStructures(LayoutGraph, ILayers, ILayoutDataProvider, IItemFactory).
void	setLayoutOrientation(LayoutOrientation value) Sets the layout orientation.
void	setMirrorMode(MirrorModes value) Sets the mirror mask that defines which orientations should be mirrored.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractPortConstraintOptimizer

protected AbstractPortConstraintOptimizer()

Creates a new AbstractPortConstraintOptimizer instance with default settings.

Method Detail

getLayoutOrientation

public LayoutOrientation getLayoutOrientation()

Gets the layout orientation.

This setting is necessary to correctly interpret the values provided by the PortCandidates since the OrientationLayout cannot automatically adjust these values.

Default Value:

The default value is LayoutOrientation.TOP_TO_BOTTOM. The layout orientation is top-to-bottom.

Returns:

a predefined orientation constant

See Also:

MultiStageLayout.getLayoutOrientation(), setLayoutOrientation(LayoutOrientation)

getMirrorMode

public MirrorModes getMirrorMode()

Gets the mirror mask that defines which orientations should be mirrored.

Setting a layout orientation can be considered as rotating the graph by 90, 180 or 270 degrees. Afterwards, the graph can be mirrored at the x-axis (for horizontal layout orientations) or y-axis (for vertical layout orientations). Which directions are mirrored can be defined by the given mask.

Default Value:

The default value is MirrorModes.BOTTOM_TO_TOP. Layout orientation LayoutOrientation.BOTTOM_TO_TOP will be mirrored at the y-axis.

Returns:

one of the predefined mirror masks

See Also:

OrientationLayout, LayoutOrientation, setMirrorMode(MirrorModes)

insertSameLayerStructures

protected AbstractPortConstraintOptimizer.SameLayerData insertSameLayerStructures(LayoutGraph graph,
                                                                                  ILayers layers,
                                                                                  ILayoutDataProvider ldp,
                                                                                  IItemFactory itemFactory)

Inserts a same-layer edge structure for each same-layer edge of the original graph.

In this phase of the layout, the graph does not contain same-layer edges. The structure for a same-layer edge (s,t) consists of a temporary node w and edges (s,w) and (t,w).

Parameters:

graph - the input graph

layers - the given ILayers instance holding the layering information

ldp - the ILayoutDataProvider implementation which provides access to the INodeData and IEdgeData instances

itemFactory - the factory that sets the temporary port constraints

See Also:

IItemFactory.setTemporaryPortConstraint(Edge, boolean, com.yworks.yfiles.layout.PortConstraint)

optimizeAfterLayering

public abstract void optimizeAfterLayering(LayoutGraph graph,
                                           ILayers layers,
                                           ILayoutDataProvider ldp,
                                           IItemFactory itemFactory)

Assigns new temporary port constraints after the nodes have been assigned to layers.

More precisely, it is called after the layering information has been determined. In this phase, it is possible to create back-loops by assigning incoming edges to the south (i.e. bottom) side or outgoing edges to the north (i.e. top) side, respectively.

Specified by:

optimizeAfterLayering in interface IPortConstraintOptimizer

Parameters:

graph - the input graph

layers - the given ILayers instance holding the layering information

ldp - the ILayoutDataProvider implementation which provides access to the INodeData and IEdgeData instances

itemFactory - the factory that sets the temporary port constraints

See Also:

IItemFactory.setTemporaryPortConstraint(Edge, boolean, com.yworks.yfiles.layout.PortConstraint)

optimizeAfterSequencing

protected void optimizeAfterSequencing(Comparator<Object> inEdgeOrder,
                                       Comparator<Object> outEdgeOrder,
                                       LayoutGraph graph,
                                       ILayers layers,
                                       ILayoutDataProvider ldp,
                                       IItemFactory itemFactory)

Assigns new temporary port constraints after the order of the nodes in each layer has been determined.

More precisely, it is called after the sequence of the nodes has been determined. It invokes optimizeAfterSequencing(Node, Comparator, Comparator, LayoutGraph, ILayoutDataProvider, IItemFactory) for every node of the original layout graph and omits the nodes of the same-layer structures.

Incoming and outgoing edges are sorted using Comparator instances which define the preferred ordering of the incoming and outgoing edges from left to right.

In this phase, it is not allowed to create back-loops, i.e., incoming edges must not connect to the south (i.e., bottom) side and outgoing edges must not connect to the north (i.e., top) side of a node.

Parameters:

inEdgeOrder - a given Comparator instance for incoming edges

outEdgeOrder - a given Comparator instance for outgoing edges

graph - the input graph

ldp - the ILayoutDataProvider implementation which provides access to the INodeData and IEdgeData instances

itemFactory - the factory that sets the temporary port constraints

See Also:

optimizeAfterSequencing(LayoutGraph, ILayers, ILayoutDataProvider, IItemFactory)

optimizeAfterSequencing

public void optimizeAfterSequencing(LayoutGraph graph,
                                    ILayers layers,
                                    ILayoutDataProvider ldp,
                                    IItemFactory itemFactory)

Assigns new temporary port constraints after the order of the nodes in each layer has been determined.

More precisely, it is called after the sequence of the nodes has been determined. It inserts the same-layer structures, invokes the hook in which the custom port assignment should be done, and finally restores the original state of the layout graph by removing the temporary edges.

Specified by:

optimizeAfterSequencing in interface IPortConstraintOptimizer

Parameters:

graph - the input graph

layers - the given ILayers instance holding the layering information

ldp - the ILayoutDataProvider implementation which provides access to the INodeData and IEdgeData instances

itemFactory - the factory that sets the temporary port constraints

See Also:

insertSameLayerStructures(LayoutGraph, ILayers, ILayoutDataProvider, IItemFactory), optimizeAfterSequencing(LayoutGraph, ILayers, ILayoutDataProvider, IItemFactory), removeSameLayerStructures(SameLayerData, LayoutGraph, ILayoutDataProvider, IItemFactory)

optimizeAfterSequencing

protected abstract void optimizeAfterSequencing(Node node,
                                                Comparator<Object> inEdgeOrder,
                                                Comparator<Object> outEdgeOrder,
                                                LayoutGraph graph,
                                                ILayoutDataProvider ldp,
                                                IItemFactory itemFactory)

Assigns new temporary port constraints to a given node of the graph after the order of the nodes in each layer has been determined.

More precisely, it is called after the sequence of the nodes has been determined.

Incoming and outgoing edges are sorted using Comparator instances which define the preferred ordering of the incoming and outgoing edges from left to right.

In this phase, it is not allowed to create back-loops, i.e., incoming edges must not connect to the south (i.e., bottom) side and outgoing edges must not connect to the north (i.e., top) side of a node.

Parameters:

node - the original node to set temporary port constraints

inEdgeOrder - a given Comparator instance for incoming edges

outEdgeOrder - a given Comparator instance for outgoing edges

graph - the input graph

ldp - the ILayoutDataProvider implementation which provides access to the INodeData and IEdgeData instances

itemFactory - the factory that sets the temporary port constraints

See Also:

optimizeAfterSequencing(LayoutGraph, ILayers, ILayoutDataProvider, IItemFactory)

removeSameLayerStructures

protected void removeSameLayerStructures(AbstractPortConstraintOptimizer.SameLayerData sameLayerData,
                                         LayoutGraph graph,
                                         ILayoutDataProvider ldp,
                                         IItemFactory itemFactory)

Removes the same-layer edge structure created using insertSameLayerStructures(LayoutGraph, ILayers, ILayoutDataProvider, IItemFactory).

Parameters:

sameLayerData - a given AbstractPortConstraintOptimizer.SameLayerData instance holding the information about the same-layer structures.

graph - the input graph

ldp - the ILayoutDataProvider implementation which provides access to the INodeData and IEdgeData instances

itemFactory - the factory that sets the temporary port constraints

See Also:

IItemFactory.setTemporaryPortConstraint(Edge, boolean, com.yworks.yfiles.layout.PortConstraint)

setLayoutOrientation

public void setLayoutOrientation(LayoutOrientation value)

Sets the layout orientation.

This setting is necessary to correctly interpret the values provided by the PortCandidates since the OrientationLayout cannot automatically adjust these values.

Default Value:

The default value is LayoutOrientation.TOP_TO_BOTTOM. The layout orientation is top-to-bottom.

Parameters:

value - a predefined orientation constant

See Also:

MultiStageLayout.getLayoutOrientation(), getLayoutOrientation()

setMirrorMode

public void setMirrorMode(MirrorModes value)

Sets the mirror mask that defines which orientations should be mirrored.

Setting a layout orientation can be considered as rotating the graph by 90, 180 or 270 degrees. Afterwards, the graph can be mirrored at the x-axis (for horizontal layout orientations) or y-axis (for vertical layout orientations). Which directions are mirrored can be defined by the given mask.

Default Value:

The default value is MirrorModes.BOTTOM_TO_TOP. Layout orientation LayoutOrientation.BOTTOM_TO_TOP will be mirrored at the y-axis.

Parameters:

value - one of the predefined mirror masks

See Also:

OrientationLayout, LayoutOrientation, getMirrorMode()