Packagecom.yworks.graph.model
Classpublic class CompositePortCandidateProvider
ImplementsIPortCandidateProvider

A generic composite implementation for the IPortCandidateProvider interface.


Public Methods
 MethodDefined by
  
CompositePortCandidateProvider(providers:Iterable)
CompositePortCandidateProvider
  
getCandidateSourcePortCandidates(context:IInputModeContext, graph:IGraph, target:IPortCandidate):Iterable
Returns all port candidates that apply for the provided opposite port candidate.
CompositePortCandidateProvider
  
getCandidateTargetPortCandidates(context:IInputModeContext, graph:IGraph, source:IPortCandidate):Iterable
Returns all port candidates that apply for the provided opposite port candidate.
CompositePortCandidateProvider
  
getEdgeSourcePortCandidates(context:IInputModeContext, graph:IGraph, edge:IEdge):Iterable
Returns all port candidates that apply for the provided edge.
CompositePortCandidateProvider
  
getEdgeTargetPortCandidates(context:IInputModeContext, graph:IGraph, edge:IEdge):Iterable
Returns all port candidates that apply for the provided edge.
CompositePortCandidateProvider
  
getGraphSourcePortCandidates(context:IInputModeContext, graph:IGraph):Iterable
Returns all source port candidates that belong to the context of this provider.
CompositePortCandidateProvider
  
getGraphTargetPortCandidates(context:IInputModeContext, graph:IGraph):Iterable
Returns all target port candidates that belong to the context of this provider.
CompositePortCandidateProvider
Constructor detail
CompositePortCandidateProvider()constructor
public function CompositePortCandidateProvider(providers:Iterable)Parameters
providers:Iterable
Method detail
getCandidateSourcePortCandidates()method
public function getCandidateSourcePortCandidates(context:IInputModeContext, graph:IGraph, target:IPortCandidate):Iterable

Returns all port candidates that apply for the provided opposite port candidate.

The Iterable may both contain valid and invalid port candidates.

Parameters
context: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.

Returns
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):Iterable

Returns all port candidates that apply for the provided opposite port candidate.

The Iterable may both contain valid and invalid port candidates.

Parameters
context: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.

Returns
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):Iterable

Returns all port candidates that apply for the provided edge.

The Iterable may both contain valid and invalid port candidates.

Parameters
context: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.

Returns
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):Iterable

Returns all port candidates that apply for the provided edge.

The Iterable may both contain valid and invalid port candidates.

Parameters
context: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.

Returns
Iterable — An Iterable over all port candidates that are associated with the given edge.
getGraphSourcePortCandidates()method 
public function getGraphSourcePortCandidates(context:IInputModeContext, graph:IGraph):Iterable

Returns all source port candidates that belong to the context of this provider.

The Iterable may both contain valid and invalid port candidates.

Parameters
context:IInputModeContext — The context for which the candidates should be provided.
 
graph:IGraph — The graph for which the candidates should be queried.

Returns
Iterable — An iterable over all source port candidates that are associated with the current context.
getGraphTargetPortCandidates()method 
public function getGraphTargetPortCandidates(context:IInputModeContext, graph:IGraph):Iterable

Returns all target port candidates that belong to the context of this provider.

The Iterable may both contain valid and invalid port candidates.

Parameters
context:IInputModeContext — The context for which the candidates should be provided.
 
graph:IGraph — The graph for which the candidates should be queried.

Returns
Iterable — An iterable over all source port candidates that are associated with the current context.