com.mxgraph.layout

Class mxCompactTreeLayout

java.lang.Object

com.mxgraph.layout.mxGraphLayout

com.mxgraph.layout.mxCompactTreeLayout

All Implemented Interfaces:

mxIGraphLayout

public class mxCompactTreeLayout
extends mxGraphLayout

Constructor Summary

Constructors

Constructor and Description
mxCompactTreeLayout(mxGraph graph)
mxCompactTreeLayout(mxGraph graph, boolean horizontal)
mxCompactTreeLayout(mxGraph graph, boolean horizontal, boolean invert)

Method Summary

Modifier and Type	Method and Description
void	execute(java.lang.Object parent) Executes the layout for the children of the specified parent.
void	execute(java.lang.Object parent, java.lang.Object root) Implements .
java.util.List<java.lang.Object>	findTreeRoots(java.lang.Object parent, boolean invert) Returns all visible children in the given parent which do not have incoming edges.
double	getGroupPadding()
int	getLevelDistance()
int	getNodeDistance()
boolean	isEdgeRouting()
boolean	isHorizontal()
boolean	isInvert()
boolean	isMoveTree()
boolean	isResetEdges()
boolean	isResizeParent()
boolean	isVertexIgnored(java.lang.Object vertex) Returns a boolean indicating if the given should be ignored as a vertex.
void	setEdgeRouting(boolean edgeRouting)
void	setGroupPadding(int groupPadding)
void	setHorizontal(boolean horizontal)
void	setInvert(boolean invert)
void	setLevelDistance(int levelDistance)
void	setMoveTree(boolean moveTree)
void	setNodeDistance(int nodeDistance)
void	setResetEdges(boolean resetEdges)
void	setResizeParent(boolean resizeParent)

Methods inherited from class com.mxgraph.layout.mxGraphLayout

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

Methods inherited from class java.lang.Object

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

Constructor Detail

mxCompactTreeLayout

public mxCompactTreeLayout(mxGraph graph)

Parameters:

graph -

mxCompactTreeLayout

public mxCompactTreeLayout(mxGraph graph,
                           boolean horizontal)

Parameters:

graph -

horizontal -

mxCompactTreeLayout

public mxCompactTreeLayout(mxGraph graph,
                           boolean horizontal,
                           boolean invert)

Parameters:

graph -

horizontal -

invert -

Method Detail

isVertexIgnored

public boolean isVertexIgnored(java.lang.Object vertex)

Returns a boolean indicating if the given should be ignored as a vertex. This returns true if the cell has no connections.

Overrides:

isVertexIgnored in class mxGraphLayout

Parameters:

vertex - Object that represents the vertex to be tested.

Returns:

Returns true if the vertex should be ignored.

isHorizontal

public boolean isHorizontal()

Returns:

the horizontal

setHorizontal

public void setHorizontal(boolean horizontal)

Parameters:

horizontal - the horizontal to set

isInvert

public boolean isInvert()

Returns:

the invert

setInvert

public void setInvert(boolean invert)

Parameters:

invert - the invert to set

isResizeParent

public boolean isResizeParent()

Returns:

the resizeParent

setResizeParent

public void setResizeParent(boolean resizeParent)

Parameters:

resizeParent - the resizeParent to set

isMoveTree

public boolean isMoveTree()

Returns:

the moveTree

setMoveTree

public void setMoveTree(boolean moveTree)

Parameters:

moveTree - the moveTree to set

isResetEdges

public boolean isResetEdges()

Returns:

the resetEdges

setResetEdges

public void setResetEdges(boolean resetEdges)

Parameters:

resetEdges - the resetEdges to set

isEdgeRouting

public boolean isEdgeRouting()

setEdgeRouting

public void setEdgeRouting(boolean edgeRouting)

getLevelDistance

public int getLevelDistance()

Returns:

the levelDistance

setLevelDistance

public void setLevelDistance(int levelDistance)

Parameters:

levelDistance - the levelDistance to set

getNodeDistance

public int getNodeDistance()

Returns:

the nodeDistance

setNodeDistance

public void setNodeDistance(int nodeDistance)

Parameters:

nodeDistance - the nodeDistance to set

getGroupPadding

public double getGroupPadding()

setGroupPadding

public void setGroupPadding(int groupPadding)

execute

public void execute(java.lang.Object parent)

Description copied from interface: mxIGraphLayout

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 layed out.

execute

public void execute(java.lang.Object parent,
                    java.lang.Object root)

Implements . If the parent has any connected edges, then it is used as the root of the tree. Else, will be used to find a suitable root node within the set of children of the given parent.

findTreeRoots

public java.util.List<java.lang.Object> findTreeRoots(java.lang.Object parent,
                                                      boolean invert)

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.

invert - Specifies if outgoing or incoming edges should be counted for a tree root. If false then outgoing edges will be counted.

Returns:

List of tree roots in parent.