Packagecom.yworks.graph.model
Classpublic class DummyNodePortId
InheritanceDummyNodePortId Inheritance Object

This class can be used to describe a master port at a DummyNodeId in a IFoldedGraph view.

Instances of this type are passed to the various methods in FoldingManager to identify ports at dummy nodes inside IFoldedGraph views.

See also

com.yworks.graph.model.FoldingManager.getPortViewState()
com.yworks.graph.model.FoldingManager.portHasViewState()
com.yworks.graph.model.IFoldedGraph.isDummy
com.yworks.graph.model.DummyEdgeId
com.yworks.graph.model.DummyNodeId


Public Properties
 PropertyDefined By
  atDummy : Boolean
[read-only] Whether the port is at a dummy node.
DummyNodePortId
  masterPort : IPort
[read-only] The port instance in the FoldingManager's masterGraph that is represented by dummies in a IFoldedGraph view.
DummyNodePortId
Public Methods
 MethodDefined By
  
DummyNodePortId(masterPort:IPort, atDummy:Boolean = true)
Initializes a dummy port id using the IFoldedGraph.GetMaster{T} node in the FoldingManager.MasterGraph and the collapsed state.
DummyNodePortId
  
create(foldedGraph:IFoldedGraph, localPort:IPort):DummyNodePortId
[static] Initializes a dummy node id from an actual node in a IFoldedGraph.
DummyNodePortId
Property Detail
atDummyproperty
atDummy:Boolean  [read-only]

Whether the port is at a dummy node.

Typically this will yield true because only ports at collapsed nodes are dummy node ports.


Implementation
    public function get atDummy():Boolean
masterPortproperty 
masterPort:IPort  [read-only]

The port instance in the FoldingManager's masterGraph that is represented by dummies in a IFoldedGraph view.


Implementation
    public function get masterPort():IPort
Constructor Detail
DummyNodePortId()Constructor
public function DummyNodePortId(masterPort:IPort, atDummy:Boolean = true)

Initializes a dummy port id using the IFoldedGraph.GetMaster{T} node in the FoldingManager.MasterGraph and the collapsed state.

Parameters
masterPort:IPort — The port in the mastergraph this dummy node will represent
 
atDummy:Boolean (default = true) — If the dummy node is collapsed. This should be set to true, because there are currently no dummy ports at non-collapsed nodes.
Method Detail
create()method
public static function create(foldedGraph:IFoldedGraph, localPort:IPort):DummyNodePortId

Initializes a dummy node id from an actual node in a IFoldedGraph.

Parameters

foldedGraph:IFoldedGraph — The graph that contains the localPort.
 
localPort:IPort — The node for which an id should be created.

Returns
DummyNodePortId