com.yworks.yfiles.layout.multipage

Interface INodeInfo

public interface INodeInfo

This interface offers access to information associated with a node.

The information can be either obtained from MultiPageLayoutResult.getNodeInfo(Node) or LayoutContext.getNodeInfo(Node).

Method Summary

Modifier and Type	Method and Description
Object	getId() Gets the unique ID of the node associated with this info object.
int	getPageNo() Gets the page number of the page graph that contains the node associated with this info object.
Node	getReferencingNode() Gets the node that refers to the one associated with this info object.
Node	getRepresentedNode() Gets the node of the input graph that is represented by the node associated with this info object.
NodeType	getType() Gets the type of the node associated with this info object.

Method Detail

getId

Object getId()

Gets the unique ID of the node associated with this info object.

Returns:

the ID of the node

See Also:

MultiPageLayout.NODE_ID_DPKEY

getPageNo

int getPageNo()

Gets the page number of the page graph that contains the node associated with this info object.

This information is first available after the layout run.

Returns:

the page of the associated node

getReferencingNode

Node getReferencingNode()

Gets the node that refers to the one associated with this info object.

More precisely, if the node associated with this info object

• is a connector node, this method returns the matching connector node,
• is a proxy node, it returns the corresponding proxy reference node,
• is a proxy reference node, it returns the corresponding proxy node,
• or otherwise, it returns null.

Returns:

the referencing node

See Also:

NodeType.CONNECTOR, NodeType.PROXY, NodeType.PROXY_REFERENCE

getRepresentedNode

Node getRepresentedNode()

Gets the node of the input graph that is represented by the node associated with this info object.

Note that, for the special nodes inserted to guarantee that no information is lost, there are no corresponding nodes in the input graph. Hence, special nodes are mapped to common nodes in the following way:

• A connector node is mapped to the common node connected to the matching connector.
• A proxy node is mapped to the associated common node (i.e., the proxy is a copy of that node).
• A proxy reference node is not mapped to any node, and, thus this method returns null for such nodes.

All nodes of the page graphs are created by the layout algorithm, the input graph remains unchanged. Matching elements are mapped to the same element ID, see MultiPageLayout.NODE_ID_DPKEY, MultiPageLayout.EDGE_ID_DPKEY, MultiPageLayout.NODE_LABEL_ID_DPKEY and MultiPageLayout.EDGE_LABEL_ID_DPKEY. This method always returns a node of the input graph!

Returns:

the represented node

getType

NodeType getType()

Gets the type of the node associated with this info object.

Returns:

the type of the node