| Package | com.yworks.graph.model |
| Interface | public interface IPortCandidateProvider |
| Implementors | AbstractPortCandidateProvider, CompositePortCandidateProvider, EmptyPortsCandidateProvider |
IPortCandidates
for a specific IPortOwner with respect to a given
opposite IPortCandidate or IEdge.
Implementations of this interface may be queried using the lookup
method of IPortOwner implementations like INode.
| Method | Defined by | ||
|---|---|---|---|
|
getCandidateSourcePortCandidates(context:IInputModeContext, graph:IGraph, target:IPortCandidate):Iterable
Returns all port candidates that apply for the provided opposite port candidate.
| IPortCandidateProvider | ||
|
getCandidateTargetPortCandidates(context:IInputModeContext, graph:IGraph, source:IPortCandidate):Iterable
Returns all port candidates that apply for the provided opposite port candidate.
| IPortCandidateProvider | ||
|
Returns all port candidates that apply for the provided edge.
| IPortCandidateProvider | ||
|
Returns all port candidates that apply for the provided edge.
| IPortCandidateProvider | ||
|
Returns all source port candidates that belong to the context of this provider.
| IPortCandidateProvider | ||
|
Returns all target port candidates that belong to the context of this provider.
| IPortCandidateProvider | ||
| getCandidateSourcePortCandidates | () | method |
public function getCandidateSourcePortCandidates(context:IInputModeContext, graph:IGraph, target:IPortCandidate):IterableReturns all port candidates that apply for the provided opposite port candidate.
The Iterable may both contain valid and invalid port candidates.
Parameterscontext:IInputModeContext — The context for which the candidates should be provided.
|
|
graph:IGraph — The graph for which the candidates should be queried.
|
|
target:IPortCandidate — The opposite port candidate.
|
Iterable —
An Iterable over all port candidates that are associated with the given opposite port.
|
| getCandidateTargetPortCandidates | () | method |
public function getCandidateTargetPortCandidates(context:IInputModeContext, graph:IGraph, source:IPortCandidate):IterableReturns all port candidates that apply for the provided opposite port candidate.
The Iterable may both contain valid and invalid port candidates.
Parameterscontext:IInputModeContext — The context for which the candidates should be provided.
|
|
graph:IGraph — The graph for which the candidates should be queried.
|
|
source:IPortCandidate — The opposite port candidate.
|
Iterable —
An Iterable over all port candidates that are associated with the given opposite port.
|
| getEdgeSourcePortCandidates | () | method |
public function getEdgeSourcePortCandidates(context:IInputModeContext, graph:IGraph, edge:IEdge):IterableReturns all port candidates that apply for the provided edge.
The Iterable may both contain valid and invalid port candidates.
Parameterscontext:IInputModeContext — The context for which the candidates should be provided.
|
|
graph:IGraph — The graph for which the candidates should be queried.
|
|
edge:IEdge — The edge for which source port candidates are sought.
|
Iterable —
An Iterable over all port candidates that are associated with the given edge.
|
| getEdgeTargetPortCandidates | () | method |
public function getEdgeTargetPortCandidates(context:IInputModeContext, graph:IGraph, edge:IEdge):IterableReturns all port candidates that apply for the provided edge.
The Iterable may both contain valid and invalid port candidates.
Parameterscontext:IInputModeContext — The context for which the candidates should be provided.
|
|
graph:IGraph — The graph for which the candidates should be queried.
|
|
edge:IEdge — The edge for which target port candidates are sought.
|
Iterable —
An Iterable over all port candidates that are associated with the given edge.
|
| getGraphSourcePortCandidates | () | method |
public function getGraphSourcePortCandidates(context:IInputModeContext, graph:IGraph):IterableReturns all source port candidates that belong to the context of this provider.
The Iterable may both contain valid and invalid port candidates.
Parameterscontext:IInputModeContext — The context for which the candidates should be provided.
|
|
graph:IGraph — The graph for which the candidates should be queried.
|
Iterable —
An iterable over all source port candidates that are associated with the current context.
|
| getGraphTargetPortCandidates | () | method |
public function getGraphTargetPortCandidates(context:IInputModeContext, graph:IGraph):IterableReturns all target port candidates that belong to the context of this provider.
The Iterable may both contain valid and invalid port candidates.
Parameterscontext:IInputModeContext — The context for which the candidates should be provided.
|
|
graph:IGraph — The graph for which the candidates should be queried.
|
Iterable —
An iterable over all source port candidates that are associated with the current context.
|