y.layout.multipage
Interface NodeInfo

public interface NodeInfo

A class that holds all information related to a node.

Field Summary

static byte	TYPE_CONNECTOR Node type specifier.
static byte	TYPE_GROUP Node type specifier.
static byte	TYPE_NORMAL Node type specifier.
static byte	TYPE_PROXY Node type specifier.
static byte	TYPE_PROXY_REFERENCE Node type specifier.

Method Summary

Object	getId() Returns the unique id of the related node.
int	getPageNo() Returns the page of the related node.
Node	getReferencingNode() Returns the referencing node.
Node	getRepresentedNode() Returns the represented node (always a node of the input graph).
byte	getType() Returns the type of the related node.

Field Detail

TYPE_NORMAL

static final byte TYPE_NORMAL

Node type specifier. This value specifies that the node is a normal node, i.e., it does not belong to another type.

See Also:

getType(), Constant Field Values

TYPE_GROUP

static final byte TYPE_GROUP

Node type specifier. This value specifies that the node is a group node, i.e., a node that contains other nodes.

See Also:

getType(), Constant Field Values

TYPE_PROXY

static final byte TYPE_PROXY

Node type specifier. This value specifies that the node is a proxy node, i.e., it is a copy of a normal node.

See Also:

getType(), TYPE_NORMAL, Constant Field Values

TYPE_PROXY_REFERENCE

static final byte TYPE_PROXY_REFERENCE

Node type specifier. This value specifies that the node is a proxy reference node, i.e., it refers to a proxy node.

See Also:

getType(), TYPE_PROXY, Constant Field Values

TYPE_CONNECTOR

static final byte TYPE_CONNECTOR

Node type specifier. This value specifies that the node is a connector node, i.e., a node that represents a jump mark to another connector node. Such a connector pair is used to represent edges that connects two nodes on different pages.

See Also:

getType(), Constant Field Values

Method Detail

getRepresentedNode

Node getRepresentedNode()

Returns the represented node (always a node of the input graph). That is, if the related node has type connector this method returns the neighbor of the matching connector node, if the related node has type proxy it returns the corresponding original node, if the related node has type proxy reference it returns null, and, otherwise, it returns the corresponding node in the input graph.

Returns:

the represented node.

getPageNo

int getPageNo()

Returns the page of the related node. This information is available after the layout.

Returns:

the page of the related node.

getType

byte getType()

Returns the type of the related node.

Returns:

the type of the related node.

getId

Object getId()

Returns the unique id of the related node.

Returns:

the id of the related node.

getReferencingNode

Node getReferencingNode()

Returns the referencing node. That is, if the related node has type connector this method returns the opposite connector node, if the related node has type proxy reference it returns the corresponding proxy node, if the related node has type proxy it returns the corresponding proxy reference node; otherwise it returns null.

Returns:

the referencing node.