Packagecom.yworks.yfiles.layout
Interfacepublic interface PortCandidateSet_CandidateMatcher

The interface that is used by com.yworks.yfiles.layout.PortCandidateSet to retrieve com.yworks.yfiles.layout.PortCandidate s from.

See also

com.yworks.yfiles.layout.PortCandidateSet.createMatcher()
com.yworks.yfiles.layout.PortCandidateSet
com.yworks.yfiles.layout.PortCandidate


Public Methods
 MethodDefined By
  
Returns the next best matching com.yworks.yfiles.layout.PortCandidateSet_Entry.
PortCandidateSet_CandidateMatcher
  
findMatchingCandidateWithDirection(edge:Edge, source:Boolean, directionMask:int):PortCandidateSet_Entry
Returns the next best matching com.yworks.yfiles.layout.PortCandidateSet_Entry for the given parameters.
PortCandidateSet_CandidateMatcher
  
findMatchingCandidateWithOffset(edge:Edge, source:Boolean, xOffset:Number, yOffset:Number, directionMask:int):PortCandidateSet_Entry
Returns the next best matching com.yworks.yfiles.layout.PortCandidateSet_Entry for the given parameters.
PortCandidateSet_CandidateMatcher
Method Detail
findMatchingCandidate()method
public function findMatchingCandidate():PortCandidateSet_Entry

Returns the next best matching com.yworks.yfiles.layout.PortCandidateSet_Entry.

Returns
PortCandidateSet_Entry — the next best entry with respect to the costs

See also

findMatchingCandidateWithDirection()method 
public function findMatchingCandidateWithDirection(edge:Edge, source:Boolean, directionMask:int):PortCandidateSet_Entry

Returns the next best matching com.yworks.yfiles.layout.PortCandidateSet_Entry for the given parameters.

Parameters

edge:Edge — the edge that will connect to the port
 
source:Boolean — whether the edge connects to the node with its source side
 
directionMask:int — a bitwise combination of the constants defined in com.yworks.yfiles.layout.PortCandidate indicating the preferred connection points

Returns
PortCandidateSet_Entry — the next best entry with respect to the constraints and the costs

See also

findMatchingCandidateWithOffset()method 
public function findMatchingCandidateWithOffset(edge:Edge, source:Boolean, xOffset:Number, yOffset:Number, directionMask:int):PortCandidateSet_Entry

Returns the next best matching com.yworks.yfiles.layout.PortCandidateSet_Entry for the given parameters.

Parameters

edge:Edge — the edge that will connect to the port
 
source:Boolean — whether the edge connects to the node with its source side
 
xOffset:Number — the preferred x offset of the connection point (relative to the node's center)
 
yOffset:Number — the preferred y offset of the connection point (relative to the node's center)
 
directionMask:int — a bitwise combination of the constants defined in com.yworks.yfiles.layout.PortCandidate indicating the preferred connection points

Returns
PortCandidateSet_Entry — the next best entry with respect to the constraints and the costs

See also