Search this API

y.layout.multipage
Class MultiPageLayout

java.lang.Object
  extended by y.layout.multipage.MultiPageLayout
All Implemented Interfaces:
ElementInfoManager

public class MultiPageLayout
extends Object
implements ElementInfoManager

Represents the result of a layout run of the MultiPageLayouter.


Method Summary
 EdgeInfo getEdgeInfo(Edge e)
          Returns the edge information object of the given edge.
 EdgeLabelInfo getEdgeLabelInfo(EdgeLabelLayout ell)
          Returns the edge label information object of the given edge label layout.
 NodeInfo getNodeInfo(Node n)
          Returns the node information object of the given node.
 NodeLabelInfo getNodeLabelInfo(NodeLabelLayout nll)
          Returns the node label layout information object of the given node label layout.
 LayoutGraph getPage(int pageNo)
          Returns the layout graph on the given page.
 int pageCount()
          Returns the number of pages available in this MultiPageLayout.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

pageCount

public int pageCount()
Returns the number of pages available in this MultiPageLayout.

Returns:
the number of available pages.
See Also:
getPage(int)

getPage

public LayoutGraph getPage(int pageNo)
Returns the layout graph on the given page.

Throws:
IndexOutOfBoundsException - if pageNo >= pageCount or pageNo < 0.
Parameters:
pageNo - the page for which the layout graph. Allowed value range is 0 <= pageNo < pageCount.
Returns:
the layout graph on the given page.
See Also:
pageCount()

getEdgeInfo

public EdgeInfo getEdgeInfo(Edge e)
Description copied from interface: ElementInfoManager
Returns the edge information object of the given edge.

Specified by:
getEdgeInfo in interface ElementInfoManager
Parameters:
e - the edge for which the information object should be returned.
Returns:
the edge information object of the given edge.

getNodeInfo

public NodeInfo getNodeInfo(Node n)
Description copied from interface: ElementInfoManager
Returns the node information object of the given node.

Specified by:
getNodeInfo in interface ElementInfoManager
Parameters:
n - the node for which the information object should be returned.
Returns:
the node information object of the given node.

getNodeLabelInfo

public NodeLabelInfo getNodeLabelInfo(NodeLabelLayout nll)
Description copied from interface: ElementInfoManager
Returns the node label layout information object of the given node label layout.

Specified by:
getNodeLabelInfo in interface ElementInfoManager
Parameters:
nll - the node label layout for which the information object should be returned.
Returns:
the node label information object of the given node label layout.

getEdgeLabelInfo

public EdgeLabelInfo getEdgeLabelInfo(EdgeLabelLayout ell)
Description copied from interface: ElementInfoManager
Returns the edge label information object of the given edge label layout.

Specified by:
getEdgeLabelInfo in interface ElementInfoManager
Parameters:
ell - the edge label layout for which the information object should be returned.
Returns:
the edge label information object of the given edge label layout.

© Copyright 2000-2013,
yWorks GmbH.
All rights reserved.