C

FoldingEdgeStateId

A data holder that can be used to describe a folding edge that connects to nodes inside a collapsed group or to other folder nodes in a IFoldingView.

Inheritance Hierarchy

Remarks

Instances of this type are passed to the various methods in FoldingManager to identify different possible states of an edge inside IFoldingViews. A folding edge is identified through the master edge, which is an edge in the masterGraph and a source and target node. Also whether those source and target nodes are currently folder nodes needs to be taken into account.

The source and target nodes need to be the nodes in the masterGraph which represent the source and target nodes of the view edge, i.e. either the true owners of the adjacent edge's sourcePort and targetPort respectively, or ancestor group nodes in the masterGraph. In the latter case these folding edges are used to describe the state of the folding edges that are present in the views of the corresponding group nodes 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 masters of the nearest ancestors in the masterGraph that are visible in the folding view graph.

See Also

API: hasFoldingEdgeState, getFoldingEdgeState, isInFoldingState

Members

No filters for this type

Constructors

FoldingEdgeStateId

(foldingView: IFoldingView, foldingEdge: IEdge)

Initializes an id for a folding edge that is currently part of the given view.

Parameters

foldingView: IFoldingView: The view the folding edge is part of.
foldingEdge: IEdge: The instance that is part of the folding view graph.

See Also

Developer's Guide

FoldingEdgeStateId

(

masterEdge: IEdge

currentMasterSource: INode

sourceCollapsed: boolean

currentMasterTarget: INode

targetCollapsed: boolean

)

Initializes an id for a folding edge in a view that represents a master edge and connects a specific pair of nodes.

All of the arguments need to be entities of the masterGraph.

Parameters

masterEdge: IEdge: An edge in the masterGraph that is represented by the folding edge.
currentMasterSource: INode: The source node of the edge or one of its ancestors to which the folding edge connects in the view, if the actual parent is currently collapsed in an ancestor node.
sourceCollapsed: boolean: true if the currentMasterSource is the true source of the masterEdge, but is in its collapsed/dummy state.
currentMasterTarget: INode: The target node of the edge or one of its ancestors to which the folding edge connects in the view, if the actual parent is currently collapsed in an ancestor node.
targetCollapsed: boolean: true if the currentMasterTarget is the true target of the masterEdge, but is in its collapsed/dummy state.

Sample Graphs

ShownSetting: Fully Expanded: no view state

Properties

currentMasterSource

readonly

Gets the source node of the edge or an ancestor (both in the masterGraph).

This may be an ancestor of the true source node if this ancestor is collapsed. More specific, it is the source node of the masterEdge if the source node is represented in the view, and otherwise the first ancestor of the source node which is represented in the view.

readonlyfinal

currentMasterTarget

readonly

Gets the target node of the edge or an ancestor (both in the masterGraph).

This may be an ancestor of the true target node if this ancestor is collapsed. More precisely, it is the target node of the masterEdge if the target node is represented in the view, and otherwise the first ancestor of the target node which is represented in the view.

readonlyfinal

masterEdge

readonly

Gets the edge instance in the masterGraph that is represented by the folding edge in a view.

readonlyfinal

sourceIsCollapsed

: boolean

readonly

Gets whether the currentMasterSource node is in folder state.

Since an edge will be converted to a folding edge if the adjacent node itself will be collapsed to a folder node, this property determines which state the source node is in for this folding edge.

readonlyfinal

targetIsCollapsed

: boolean

readonly

Gets whether the currentMasterTarget node is in folder state.

Since an edge will be converted to a folding edge if the adjacent node itself will be collapsed to a folder node, this property determines which state the source node is in for this folding edge.

readonlyfinal