| Package | com.yworks.graph.model |
| Class | public class DummyEdgeId |
| Inheritance | DummyEdgeId  Object |
DummyNodeId in a IFoldedGraph.
Instances of this type are passed to the various methods in FoldingManager
to identify different possible states of an edge inside IFoldedGraph views.
A dummy edge is identified through the master edge, which is an edge in the FoldingManager's masterGraph
and a source and target node from the FoldingManager's masterHierarchy. Also whether
those source and target nodes are currently dummy nodes needs
to be taken into account.
The source and target nodes need to be either the true owner of
the adjacent edge's sourcePort and targetPort respectively,
or parent group nodes in the masterHierarchy.
In the latter case, these dummy edges are used to describe the state of the dummy edges that are present in the
views of the corresponding group nodes that are in collapsed state, so that
the true source and target nodes are not currently visible in the view. As such the currentMasterSource
and currentMasterTarget nodes represent the master
of the nearest ancestors in the masterHierarchy that are visible in the
IFoldedGraph.
See also
| Property | Defined By | ||
|---|---|---|---|
| currentMasterSource : INode [read-only]
The source node of the edge or an ancestor (both in the FoldingManager's masterHierarchy). | DummyEdgeId | ||
| currentMasterTarget : INode [read-only]
The target node of the edge or an ancestor (both in the FoldingManager's masterHierarchy). | DummyEdgeId | ||
| masterEdge : IEdge [read-only]
The edge instance in the FoldingManager's masterGraph that is represented by the dummy in
a view. | DummyEdgeId | ||
| sourceIsCollapsed : Boolean [read-only]
Specifies whether the currentMasterSource node is in expanded state. | DummyEdgeId | ||
| targetIsCollapsed : Boolean [read-only]
Specifies whether the currentMasterTarget node is in expanded state. | DummyEdgeId | ||
| Method | Defined By | ||
|---|---|---|---|
DummyEdgeId(masterEdge:IEdge, currentMasterSource:INode, sourceCollapsed:Boolean, currentMasterTarget:INode, targetCollapsed:Boolean)
Initializes an id for a dummy edge in a IFoldedGraph view that represent a master edge and
connects a specific pair of nodes. | DummyEdgeId | ||
[static]
Creates an id for a dummy edge that is currently part of the given view. | DummyEdgeId | ||
getDummyEdgePortId(source:Boolean):DummyEdgePortId | DummyEdgeId | ||
getDummyNodePortId(source:Boolean):DummyNodePortId | DummyEdgeId | ||
| currentMasterSource | property |
currentMasterSource:INode [read-only]
The source node of the edge or an ancestor (both in the FoldingManager's masterHierarchy).
This may be an ancestor of the true source node. The views will contain this dummy if the representative node of the source node is currently collapsed by one of its ancestors.
public function get currentMasterSource():INodeSee also
| currentMasterTarget | property |
currentMasterTarget:INode [read-only]
The target node of the edge or an ancestor (both in the FoldingManager's masterHierarchy).
This may be an ancestor of the true target node. The views will contain this dummy if the representative node of the source node is currently collapsed by one of its ancestors.
public function get currentMasterTarget():INodeSee also
| masterEdge | property |
masterEdge:IEdge [read-only]
The edge instance in the FoldingManager's masterGraph that is represented by the dummy in
a view.
public function get masterEdge():IEdge| sourceIsCollapsed | property |
sourceIsCollapsed:Boolean [read-only]
Specifies whether the currentMasterSource node is in expanded state.
Since an edge will be converted to a dummy edge if the adjacent node itself will be converted to a dummy (collapsed group) node, this property determines which state the source node is in for this dummy edge.
public function get sourceIsCollapsed():BooleanSee also
| targetIsCollapsed | property |
targetIsCollapsed:Boolean [read-only]
Specifies whether the currentMasterTarget node is in expanded state.
Since an edge will be converted to a dummy edge if the adjacent node itself will be converted to a dummy (collapsed group) node, this property determines which state the target node is in for this dummy edge.
public function get targetIsCollapsed():BooleanSee also
| DummyEdgeId | () | Constructor |
public function DummyEdgeId(masterEdge:IEdge, currentMasterSource:INode, sourceCollapsed:Boolean, currentMasterTarget:INode, targetCollapsed:Boolean)
Initializes an id for a dummy edge in a IFoldedGraph view that represent a master edge and
connects a specific pair of nodes.
All of the arguments need to be entities of the FoldingManager's masterGraph.
masterEdge:IEdge — An edge in the FoldingManager's masterGraph that is represented
by the dummy edge.
| |
currentMasterSource:INode — The source node of the edge or one of its ancestors to which the dummy edge
connects in the view, if the actual parent is currently collapsed.
| |
sourceCollapsed:Boolean — true if the currentMasterSource is the true source
of the masterEdge, but is in its collapsed state.
| |
currentMasterTarget:INode — true if the currentMasterTarget is the true target
of the masterEdge, but is in its collapsed state.
| |
targetCollapsed:Boolean — The target node of the edge or one of its ancestors to which the dummy edge
connects in the view, if the actual parent is currently collapsed.
|
See also
| create | () | method |
public static function create(foldedGraph:IFoldedGraph, dummyEdge:IEdge):DummyEdgeIdCreates an id for a dummy edge that is currently part of the given view.
Parameters
foldedGraph:IFoldedGraph — The view the dummy edge is part of.
| |
dummyEdge:IEdge — The instance that is part of the folded graph view.
|
DummyEdgeId |
| getDummyEdgePortId | () | method |
public function getDummyEdgePortId(source:Boolean):DummyEdgePortIdParameters
source:Boolean |
DummyEdgePortId |
| getDummyNodePortId | () | method |
public function getDummyNodePortId(source:Boolean):DummyNodePortIdParameters
source:Boolean |
DummyNodePortId |