com.yworks.yfiles.layout

Interface PortCandidateSet.ICandidateMatcher

Enclosing class:

PortCandidateSet

public static interface PortCandidateSet.ICandidateMatcher

A PortCandidateSet.ICandidateMatcher retrieves the best matching entries from a PortCandidateSet.

How well a candidate is matching can be decided based on its cost, its currently available capacity, its offsets or whether or not its direction is consistent with the desired one.

To use custom implementations of this interface, method PortCandidateSet.createMatcher() should be overridden.

Method Summary

Modifier and Type	Method and Description
PortCandidateSet.IEntry	findMatchingCandidate() Returns the next best matching PortCandidateSet.IEntry.
PortCandidateSet.IEntry	findMatchingCandidate(Edge edge, boolean source, double xOffset, double yOffset, PortDirections directionMask) Returns the next best matching PortCandidateSet.IEntry for the given parameters.
PortCandidateSet.IEntry	findMatchingCandidate(Edge edge, boolean source, PortDirections directionMask) Returns the next best matching PortCandidateSet.IEntry for the given parameters.

Method Detail

findMatchingCandidate

PortCandidateSet.IEntry findMatchingCandidate()

Returns the next best matching PortCandidateSet.IEntry.

Returns:

a matching PortCandidateSet.IEntry instance

findMatchingCandidate

PortCandidateSet.IEntry findMatchingCandidate(Edge edge,
                                              boolean source,
                                              double xOffset,
                                              double yOffset,
                                              PortDirections directionMask)

Returns the next best matching PortCandidateSet.IEntry for the given parameters.

Parameters:

edge - the edge for which to find a candidate

source - true if the given edge connects to its source node, false otherwise

xOffset - the preferred X-offset of the port relative to the center of the node

yOffset - the preferred Y-offset of the port relative to the center of the node

directionMask - any combination of default directions defined in PortCandidate

Returns:

a matching PortCandidateSet.IEntry instance

findMatchingCandidate

PortCandidateSet.IEntry findMatchingCandidate(Edge edge,
                                              boolean source,
                                              PortDirections directionMask)

Returns the next best matching PortCandidateSet.IEntry for the given parameters.

Parameters:

edge - the edge for which to find a candidate

source - true if the given edge connects to its source node, false otherwise

directionMask - any combination of default directions defined in PortCandidate

Returns:

a matching PortCandidateSet.IEntry instance