Packagecom.yworks.graph.model
Classpublic class UnoccupiedPortCandidateProvider
InheritanceUnoccupiedPortCandidateProvider Inheritance AbstractPortCandidateProvider Inheritance Object

Simple implementation of an IPortCandidateProvider that returns unoccupied ports at a given entity.


Public Properties
 PropertyDefined By
 InheritedportOwner : IPortOwner
[read-only] Gets owner of the port candidate.
AbstractPortCandidateProvider
Public Methods
 MethodDefined By
  
UnoccupiedPortCandidateProvider(portOwner:IPortOwner)
Creates a new instance of this
UnoccupiedPortCandidateProvider
 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] Creates an enumeration of possibly port candidates.
UnoccupiedPortCandidateProvider
 Inherited
setPortOwner(value:IPortOwner):void
Sets the owner of the port candidate.
AbstractPortCandidateProvider
Constructor Detail
UnoccupiedPortCandidateProvider()Constructor
public function UnoccupiedPortCandidateProvider(portOwner:IPortOwner)

Creates a new instance of this

Parameters
portOwner:IPortOwner — The port owner to create the port candidates for.
Method Detail
getPortCandidates()method
override protected function getPortCandidates(context:IInputModeContext):Iterable

Creates an enumeration of possibly port candidates.

This method is used as a callback by most of the getter methods in this class. Subclasses habe to override this method to provide the same candidates for all use-cases.

Parameters

context:IInputModeContext

Returns
Iterable — An iterable collection of port candidates.




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