Search this API

y.layout.multipage
Interface EdgeInfo


public interface EdgeInfo

A class that holds all information associated with an edge.

 

Field Summary
static byte TYPE_CONNECTOR
          An edge type that specifies a connector edge.
static byte TYPE_NORMAL
          An edge type that specifies a normal edge.
static byte TYPE_PROXY
          An edge type that specifies a proxy edge.
static byte TYPE_PROXY_REFERENCE
          An edge type that specifies a proxy reference edge.
 
Method Summary
 java.lang.Object getId()
          Returns the unique ID of the associated edge.
 Edge getRepresentedEdge()
          Returns the original edge associated with this EdgeInfo.
 byte getType()
          Returns the type of the associated edge.
 

Field Detail

TYPE_NORMAL

static final byte TYPE_NORMAL
An edge type that specifies a normal edge.

An edge is called normal if it does not belong to any other type.

See Also:
getType(), Constant Field Values

TYPE_CONNECTOR

static final byte TYPE_CONNECTOR
An edge type that specifies a connector edge.

An edge is called connector if it 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
An edge type that specifies a proxy reference edge.

An edge is called proxy reference if it 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
An edge type that specifies a proxy edge.

An edge is called proxy if it is connected to at least one proxy node and the other node isn't a connector or proxy reference node. A proxy node has type NodeInfo.TYPE_PROXY) and represents a proxy of an original node lying on another page.

 
Note that an edge between a proxy node and a connector/proxy reference node is always of type TYPE_CONNECTOR and TYPE_PROXY_REFERENCE respectively.
See Also:
getType(), NodeInfo.TYPE_PROXY, Constant Field Values
Method Detail

getId

java.lang.Object getId()
Returns the unique ID of the associated edge.

Returns:
the ID of the associated edge
See Also:
MultiPageLayout.getEdgeInfo(y.base.Edge), ElementInfoManager.getEdgeInfo(y.base.Edge)

getType

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

Returns:
the type of the associated edge

getRepresentedEdge

Edge getRepresentedEdge()
Returns the original edge associated with this EdgeInfo.

More precisely, for edges of type TYPE_CONNECTOR, this method returns the edge of the input graph that was split by the connector edge. Otherwise, it returns null.

Returns:
the original edge if the type of the edge is TYPE_CONNECTOR, null otherwise
See Also:
TYPE_CONNECTOR

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