| Package | com.yworks.graph.model |
| Class | public class PortCandidateProvider |
| Inheritance | PortCandidateProvider  AbstractPortCandidateProvider |
IPortCandidateProvider implementation
that allows for adding IPortCandidates.
| Method | Defined by | ||
|---|---|---|---|
|
Adds a single candidate to this instance's list of candidates.
| PortCandidateProvider | ||
|
Add another port candidate to this provider's list of candidates.
| PortCandidateProvider | ||
|
addExistingPortsFromOwner(owner:IPortOwner):void
Adds existing ports of the given instance to this instance's list.
| PortCandidateProvider | ||
 |
getCandidateSourcePortCandidates(context:IInputModeContext, graph:IGraph, target:IPortCandidate):Iterable
Convenience implementation that simply delegates to
getPortCandidates. | AbstractPortCandidateProvider | |
|
getCandidateTargetPortCandidates(context:IInputModeContext, graph:IGraph, source:IPortCandidate):Iterable
Convenience implementation that simply delegates to
getPortCandidates. | AbstractPortCandidateProvider | |
|
Convenience implementation that simply delegates to
getPortCandidates. | AbstractPortCandidateProvider | |
|
Convenience implementation that simply delegates to
getPortCandidates. | AbstractPortCandidateProvider | |
|
Convenience implementation that simply delegates to
getPortCandidates. | AbstractPortCandidateProvider | |
|
Convenience implementation that simply delegates to
getPortCandidates. | AbstractPortCandidateProvider | |
| Method | Defined by | ||
|---|---|---|---|
|
addExistingPorts(list:List):void
Convenience method for subclasses that adds all existing ports
of the
portOwner to the provided list. | AbstractPortCandidateProvider | |
|
Factory method that creates a simple candidate that will use the
createInstance
method of this instance to delegate createInstance of the port candidate to. | AbstractPortCandidateProvider | |
|
Callback method used by the ports created using the
createCallbackPort factory method. | AbstractPortCandidateProvider | |
|
Returns the list of candidates used by this instance.
| PortCandidateProvider | ||
|
setPortOwner(value:IPortOwner):void
Sets the owner of the port candidate.
| AbstractPortCandidateProvider | |
| addCandidate | () | method |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic function addCandidate(candidate:IPortCandidate):IPortCandidateAdds a single candidate to this instance's list of candidates.
Parameterscandidate:IPortCandidate — The candidate to add.
|
IPortCandidate —
The candidate added.
|
| addCandidateAt | () | method |
public function addCandidateAt(graph:IGraph, owner:IPortOwner, location:IPoint):IPortCandidateAdd another port candidate to this provider's list of candidates.
Parametersgraph:IGraph — The graph where the candidate belongs to
|
|
owner:IPortOwner — The owner to use for the candidate.
|
|
location:IPoint — The location of the candidate.
|
IPortCandidate —
The candidate created.
|
| addExistingPortsFromOwner | () | method |
public function addExistingPortsFromOwner(owner:IPortOwner):voidAdds existing ports of the given instance to this instance's list.
Parametersowner:IPortOwner — The owner whose ports should be added.
|
| getPortCandidates | () | method |
protected override function getPortCandidates(context:IInputModeContext, graph:IGraph):IterableReturns the list of candidates used by this instance.
Parameterscontext:IInputModeContext — The graph to work on.
|
|
graph:IGraph |
Iterable —
An Iterable over the list candidates.
|