com.mxgraph.layout.hierarchical
Class mxHierarchicalLayout

java.lang.Object
  com.mxgraph.layout.mxGraphLayout
      com.mxgraph.layout.hierarchical.mxHierarchicalLayout

All Implemented Interfaces:

mxIGraphLayout

public class mxHierarchicalLayout
extends mxGraphLayout

The top level compound layout of the hierarchical layout. The individual elements of the layout are called in sequence.

Field Summary

protected boolean	disableEdgeStyle Specifies if the STYLE_NOEDGESTYLE flag should be set on edges that are modified by the result.
protected boolean	fineTuning Whether or not to perform local optimisations and iterate multiple times through the algorithm
protected double	interHierarchySpacing The spacing buffer between unconnected hierarchies
protected double	interRankCellSpacing The spacing buffer added between cell on adjacent layers
protected double	intraCellSpacing The spacing buffer added between cells on the same layer
protected mxGraphHierarchyModel	model The internal model formed of the layout
protected boolean	moveParent Specifies if the parnent should be moved if resizeParent is enabled.
protected int	orientation The position of the root node(s) relative to the laid out graph in.
protected double	parallelEdgeSpacing The distance between each parallel edge on each ranks for long edges
protected int	parentBorder The border to be added around the children if the parent is to be resized using resizeParent.
protected boolean	promoteEdges Whether or not to promote edges that terminate on vertices with different but common ancestry to appear connected to the highest siblings in the ancestry chains
protected boolean	resizeParent Specifies if the parent should be resized after the layout so that it contains all the child cells.
protected List<Object>	roots The root nodes of the layout
protected boolean	traverseAncestors Whether or not to navigate edges whose terminal vertices have different parents but are in the same ancestry chain

Fields inherited from class com.mxgraph.layout.mxGraphLayout

graph, parent, useBoundingBox

Constructor Summary

mxHierarchicalLayout(mxGraph graph)
Constructs a hierarchical layout

mxHierarchicalLayout(mxGraph graph, int orientation)
Constructs a hierarchical layout

Method Summary

void	crossingStage(Object parent) Executes the crossing stage using mxMedianHybridCrossingReduction.
void	cycleStage(Object parent) Executes the cycle stage.
void	execute(Object parent) Executes the layout for the children of the specified parent.
void	execute(Object parent, List<Object> roots) Executes the layout for the children of the specified parent.
Set<Object>	filterDescendants(Object cell) Creates a set of descendant cells
List<Object>	findRoots(Object parent, Set<Object> vertices) Returns all visible children in the given parent which do not have incoming edges.
Object[]	getEdges(Object cell)
double	getInterHierarchySpacing()
double	getInterRankCellSpacing()
double	getIntraCellSpacing()
mxGraphHierarchyModel	getModel() Returns the model for this layout algorithm.
int	getOrientation()
double	getParallelEdgeSpacing()
int	getParentBorder() Returns parentBorder.
boolean	isDisableEdgeStyle()
boolean	isFineTuning()
boolean	isMoveParent() Returns the moveParent flag.
boolean	isResizeParent() Returns the resizeParent flag.
void	layeringStage() Implements first stage of a Sugiyama layout.
double	placementStage(double initialX, Object parent) Executes the placement stage using mxCoordinateAssignment.
void	run(Object parent) The API method used to exercise the layout upon the graph description and produce a separate description of the vertex position and edge routing changes made.
void	setDisableEdgeStyle(boolean disableEdgeStyle)
void	setFineTuning(boolean fineTuning)
void	setInterHierarchySpacing(double interHierarchySpacing)
void	setInterRankCellSpacing(double interRankCellSpacing)
void	setIntraCellSpacing(double intraCellSpacing)
void	setLoggerLevel(Level level) Sets the logging level of this class
void	setMoveParent(boolean value) Sets the moveParent flag.
void	setOrientation(int orientation)
void	setParallelEdgeSpacing(double parallelEdgeSpacing)
void	setParentBorder(int value) Sets parentBorder.
void	setResizeParent(boolean value) Sets the resizeParent flag.
String	toString() Returns Hierarchical, the name of this algorithm.
protected void	traverse(Object vertex, boolean directed, Object edge, Set<Object> allVertices, Set<Object> currentComp, List<Set<Object>> hierarchyVertices, Set<Object> filledVertexSet) Traverses the (directed) graph invoking the given function for each visited vertex and edge.

Methods inherited from class com.mxgraph.layout.mxGraphLayout

arrangeGroups, getConstraint, getConstraint, getGraph, getParentOffset, getVertexBounds, isEdgeIgnored, isUseBoundingBox, isVertexIgnored, isVertexMovable, moveCell, setEdgePoints, setEdgeStyleEnabled, setOrthogonalEdge, setUseBoundingBox, setVertexLocation

Methods inherited from class java.lang.Object

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

Field Detail

roots

protected List<Object> roots

The root nodes of the layout

resizeParent

protected boolean resizeParent

Specifies if the parent should be resized after the layout so that it contains all the child cells. Default is false. @See parentBorder.

moveParent

protected boolean moveParent

Specifies if the parnent should be moved if resizeParent is enabled. Default is false. @See resizeParent.

parentBorder

protected int parentBorder

The border to be added around the children if the parent is to be resized using resizeParent. Default is 0. @See resizeParent.

intraCellSpacing

protected double intraCellSpacing

The spacing buffer added between cells on the same layer

interRankCellSpacing

protected double interRankCellSpacing

The spacing buffer added between cell on adjacent layers

interHierarchySpacing

protected double interHierarchySpacing

The spacing buffer between unconnected hierarchies

parallelEdgeSpacing

protected double parallelEdgeSpacing

The distance between each parallel edge on each ranks for long edges

orientation

protected int orientation

The position of the root node(s) relative to the laid out graph in. Default is SwingConstants.NORTH, i.e. top-down.

disableEdgeStyle

protected boolean disableEdgeStyle

Specifies if the STYLE_NOEDGESTYLE flag should be set on edges that are modified by the result. Default is true.

fineTuning

protected boolean fineTuning

Whether or not to perform local optimisations and iterate multiple times through the algorithm

promoteEdges

protected boolean promoteEdges

Whether or not to promote edges that terminate on vertices with different but common ancestry to appear connected to the highest siblings in the ancestry chains

traverseAncestors

protected boolean traverseAncestors

Whether or not to navigate edges whose terminal vertices have different parents but are in the same ancestry chain

model

protected mxGraphHierarchyModel model

The internal model formed of the layout

Constructor Detail

mxHierarchicalLayout

public mxHierarchicalLayout(mxGraph graph)

Constructs a hierarchical layout

Parameters:

graph - the graph to lay out

mxHierarchicalLayout

public mxHierarchicalLayout(mxGraph graph,
                            int orientation)

Constructs a hierarchical layout

Parameters:

graph - the graph to lay out

orientation - SwingConstants.NORTH, SwingConstants.EAST, SwingConstants.SOUTH or SwingConstants.WEST

Method Detail

getModel

public mxGraphHierarchyModel getModel()

Returns the model for this layout algorithm.

execute

public void execute(Object parent)

Executes the layout for the children of the specified parent.

Specified by:

execute in interface mxIGraphLayout

Overrides:

execute in class mxGraphLayout

Parameters:

parent - Parent cell that contains the children to be laid out.

execute

public void execute(Object parent,
                    List<Object> roots)

Executes the layout for the children of the specified parent.

Parameters:

parent - Parent cell that contains the children to be laid out.

roots - the starting roots of the layout

findRoots

public List<Object> findRoots(Object parent,
                              Set<Object> vertices)

Returns all visible children in the given parent which do not have incoming edges. If the result is empty then the children with the maximum difference between incoming and outgoing edges are returned. This takes into account edges that are being promoted to the given root due to invisible children or collapsed cells.

Parameters:

parent - Cell whose children should be checked.

Returns:

List of tree roots in parent.

getEdges

public Object[] getEdges(Object cell)

Parameters:

cell -

Returns:

run

public void run(Object parent)

The API method used to exercise the layout upon the graph description and produce a separate description of the vertex position and edge routing changes made.

filterDescendants

public Set<Object> filterDescendants(Object cell)

Creates a set of descendant cells

Parameters:

cell - The cell whose descendants are to be calculated

Returns:

the descendants of the cell (not the cell)

traverse

protected void traverse(Object vertex,
                        boolean directed,
                        Object edge,
                        Set<Object> allVertices,
                        Set<Object> currentComp,
                        List<Set<Object>> hierarchyVertices,
                        Set<Object> filledVertexSet)

Traverses the (directed) graph invoking the given function for each visited vertex and edge. The function is invoked with the current vertex and the incoming edge as a parameter. This implementation makes sure each vertex is only visited once. The function may return false if the traversal should stop at the given vertex.

Parameters:

vertex - that represents the vertex where the traversal starts.

directed - Optional boolean indicating if edges should only be traversed from source to target. Default is true.

edge - Optional that represents the incoming edge. This is null for the first step of the traversal.

allVertices - Array of cell paths for the visited cells.

cycleStage

public void cycleStage(Object parent)

Executes the cycle stage. This implementation uses the mxMinimumCycleRemover.

layeringStage

public void layeringStage()

Implements first stage of a Sugiyama layout.

crossingStage

public void crossingStage(Object parent)

Executes the crossing stage using mxMedianHybridCrossingReduction.

placementStage

public double placementStage(double initialX,
                             Object parent)

Executes the placement stage using mxCoordinateAssignment.

isResizeParent

public boolean isResizeParent()

Returns the resizeParent flag.

setResizeParent

public void setResizeParent(boolean value)

Sets the resizeParent flag.

isMoveParent

public boolean isMoveParent()

Returns the moveParent flag.

setMoveParent

public void setMoveParent(boolean value)

Sets the moveParent flag.

getParentBorder

public int getParentBorder()

Returns parentBorder.

setParentBorder

public void setParentBorder(int value)

Sets parentBorder.

getIntraCellSpacing

public double getIntraCellSpacing()

Returns:

Returns the intraCellSpacing.

setIntraCellSpacing

public void setIntraCellSpacing(double intraCellSpacing)

Parameters:

intraCellSpacing - The intraCellSpacing to set.

getInterRankCellSpacing

public double getInterRankCellSpacing()

Returns:

Returns the interRankCellSpacing.

setInterRankCellSpacing

public void setInterRankCellSpacing(double interRankCellSpacing)

Parameters:

interRankCellSpacing - The interRankCellSpacing to set.

getOrientation

public int getOrientation()

Returns:

Returns the orientation.

setOrientation

public void setOrientation(int orientation)

Parameters:

orientation - The orientation to set.

getInterHierarchySpacing

public double getInterHierarchySpacing()

Returns:

Returns the interHierarchySpacing.

setInterHierarchySpacing

public void setInterHierarchySpacing(double interHierarchySpacing)

Parameters:

interHierarchySpacing - The interHierarchySpacing to set.

getParallelEdgeSpacing

public double getParallelEdgeSpacing()

setParallelEdgeSpacing

public void setParallelEdgeSpacing(double parallelEdgeSpacing)

isFineTuning

public boolean isFineTuning()

Returns:

Returns the fineTuning.

setFineTuning

public void setFineTuning(boolean fineTuning)

Parameters:

fineTuning - The fineTuning to set.

isDisableEdgeStyle

public boolean isDisableEdgeStyle()

setDisableEdgeStyle

public void setDisableEdgeStyle(boolean disableEdgeStyle)

Parameters:

disableEdgeStyle -

setLoggerLevel

public void setLoggerLevel(Level level)

Sets the logging level of this class

Parameters:

level - the logging level to set

toString

public String toString()

Returns Hierarchical, the name of this algorithm.

Overrides:

toString in class Object