com.yworks.yfiles.graph.portlocationmodels

Interface IPortLocationModel

All Superinterfaces:

ILookup

All Known Implementing Classes:

BendAnchoredPortLocationModel, FreeNodePortLocationModel, GenericPortLocationModel, SegmentRatioPortLocationModel

public interface IPortLocationModel
extends ILookup

Defines the geometry of IPort instances with respect to specific IPortLocationModelParameters.

In addition to defining the location of a port with respect to a specific IPortLocationModelParameter, a port location model is typically the factory of the model parameters that are compatible with it, too.

Typically, the port location model defines a compilation of valid locations for ports, and a specific model parameter specifies an exact geometry for a port.

By design, the same instance of a port location model can be shared by multiple port location model parameters. Similarly, the same instance of a port location model parameter can be shared by multiple ports.

This interface supports the ILookup.lookup(java.lang.Class) method that can be used to query additional aspects of the implementation.

See Also:

IPortLocationModelParameter, IPort, IGraph

Field Summary

Fields inherited from interface com.yworks.yfiles.graph.ILookup

EMPTY

Method Summary

Modifier and Type	Method and Description
IPortLocationModelParameter	createParameter(IPortOwner owner, PointD location) Factory method that creates a parameter for the given port that tries to match the provided location in absolute world coordinates.
ILookup	getContext(IPort port, IPortLocationModelParameter locationParameter) Provides a lookup context for the given combination of port and parameter.
PointD	getLocation(IPort port, IPortLocationModelParameter locationParameter) Determines the location of the port for the given parameter.

Methods inherited from interface com.yworks.yfiles.graph.ILookup

createDictionaryLookup, createDynamic, createSingle, createSingle, createWrapped, lookup, lookup, lookup, safeLookup

Method Detail

createParameter

IPortLocationModelParameter createParameter(IPortOwner owner,
                                            PointD location)

Factory method that creates a parameter for the given port that tries to match the provided location in absolute world coordinates.

Parameters:

owner - The port owner that will own the port for which the parameter shall be created.

location - The location in the world coordinate system that should be matched as best as possible.

Returns:

A new instance that can be used to describe the location of an IPort at the given owner.

getContext

ILookup getContext(IPort port,
                   IPortLocationModelParameter locationParameter)

Provides a lookup context for the given combination of port and parameter.

Parameters:

port - The port to use in the context.

locationParameter - The parameter to use for the port in the context.

Returns:

An implementation of the ILookup interface that can be used to query additional aspects of the port/parameter combination.

getLocation

PointD getLocation(IPort port,
                   IPortLocationModelParameter locationParameter)

Determines the location of the port for the given parameter.

Parameters:

port - The port to determine the location for.

locationParameter - The parameter to use. The parameter can be expected to be created by this instance having the Model property set to this instance..

Returns:

The calculated location of the port.