com.yworks.yfiles.graph.portlocationmodels

Class SegmentRatioPortLocationModel

java.lang.Object

com.yworks.yfiles.graph.portlocationmodels.SegmentRatioPortLocationModel

All Implemented Interfaces:

ILookup, IPortLocationModel

public final class SegmentRatioPortLocationModel
extends Object
implements IPortLocationModel

A port location model that places the port on a certain edge segment at a specified ratio.

Field Summary

Fields

Modifier and Type	Field and Description
static SegmentRatioPortLocationModel	INSTANCE A static immutable global instance of this class.

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
SegmentRatioPortLocationModel()

Method Summary

Modifier and Type	Method and Description
IPortLocationModelParameter	createFromSource(double ratio, int segmentIndex) Creates the a new parameter for the specified segment index and ratio.
IPortLocationModelParameter	createFromTarget(double ratio, int segmentIndex) Creates the a new parameter for the specified segment index counted from the target end of the edge and the provided ratio.
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.
<TLookup> TLookup	lookup(Class<TLookup> type) Returns an instance that implements the given type or null.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

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

Field Detail

INSTANCE

public static final SegmentRatioPortLocationModel INSTANCE

A static immutable global instance of this class.

Constructor Detail

SegmentRatioPortLocationModel

public SegmentRatioPortLocationModel()

Method Detail

createFromSource

public final IPortLocationModelParameter createFromSource(double ratio,
                                                          int segmentIndex)

Creates the a new parameter for the specified segment index and ratio.

Parameters:

ratio - The ratio for the segment, with 0 being at the start of the segment and 1 at the end.

segmentIndex - The index of the segment.

Returns:

A parameter for the given ratio and segment.

createFromTarget

public final IPortLocationModelParameter createFromTarget(double ratio,
                                                          int segmentIndex)

Creates the a new parameter for the specified segment index counted from the target end of the edge and the provided ratio.

Parameters:

ratio - The ratio for the segment, with 0 being at the start of the segment and 1 at the end.

segmentIndex - The index of the segment counted from the target end.

Returns:

A parameter for the given ratio and segment.

createParameter

public final IPortLocationModelParameter createParameter(IPortOwner owner,
                                                         PointD location)

Description copied from interface: IPortLocationModel

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

Specified by:

createParameter in interface IPortLocationModel

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

public final ILookup getContext(IPort port,
                                IPortLocationModelParameter locationParameter)

Description copied from interface: IPortLocationModel

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

Specified by:

getContext in interface IPortLocationModel

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

public final PointD getLocation(IPort port,
                                IPortLocationModelParameter locationParameter)

Description copied from interface: IPortLocationModel

Determines the location of the port for the given parameter.

Specified by:

getLocation in interface IPortLocationModel

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.

lookup

public final <TLookup> TLookup lookup(Class<TLookup> type)

Description copied from interface: ILookup

Returns an instance that implements the given type or null. Typically, this method will be called in order to obtain a different view or aspect of the current instance. This is quite similar to casting or using a super type or interface of this instance, but is not limited to inheritance or compile time constraints. An instance implementing this method is not required to return non-null implementations for the types, nor does it have to return the same instance any time. Also it depends on the type and context whether the instance returned stays up to date or needs to be reobtained for subsequent use.

Specified by:

lookup in interface ILookup

Parameters:

type - the type for which an instance shall be returned

Returns:

an instance that is assignable to type or null