com.yworks.yfiles.view.input

Interface IPortSelectionTester

public interface IPortSelectionTester

Interface that can be used to find ports at specific locations in the canvas.

This interface is mostly provided through the ILookup.lookup(java.lang.Class) of IPortOwner implementations such as INode.

Method Summary

Modifier and Type	Method and Description
IPort	getHitPort(IInputModeContext context, PointD location) Returns the port at the given world coordinate position or null if there is no such port.
IEnumerable<IPort>	getPortsInBox(IInputModeContext context, RectD rectangle) Returns the ports for the given marquee rectangle.

Method Detail

getHitPort

IPort getHitPort(IInputModeContext context,
                 PointD location)

Returns the port at the given world coordinate position or null if there is no such port.

Parameters:

context - The input mode context to use for querying the position.

location - The coordinates of the position in the world coordinate system.

Returns:

The port at the position or null.

getPortsInBox

IEnumerable<IPort> getPortsInBox(IInputModeContext context,
                                 RectD rectangle)

Returns the ports for the given marquee rectangle.

Parameters:

context - The input mode context to use for querying the position.

rectangle - The marquee selection box in the world coordinate system.

Returns:

An enumerable over the ports inside the marquee selection box.