Search this API

y.layout
Interface PortCandidateSet.CandidateMatcher

Enclosing class:
PortCandidateSet

public static interface PortCandidateSet.CandidateMatcher

The interface that is used by PortCandidateSet to retrieve PortCandidates from.

See Also:
PortCandidateSet.createMatcher()

Method Summary
 PortCandidateSet.Entry findMatchingCandidate()
          Returns an the next best matching PortCandidateSet.Entry.
 PortCandidateSet.Entry findMatchingCandidate(Edge edge, boolean source, double xOffset, double yOffset, int directionMask)
          Returns the next best matching PortCandidateSet.Entry for the given parameters.
 PortCandidateSet.Entry findMatchingCandidate(Edge edge, boolean source, int directionMask)
          Returns an the next best matching PortCandidateSet.Entry for the given parameters.
 

Method Detail

findMatchingCandidate

PortCandidateSet.Entry findMatchingCandidate(Edge edge,
                                             boolean source,
                                             double xOffset,
                                             double yOffset,
                                             int directionMask)
Returns the next best matching PortCandidateSet.Entry for the given parameters.

Parameters:
edge - the edge that will connect to the port
source - whether the edge connects to the node with its source side
xOffset - the preferred x offset of the connection point (relative to the node's center)
yOffset - the preferred y offset of the connection point (relative to the node's center)
directionMask - a bitwise combination of the constants defined in PortCandidate indicating the preferred connection points
Returns:
the next best entry with respect to the constraints and the costs

findMatchingCandidate

PortCandidateSet.Entry findMatchingCandidate(Edge edge,
                                             boolean source,
                                             int directionMask)
Returns an the next best matching PortCandidateSet.Entry for the given parameters.

Parameters:
edge - the edge that will connect to the port
source - whether the edge connects to the node with its source side
directionMask - a bitwise combination of the constants defined in PortCandidate indicating the preferred connection points
Returns:
the next best entry with respect to the constraints and the costs

findMatchingCandidate

PortCandidateSet.Entry findMatchingCandidate()
Returns an the next best matching PortCandidateSet.Entry.

Returns:
the next best entry with respect to the costs

© Copyright 2000-2013,
yWorks GmbH.
All rights reserved.