Packagecom.yworks.graph.model
Classpublic class EmptyPortsCandidateProvider
ImplementsIPortCandidateProvider

A generic implementation of the IPortCandidateProvider interface that provides no candidates.


Public Properties
 PropertyDefined by
  instance : EmptyPortsCandidateProvider
[static][read-only] A static instance of this class.
EmptyPortsCandidateProvider
Public Methods
 MethodDefined by
  
getCandidateSourcePortCandidates(context:IInputModeContext, graph:IGraph, target:IPortCandidate):Iterable
Returns all port candidates that apply for the provided opposite port candidate.
EmptyPortsCandidateProvider
  
getCandidateTargetPortCandidates(context:IInputModeContext, graph:IGraph, source:IPortCandidate):Iterable
Returns all port candidates that apply for the provided opposite port candidate.
EmptyPortsCandidateProvider
  
getEdgeSourcePortCandidates(context:IInputModeContext, graph:IGraph, edge:IEdge):Iterable
Returns all port candidates that apply for the provided edge.
EmptyPortsCandidateProvider
  
getEdgeTargetPortCandidates(context:IInputModeContext, graph:IGraph, edge:IEdge):Iterable
Returns all port candidates that apply for the provided edge.
EmptyPortsCandidateProvider
  
getGraphSourcePortCandidates(context:IInputModeContext, graph:IGraph):Iterable
Returns all source port candidates that belong to the context of this provider.
EmptyPortsCandidateProvider
  
getGraphTargetPortCandidates(context:IInputModeContext, graph:IGraph):Iterable
Returns all target port candidates that belong to the context of this provider.
EmptyPortsCandidateProvider
Property detail
instanceproperty
instance:EmptyPortsCandidateProvider  [read-only]

A static instance of this class.

Implementation
    public static function get instance():EmptyPortsCandidateProvider
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.