com.yworks.yfiles.layout.hierarchic

Class GivenSequenceSequencer

java.lang.Object

com.yworks.yfiles.layout.hierarchic.GivenSequenceSequencer

All Implemented Interfaces:

ISequencer

public class GivenSequenceSequencer
extends Object
implements ISequencer

This class is a ISequencer implementation that determines the sequence of nodes of the same layer based on a given comparator constraint.

Constructor Summary

Constructors

Constructor and Description
GivenSequenceSequencer() Creates a new instance of GivenSequenceSequencer using a given Comparator for the sequencing.
GivenSequenceSequencer(Comparator<Object> c) Creates a new instance of GivenSequenceSequencer using a given Comparator for the sequencing.

Method Summary

Modifier and Type	Method and Description
Comparator<Object>	getSequenceComparator() Gets the Comparator used by this GivenSequenceSequencer to determine the sequence of the nodes.
void	sequenceNodeLayers(LayoutGraph graph, ILayers layers, ILayoutDataProvider ldp, IItemFactory itemFactory) Calculates the sequence of the nodes within a ILayers instance based on the given Comparator instance.
void	setSequenceComparator(Comparator<Object> value) Sets the Comparator used by this GivenSequenceSequencer to determine the sequence of the nodes.

Methods inherited from class java.lang.Object

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

Constructor Detail

GivenSequenceSequencer

public GivenSequenceSequencer()

Creates a new instance of GivenSequenceSequencer using a given Comparator for the sequencing.

GivenSequenceSequencer

public GivenSequenceSequencer(Comparator<Object> c)

Creates a new instance of GivenSequenceSequencer using a given Comparator for the sequencing.

Method Detail

getSequenceComparator

public Comparator<Object> getSequenceComparator()

Gets the Comparator used by this GivenSequenceSequencer to determine the sequence of the nodes.

Default Value:

The default value is null. No Comparator is specified.

Returns:

a Comparator instance

See Also:

setSequenceComparator(Comparator)

sequenceNodeLayers

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

Calculates the sequence of the nodes within a ILayers instance based on the given Comparator instance.

This method is called by HierarchicLayoutCore during the sequencing phase and finally writes back the calculated sequence using the ILayer.setNodeOrder(YList) method.

Specified by:

sequenceNodeLayers in interface ISequencer

Parameters:

graph - the input graph

layers - the given ILayers instance containing the elements of the layers

ldp - the ILayoutDataProvider containing information about the nodes and edges of the graph

itemFactory - the IItemFactory used for creating and destroying helper structures

setSequenceComparator

public void setSequenceComparator(Comparator<Object> value)

Sets the Comparator used by this GivenSequenceSequencer to determine the sequence of the nodes.

Default Value:

The default value is null. No Comparator is specified.

Parameters:

value - a Comparator instance

See Also:

getSequenceComparator()