Packagecom.yworks.yfiles.layout.multipage
Interfacepublic interface ElementFactory
Implementors DefaultElementFactory

Factory used by class com.yworks.yfiles.layout.multipage.MultiPageLayouter to create special nodes and edges.

See also

com.yworks.yfiles.layout.multipage.MultiPageLayouter


Public Methods
 MethodDefined By
  
createConnectorEdge(context:LayoutContext, connector:Node, opposite:Node, origEdgeId:Object, atTarget:Boolean):Edge
Callback method for creating an edge of type com.yworks.yfiles.layout.multipage.EdgeInfoCompanion.TYPE_CONNECTOR.
ElementFactory
  
createConnectorNode(context:LayoutContext, edgesIds:YList, representedNodeId:Object):Node
Callback method for creating a node of type com.yworks.yfiles.layout.multipage.NodeInfoCompanion.TYPE_CONNECTOR.
ElementFactory
  
createProxyEdge(context:LayoutContext, proxyNode:Node, opposite:Node, replacingEdgeId:Object, origNodeId:Object):Edge
Callback method for creating an edge of type com.yworks.yfiles.layout.multipage.EdgeInfoCompanion.TYPE_PROXY.
ElementFactory
  
createProxyNode(context:LayoutContext, origNodeId:Object):Node
Callback method for creating a node of type com.yworks.yfiles.layout.multipage.NodeInfoCompanion.TYPE_PROXY.
ElementFactory
  
createProxyReferenceEdge(context:LayoutContext, proxyReference:Node, opposite:Node, referencingCopyId:Object):Edge
Callback method for creating an edge of type com.yworks.yfiles.layout.multipage.EdgeInfoCompanion.TYPE_PROXY_REFERENCE.
ElementFactory
  
createProxyReferenceNode(context:LayoutContext, referringProxyId:Object):Node
Callback method for creating a node of type com.yworks.yfiles.layout.multipage.NodeInfoCompanion.TYPE_PROXY_REFERENCE.
ElementFactory
Method Detail
createConnectorEdge()method
public function createConnectorEdge(context:LayoutContext, connector:Node, opposite:Node, origEdgeId:Object, atTarget:Boolean):Edge

Callback method for creating an edge of type com.yworks.yfiles.layout.multipage.EdgeInfoCompanion.TYPE_CONNECTOR. The edge should connect the given connector and opposite node. Note: all implementations have to use method com.yworks.yfiles.layout.multipage.LayoutContext.createEdge() to create the edge.

Parameters

context:LayoutContext — an object providing relevant layout information, e.g., the current graph as well as various information about the graph elements.
 
connector:Node — the endpoint of the edge that represents the connector node.
 
opposite:Node — the other endpoint of the edge.
 
origEdgeId:Object — the id of the edge that is split by the connector edge.
 
atTarget:Boolean — whether or not the connector node is the target of the edge.

Returns
Edge — the created connector edge.

See also

createConnectorNode()method 
public function createConnectorNode(context:LayoutContext, edgesIds:YList, representedNodeId:Object):Node

Callback method for creating a node of type com.yworks.yfiles.layout.multipage.NodeInfoCompanion.TYPE_CONNECTOR. Note: all implementations have to use method com.yworks.yfiles.layout.multipage.LayoutContext.createNode() to create the node.

Parameters

context:LayoutContext — an object providing relevant layout information, e.g., the current graph as well as various information about the graph elements.
 
edgesIds:YList — a list that contains the ids of edges that are split by this connector. Note: multi-edges (edges connecting the same nodes) may be split by the same connector pair.
 
representedNodeId:Object — the id of the node that is represented by this connector.

Returns
Node — the created connector node

See also

createProxyEdge()method 
public function createProxyEdge(context:LayoutContext, proxyNode:Node, opposite:Node, replacingEdgeId:Object, origNodeId:Object):Edge

Callback method for creating an edge of type com.yworks.yfiles.layout.multipage.EdgeInfoCompanion.TYPE_PROXY. The edge should connect the given proxy node and opposite node. Note: all implementations have to use method com.yworks.yfiles.layout.multipage.LayoutContext.createEdge() to create the edge.

Parameters

context:LayoutContext — an object providing relevant layout information, e.g., the current graph as well as various information about the graph elements.
 
proxyNode:Node — the endpoint of the edge that represents the proxy node.
 
opposite:Node — the other endpoint of the new edge.
 
replacingEdgeId:Object — the id of the related edge that is connected to the original node.
 
origNodeId:Object — the id of the original node to which the proxy node refers to.

Returns
Edge — the created proxy edge.

See also

createProxyNode()method 
public function createProxyNode(context:LayoutContext, origNodeId:Object):Node

Callback method for creating a node of type com.yworks.yfiles.layout.multipage.NodeInfoCompanion.TYPE_PROXY. Note: all implementations have to use method com.yworks.yfiles.layout.multipage.LayoutContext.createNode() to create the node.

Parameters

context:LayoutContext — an object providing relevant layout information, e.g., the current graph as well as various information about the graph elements.
 
origNodeId:Object — the id of the node for which a proxy has to be created.

Returns
Node — the proxy.

See also

createProxyReferenceEdge()method 
public function createProxyReferenceEdge(context:LayoutContext, proxyReference:Node, opposite:Node, referencingCopyId:Object):Edge

Callback method for creating an edge of type com.yworks.yfiles.layout.multipage.EdgeInfoCompanion.TYPE_PROXY_REFERENCE. This (undirected) edge should connect the given proxy reference and opposite node. Note: all implementations have to use method com.yworks.yfiles.layout.multipage.LayoutContext.createEdge() to create the edge.

Parameters

context:LayoutContext — an object providing relevant layout information, e.g., the current graph as well as various information about the graph elements.
 
proxyReference:Node — the endpoint of the edge that represents the proxy reference node.
 
opposite:Node — the other endpoint of the new edge.
 
referencingCopyId:Object — the id of the proxy node that is referenced by the proxy reference node.

Returns
Edge — the created proxy reference edge.

See also

createProxyReferenceNode()method 
public function createProxyReferenceNode(context:LayoutContext, referringProxyId:Object):Node

Callback method for creating a node of type com.yworks.yfiles.layout.multipage.NodeInfoCompanion.TYPE_PROXY_REFERENCE. Note: all implementations have to use method com.yworks.yfiles.layout.multipage.LayoutContext.createNode() to create the node.

Parameters

context:LayoutContext — an object providing relevant layout information, e.g., the current graph as well as various information about the graph elements.
 
referringProxyId:Object — the id of the proxy to which the created node refers to.

Returns
Node — the new proxy reference node.

See also