com.yworks.yfiles.layout.tree

Class BalloonLayoutData

java.lang.Object

com.yworks.yfiles.layout.LayoutData

com.yworks.yfiles.layout.tree.BalloonLayoutData

public class BalloonLayoutData
extends LayoutData

Specifies custom data for the BalloonLayout.

Constructor Summary

Constructors

Constructor and Description
BalloonLayoutData()

Method Summary

Modifier and Type	Method and Description
void	apply(LayoutGraphAdapter adapter, ILayoutAlgorithm layout, CopiedLayoutGraph layoutGraph) Applies this layout data to the specified layoutGraphAdapter.
AbortHandler	getAbortHandler() Gets the AbortHandler used during the layout.
ItemCollection<INode>	getInterleavedNodes() Gets the collection of nodes that should be arranged in an interleaved fashion.
ItemMapping<INode,NodeHalo>	getNodeHalos() Gets the mapping from nodes to their NodeHalo.
ItemMapping<INode,Boolean>	getTreeRoot() Gets the mapping for marking the node that will be used as root node of the tree.
void	setAbortHandler(AbortHandler value) Sets the AbortHandler used during the layout.
void	setInterleavedNodes(ItemCollection<INode> value) Sets the collection of nodes that should be arranged in an interleaved fashion.
void	setNodeHalos(ItemMapping<INode,NodeHalo> value) Sets the mapping from nodes to their NodeHalo.
void	setTreeRoot(ItemMapping<INode,Boolean> value) Sets the mapping for marking the node that will be used as root node of the tree.

Methods inherited from class java.lang.Object

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

Constructor Detail

BalloonLayoutData

public BalloonLayoutData()

Method Detail

apply

public void apply(LayoutGraphAdapter adapter,
                  ILayoutAlgorithm layout,
                  CopiedLayoutGraph layoutGraph)

Description copied from class: LayoutData

Applies this layout data to the specified layoutGraphAdapter.

Specified by:

apply in class LayoutData

Parameters:

adapter - The adapter to add the layout data to.

layout - The layout that shall use this layout data.

layoutGraph - The layout graph used for the layout calculation.

getAbortHandler

public final AbortHandler getAbortHandler()

Gets the AbortHandler used during the layout.

Returns:

The AbortHandler.

See Also:

AbortHandler.ABORT_HANDLER_DPKEY, setAbortHandler(AbortHandler)

getInterleavedNodes

public final ItemCollection<INode> getInterleavedNodes()

Gets the collection of nodes that should be arranged in an interleaved fashion.

Returns:

The InterleavedNodes.

See Also:

BalloonLayout.INTERLEAVED_NODES_DPKEY, setInterleavedNodes(ItemCollection)

getNodeHalos

public final ItemMapping<INode,NodeHalo> getNodeHalos()

Gets the mapping from nodes to their NodeHalo.

Returns:

The NodeHalos.

See Also:

NodeHalo.NODE_HALO_DPKEY, setNodeHalos(ItemMapping)

getTreeRoot

public final ItemMapping<INode,Boolean> getTreeRoot()

Gets the mapping for marking the node that will be used as root node of the tree.

The custom root node selection induced by this property is only considered if the root node policy is set to RootNodePolicy.SELECTED_ROOT.

Returns:

The TreeRoot.

See Also:

BalloonLayout.SELECTED_ROOT_DPKEY, setTreeRoot(ItemMapping)

setAbortHandler

public final void setAbortHandler(AbortHandler value)

Sets the AbortHandler used during the layout.

Parameters:

value - The AbortHandler to set.

See Also:

AbortHandler.ABORT_HANDLER_DPKEY, getAbortHandler()

setInterleavedNodes

public final void setInterleavedNodes(ItemCollection<INode> value)

Sets the collection of nodes that should be arranged in an interleaved fashion.

Parameters:

value - The InterleavedNodes to set.

See Also:

BalloonLayout.INTERLEAVED_NODES_DPKEY, getInterleavedNodes()

setNodeHalos

public final void setNodeHalos(ItemMapping<INode,NodeHalo> value)

Sets the mapping from nodes to their NodeHalo.

Parameters:

value - The NodeHalos to set.

See Also:

NodeHalo.NODE_HALO_DPKEY, getNodeHalos()

setTreeRoot

public final void setTreeRoot(ItemMapping<INode,Boolean> value)

Sets the mapping for marking the node that will be used as root node of the tree.

The custom root node selection induced by this property is only considered if the root node policy is set to RootNodePolicy.SELECTED_ROOT.

Parameters:

value - The TreeRoot to set.

See Also:

BalloonLayout.SELECTED_ROOT_DPKEY, getTreeRoot()