com.yworks.yfiles.layout.multipage

Class MultiPageLayoutData

java.lang.Object

com.yworks.yfiles.layout.LayoutData

com.yworks.yfiles.layout.multipage.MultiPageLayoutData

public class MultiPageLayoutData
extends LayoutData

Specifies custom data for the MultiPageLayout.

Constructor Summary

Constructors

Constructor and Description
MultiPageLayoutData()

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.
ItemMapping<IEdge,Object>	getEdgeIds() Gets the mapping from edges to their unique IDs.
ItemMapping<ILabel,Object>	getEdgeLabelIds() Gets the mapping from edge labels to their unique IDs.
ItemMapping<IEdge,Object>	getEdgeTypes() Gets the mapping from edges to their type.
ItemMapping<INode,Object>	getNodeClusterIds() Gets the mapping from nodes to their cluster id.
ItemMapping<INode,Object>	getNodeIds() Gets the mapping from nodes to their unique IDs.
ItemMapping<ILabel,Object>	getNodeLabelIds() Gets the mapping from node labels to their unique IDs.
void	setAbortHandler(AbortHandler value) Sets the AbortHandler used during the layout.
void	setEdgeIds(ItemMapping<IEdge,Object> value) Sets the mapping from edges to their unique IDs.
void	setEdgeLabelIds(ItemMapping<ILabel,Object> value) Sets the mapping from edge labels to their unique IDs.
void	setEdgeTypes(ItemMapping<IEdge,Object> value) Sets the mapping from edges to their type.
void	setNodeClusterIds(ItemMapping<INode,Object> value) Sets the mapping from nodes to their cluster id.
void	setNodeIds(ItemMapping<INode,Object> value) Sets the mapping from nodes to their unique IDs.
void	setNodeLabelIds(ItemMapping<ILabel,Object> value) Sets the mapping from node labels to their unique IDs.

Methods inherited from class java.lang.Object

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

Constructor Detail

MultiPageLayoutData

public MultiPageLayoutData()

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)

getEdgeIds

public final ItemMapping<IEdge,Object> getEdgeIds()

Gets the mapping from edges to their unique IDs.

Returns:

The EdgeIds.

See Also:

MultiPageLayout.EDGE_ID_DPKEY, setEdgeIds(ItemMapping)

getEdgeLabelIds

public final ItemMapping<ILabel,Object> getEdgeLabelIds()

Gets the mapping from edge labels to their unique IDs.

Returns:

The EdgeLabelIds.

See Also:

MultiPageLayout.EDGE_LABEL_ID_DPKEY, setEdgeLabelIds(ItemMapping)

getEdgeTypes

public final ItemMapping<IEdge,Object> getEdgeTypes()

Gets the mapping from edges to their type.

Multi-edges (edges with same endpoints) of different kind are distinguished if EdgeBundleModeMask & EdgeBundleModes.DISTINGUISH_TYPES == 1.

Returns:

The EdgeTypes.

See Also:

MultiPageLayout.EDGE_TYPE_DPKEY, setEdgeTypes(ItemMapping)

getNodeClusterIds

public final ItemMapping<INode,Object> getNodeClusterIds()

Gets the mapping from nodes to their cluster id.

Nodes with the same cluster id should preferably be placed on the same page.

Returns:

The NodeClusterIds.

See Also:

MultiPageLayout.NODE_CLUSTER_ID_DPKEY, setNodeClusterIds(ItemMapping)

getNodeIds

public final ItemMapping<INode,Object> getNodeIds()

Gets the mapping from nodes to their unique IDs.

Returns:

The NodeIds.

See Also:

MultiPageLayout.NODE_ID_DPKEY, setNodeIds(ItemMapping)

getNodeLabelIds

public final ItemMapping<ILabel,Object> getNodeLabelIds()

Gets the mapping from node labels to their unique IDs.

Returns:

The NodeLabelIds.

See Also:

MultiPageLayout.NODE_LABEL_ID_DPKEY, setNodeLabelIds(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()

setEdgeIds

public final void setEdgeIds(ItemMapping<IEdge,Object> value)

Sets the mapping from edges to their unique IDs.

Parameters:

value - The EdgeIds to set.

See Also:

MultiPageLayout.EDGE_ID_DPKEY, getEdgeIds()

setEdgeLabelIds

public final void setEdgeLabelIds(ItemMapping<ILabel,Object> value)

Sets the mapping from edge labels to their unique IDs.

Parameters:

value - The EdgeLabelIds to set.

See Also:

MultiPageLayout.EDGE_LABEL_ID_DPKEY, getEdgeLabelIds()

setEdgeTypes

public final void setEdgeTypes(ItemMapping<IEdge,Object> value)

Sets the mapping from edges to their type.

Multi-edges (edges with same endpoints) of different kind are distinguished if EdgeBundleModeMask & EdgeBundleModes.DISTINGUISH_TYPES == 1.

Parameters:

value - The EdgeTypes to set.

See Also:

MultiPageLayout.EDGE_TYPE_DPKEY, getEdgeTypes()

setNodeClusterIds

public final void setNodeClusterIds(ItemMapping<INode,Object> value)

Sets the mapping from nodes to their cluster id.

Nodes with the same cluster id should preferably be placed on the same page.

Parameters:

value - The NodeClusterIds to set.

See Also:

MultiPageLayout.NODE_CLUSTER_ID_DPKEY, getNodeClusterIds()

setNodeIds

public final void setNodeIds(ItemMapping<INode,Object> value)

Sets the mapping from nodes to their unique IDs.

Parameters:

value - The NodeIds to set.

See Also:

MultiPageLayout.NODE_ID_DPKEY, getNodeIds()

setNodeLabelIds

public final void setNodeLabelIds(ItemMapping<ILabel,Object> value)

Sets the mapping from node labels to their unique IDs.

Parameters:

value - The NodeLabelIds to set.

See Also:

MultiPageLayout.NODE_LABEL_ID_DPKEY, getNodeLabelIds()