com.yworks.yfiles.layout.organic

Class OrganicLayoutData

java.lang.Object

com.yworks.yfiles.layout.LayoutData

com.yworks.yfiles.layout.organic.OrganicLayoutData

public class OrganicLayoutData
extends LayoutData

Specifies custom data for the OrganicLayout.

Constructor Summary

Constructors

Constructor and Description
OrganicLayoutData()

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>	getAffectedNodes() Gets the collection of nodes that is laid out by the layout.
ItemMapping<IEdge,Double>	getEdgeDirectedness() Gets the mapping from edges to their directedness.
ItemMapping<INode,GroupNodeMode>	getGroupNodeModes() Gets the mapping from group nodes to a mode constant describing how to handle the group node.
ItemMapping<INode,Double>	getMinimumNodeDistances() Gets the mapping from nodes to their minimum distance to other nodes.
ItemMapping<INode,NodeHalo>	getNodeHalos() Gets the mapping from nodes to their NodeHalo.
PartitionGridData	getPartitionGridData() Gets the partition grid layout data.
ItemMapping<IEdge,Double>	getPreferredEdgeLengths() Gets the mapping from edges to their preferred edge length.
void	setAbortHandler(AbortHandler value) Sets the AbortHandler used during the layout.
void	setAffectedNodes(ItemCollection<INode> value) Sets the collection of nodes that is laid out by the layout.
void	setEdgeDirectedness(ItemMapping<IEdge,Double> value) Sets the mapping from edges to their directedness.
void	setGroupNodeModes(ItemMapping<INode,GroupNodeMode> value) Sets the mapping from group nodes to a mode constant describing how to handle the group node.
void	setMinimumNodeDistances(ItemMapping<INode,Double> value) Sets the mapping from nodes to their minimum distance to other nodes.
void	setNodeHalos(ItemMapping<INode,NodeHalo> value) Sets the mapping from nodes to their NodeHalo.
void	setPartitionGridData(PartitionGridData value) Sets the partition grid layout data.
void	setPreferredEdgeLengths(ItemMapping<IEdge,Double> value) Sets the mapping from edges to their preferred edge length.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrganicLayoutData

public OrganicLayoutData()

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)

getAffectedNodes

public final ItemCollection<INode> getAffectedNodes()

Gets the collection of nodes that is laid out by the layout.

Returns:

The AffectedNodes.

See Also:

OrganicLayout.AFFECTED_NODES_DPKEY, setAffectedNodes(ItemCollection)

getEdgeDirectedness

public final ItemMapping<IEdge,Double> getEdgeDirectedness()

Gets the mapping from edges to their directedness.

Generally, the organic layout algorithm doesn't consider the edge direction. Nevertheless, this property allows the user to specify hints on the directedness of edges. More precisely, a value of 1 indicates that the edge should be considered to be directed from source to target, a value of -1 that it is directed from target to source, and a value of 0 means that it is undirected.

Currently, the specified values are only considered during the detection of special substructures, see ChainSubstructureStyle, CycleSubstructureStyle, ParallelSubstructureStyle and StarSubstructureStyle.

Returns:

The EdgeDirectedness.

See Also:

OrganicLayout.EDGE_DIRECTEDNESS_DPKEY, setEdgeDirectedness(ItemMapping)

getGroupNodeModes

public final ItemMapping<INode,GroupNodeMode> getGroupNodeModes()

Gets the mapping from group nodes to a mode constant describing how to handle the group node.

The algorithm expects for each group node to find one of the following constants or null:

• GroupNodeMode.NORMAL
• GroupNodeMode.FIX_BOUNDS
• GroupNodeMode.FIX_CONTENTS

Returns:

The GroupNodeModes.

See Also:

OrganicLayout.GROUP_NODE_MODE_DPKEY, setGroupNodeModes(ItemMapping)

getMinimumNodeDistances

public final ItemMapping<INode,Double> getMinimumNodeDistances()

Gets the mapping from nodes to their minimum distance to other nodes.

Note that the distances are only considered by the internally used ShuffleLayout when NodeOverlapsAllowed is true and Scope is not Scope.ALL.

Returns:

The MinimumNodeDistances.

See Also:

ShuffleLayout.MINIMUM_DISTANCE_DPKEY, setMinimumNodeDistances(ItemMapping)

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)

getPartitionGridData

public final PartitionGridData getPartitionGridData()

Gets the partition grid layout data.

Returns:

The PartitionGridData.

See Also:

setPartitionGridData(PartitionGridData)

getPreferredEdgeLengths

public final ItemMapping<IEdge,Double> getPreferredEdgeLengths()

Gets the mapping from edges to their preferred edge length.

Returns:

The PreferredEdgeLengths.

See Also:

OrganicLayout.PREFERRED_EDGE_LENGTH_DPKEY, setPreferredEdgeLengths(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()

setAffectedNodes

public final void setAffectedNodes(ItemCollection<INode> value)

Sets the collection of nodes that is laid out by the layout.

Parameters:

value - The AffectedNodes to set.

See Also:

OrganicLayout.AFFECTED_NODES_DPKEY, getAffectedNodes()

setEdgeDirectedness

public final void setEdgeDirectedness(ItemMapping<IEdge,Double> value)

Sets the mapping from edges to their directedness.

Generally, the organic layout algorithm doesn't consider the edge direction. Nevertheless, this property allows the user to specify hints on the directedness of edges. More precisely, a value of 1 indicates that the edge should be considered to be directed from source to target, a value of -1 that it is directed from target to source, and a value of 0 means that it is undirected.

Currently, the specified values are only considered during the detection of special substructures, see ChainSubstructureStyle, CycleSubstructureStyle, ParallelSubstructureStyle and StarSubstructureStyle.

Parameters:

value - The EdgeDirectedness to set.

See Also:

OrganicLayout.EDGE_DIRECTEDNESS_DPKEY, getEdgeDirectedness()

setGroupNodeModes

public final void setGroupNodeModes(ItemMapping<INode,GroupNodeMode> value)

Sets the mapping from group nodes to a mode constant describing how to handle the group node.

The algorithm expects for each group node to find one of the following constants or null:

• GroupNodeMode.NORMAL
• GroupNodeMode.FIX_BOUNDS
• GroupNodeMode.FIX_CONTENTS

Parameters:

value - The GroupNodeModes to set.

See Also:

OrganicLayout.GROUP_NODE_MODE_DPKEY, getGroupNodeModes()

setMinimumNodeDistances

public final void setMinimumNodeDistances(ItemMapping<INode,Double> value)

Sets the mapping from nodes to their minimum distance to other nodes.

Note that the distances are only considered by the internally used ShuffleLayout when NodeOverlapsAllowed is true and Scope is not Scope.ALL.

Parameters:

value - The MinimumNodeDistances to set.

See Also:

ShuffleLayout.MINIMUM_DISTANCE_DPKEY, getMinimumNodeDistances()

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()

setPartitionGridData

public final void setPartitionGridData(PartitionGridData value)

Sets the partition grid layout data.

Parameters:

value - The PartitionGridData to set.

See Also:

getPartitionGridData()

setPreferredEdgeLengths

public final void setPreferredEdgeLengths(ItemMapping<IEdge,Double> value)

Sets the mapping from edges to their preferred edge length.

Parameters:

value - The PreferredEdgeLengths to set.

See Also:

OrganicLayout.PREFERRED_EDGE_LENGTH_DPKEY, getPreferredEdgeLengths()