com.yworks.yfiles.layout.multipage

Class MultiPageLayoutResult

java.lang.Object

com.yworks.yfiles.layout.multipage.MultiPageLayoutResult

All Implemented Interfaces:

IElementInfoManager

public class MultiPageLayoutResult
extends Object
implements IElementInfoManager

This class represents the result of a layout run of MultiPageLayout.

A layout run subdivides the input graph into several LayoutGraphs (called page graphs) such that the layout of each graph fits the specified maximum page size. This class provides access to the different page graphs (see method getPage(int)).

An instance of this class can be either obtained by calling MultiPageLayout.calculateLayout(LayoutGraph) or MultiPageLayout.applyLayout(LayoutGraph). In the latter case, a ILayoutCallback has to be set before starting the layout run.

Method Summary

Modifier and Type	Method and Description
IEdgeInfo	getEdgeInfo(Edge edge) Returns the edge information object of the given edge.
IEdgeLabelInfo	getEdgeLabelInfo(IEdgeLabelLayout edgeLabelLayout) Returns the edge label information object of the given edge label layout.
INodeInfo	getNodeInfo(Node node) Returns the node information object of the given node.
INodeLabelInfo	getNodeLabelInfo(INodeLabelLayout nodeLabelLayout) Returns the node label layout information object of the given node label layout.
LayoutGraph	getPage(int pageNo) Returns the page graph associated with the given page number.
int	pageCount() Returns the number of pages available in this MultiPageLayoutResult.

Methods inherited from class java.lang.Object

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

Method Detail

getEdgeInfo

public IEdgeInfo getEdgeInfo(Edge edge)

Description copied from interface: IElementInfoManager

Returns the edge information object of the given edge.

Specified by:

getEdgeInfo in interface IElementInfoManager

Parameters:

edge - the edge for which the information object should be returned

Returns:

the edge information object of the given edge

getEdgeLabelInfo

public IEdgeLabelInfo getEdgeLabelInfo(IEdgeLabelLayout edgeLabelLayout)

Description copied from interface: IElementInfoManager

Returns the edge label information object of the given edge label layout.

Specified by:

getEdgeLabelInfo in interface IElementInfoManager

Parameters:

edgeLabelLayout - the edge label layout for which the information object should be returned

Returns:

the edge label information object of the given edge label layout

getNodeInfo

public INodeInfo getNodeInfo(Node node)

Description copied from interface: IElementInfoManager

Returns the node information object of the given node.

Specified by:

getNodeInfo in interface IElementInfoManager

Parameters:

node - the node for which the information object should be returned

Returns:

the node information object of the given node

getNodeLabelInfo

public INodeLabelInfo getNodeLabelInfo(INodeLabelLayout nodeLabelLayout)

Description copied from interface: IElementInfoManager

Returns the node label layout information object of the given node label layout.

Specified by:

getNodeLabelInfo in interface IElementInfoManager

Parameters:

nodeLabelLayout - the node label layout for which the information object should be returned

Returns:

the node label information object of the given node label layout

getPage

public LayoutGraph getPage(int pageNo)

Returns the page graph associated with the given page number.

A page graph is a subgraph of the input graph whose layout fits the specified maximum page size.

Throws:

IndexOutOfBoundsException - if pageNo >= pageCount or pageNo < 0

A page graph contains special nodes (that are not contained in the input graph) to guarantee that no information is lost when splitting edges that connect nodes placed on different pages.

Parameters:

pageNo - the given page number

Returns:

the page graph associated with the given page number

See Also:

pageCount()

pageCount

public int pageCount()

Returns the number of pages available in this MultiPageLayoutResult.

Each page contains a page graph whose layout fits the specified maximum page size.

Returns:

the number of available pages

See Also:

getPage(int)