Search this API

y.layout.multipage
Interface EdgeInfo


public interface EdgeInfo

A class that holds all information related to an edge.


Field Summary
static byte TYPE_CONNECTOR
          Edge type specifier.
static byte TYPE_NORMAL
          Edge type specifier.
static byte TYPE_PROXY
          Edge type specifier.
static byte TYPE_PROXY_REFERENCE
          Edge type specifier.
 
Method Summary
 Object getId()
          Returns the unique id of the related edge.
 Edge getRepresentedEdge()
          Returns the original edge.
 byte getType()
          Returns the type of the related edge.
 

Field Detail

TYPE_NORMAL

static final byte TYPE_NORMAL
Edge type specifier. This value specifies that the edge is a normal edge, i.e., it does not belong to another type.

See Also:
getType(), Constant Field Values

TYPE_CONNECTOR

static final byte TYPE_CONNECTOR
Edge type specifier. This value specifies that the edge is connected to a connector node (a node of type NodeInfo.TYPE_CONNECTOR}), i.e., it represents an edge of the input graph whose endpoints lie on different pages.

See Also:
getRepresentedEdge(), getType(), NodeInfo.TYPE_CONNECTOR, Constant Field Values

TYPE_PROXY_REFERENCE

static final byte TYPE_PROXY_REFERENCE
Edge type specifier. This value specifies that the edge is connected to a proxy reference node (a node of type NodeInfo.TYPE_PROXY_REFERENCE}), i.e., a node that refers to a proxy of an original node lying on another page.

See Also:
getType(), NodeInfo.TYPE_PROXY_REFERENCE, Constant Field Values

TYPE_PROXY

static final byte TYPE_PROXY
Edge type specifier. This value specifies that the edge is connected to a proxy node (a node of type NodeInfo.TYPE_PROXY}), i.e., a node that is a proxy of an original node lying on another page.

See Also:
getType(), NodeInfo.TYPE_PROXY, Constant Field Values
Method Detail

getId

Object getId()
Returns the unique id of the related edge.

Returns:
the id of the related edge.

getType

byte getType()
Returns the type of the related edge.

Returns:
the type of the related edge.

getRepresentedEdge

Edge getRepresentedEdge()
Returns the original edge. That is, for edges of type TYPE_CONNECTOR, the edge of the input graph that was split by the connector edge is returned.

Returns:
the original edge or null if getType() != TYPE_CONNECTOR.
See Also:
TYPE_CONNECTOR

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