Packagecom.yworks.graph.model
Classpublic class PortCandidateProvider
InheritancePortCandidateProvider Inheritance AbstractPortCandidateProvider Inheritance Object

A simple mutable IPortCandidateProvider implementation that allows for adding IPortCandidates.


Public Properties
 PropertyDefined By
 InheritedportOwner : IPortOwner
[read-only] Gets owner of the port candidate.
AbstractPortCandidateProvider
Public Methods
 MethodDefined By
  
addCandidate(candidate:IPortCandidate):IPortCandidate
Adds a single candidate to this instance's list of candidates.
PortCandidateProvider
  
addCandidateWithModelParameter(owner:IPortOwner, portLocationModelParameter:IPortLocationModelParameter):IPortCandidate
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
 Inherited
getCandidateSourcePortCandidates(context:IInputModeContext, target:IPortCandidate):Iterable
Convenience implementation that simply delegates to getPortCandidates.
AbstractPortCandidateProvider
 Inherited
getCandidateTargetPortCandidates(context:IInputModeContext, source:IPortCandidate):Iterable
Convenience implementation that simply delegates to getPortCandidates.
AbstractPortCandidateProvider
 Inherited
getEdgeSourcePortCandidates(context:IInputModeContext, edge:IEdge):Iterable
Convenience implementation that simply delegates to getPortCandidates.
AbstractPortCandidateProvider
 Inherited
getEdgeTargetPortCandidates(context:IInputModeContext, edge:IEdge):Iterable
Convenience implementation that simply delegates to getPortCandidates.
AbstractPortCandidateProvider
 Inherited
getGraphSourcePortCandidates(context:IInputModeContext):Iterable
Convenience implementation that simply delegates to getPortCandidates.
AbstractPortCandidateProvider
 Inherited
getGraphTargetPortCandidates(context:IInputModeContext):Iterable
Convenience implementation that simply delegates to getPortCandidates.
AbstractPortCandidateProvider
Protected Methods
 MethodDefined By
 Inherited
addExistingPorts(list:List):void
Convenience method for subclasses that adds all existing ports of the portOwner to the provided list.
AbstractPortCandidateProvider
 Inherited
createCallbackPort(location:IPortLocationModelParameter, owner:IPortOwner = null):DefaultPortCandidate
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
 Inherited
createCallbackPortAt(location:IPoint, owner:IPortOwner = null, model:IPortLocationModel = null, valid:Boolean = true):DefaultPortCandidate
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
 Inherited
createInstance(context:IInputModeContext, candidate:DefaultPortCandidate):IPort
Callback method used by the ports created using the createCallbackPort factory method.
AbstractPortCandidateProvider
 Inherited
getCandidateAt(context:IInputModeContext, candidate:DefaultPortCandidate, suggestedLocation:IPoint):IPortCandidate
Callback method used by the ports created using the factory method createCallbackPort.
AbstractPortCandidateProvider
  
getPortCandidates(context:IInputModeContext):Iterable
[override] Returns the list of candidates used by this instance.
PortCandidateProvider
 Inherited
setPortOwner(value:IPortOwner):void
Sets the owner of the port candidate.
AbstractPortCandidateProvider
Method Detail
addCandidate()method
public function addCandidate(candidate:IPortCandidate):IPortCandidate

Adds a single candidate to this instance's list of candidates.

Parameters

candidate:IPortCandidate — The candidate to add.

Returns
IPortCandidate — The candidate added.
addCandidateWithModelParameter()method 
public function addCandidateWithModelParameter(owner:IPortOwner, portLocationModelParameter:IPortLocationModelParameter):IPortCandidate

Add another port candidate to this provider's list of candidates.

Parameters

owner:IPortOwner — The owner to use for the candidate.
 
portLocationModelParameter:IPortLocationModelParameter — The location model parameter of the candidate.

Returns
IPortCandidate — The candidate created.
addExistingPortsFromOwner()method 
public function addExistingPortsFromOwner(owner:IPortOwner):void

Adds existing ports of the given instance to this instance's list.

Parameters

owner:IPortOwner — The owner whose ports should be added.

getPortCandidates()method 
override protected function getPortCandidates(context:IInputModeContext):Iterable

Returns the list of candidates used by this instance.

Parameters

context:IInputModeContext

Returns
Iterable — An Iterable over the list candidates.




Wed Oct 7 2015, 04:52 PM +02:00