com.yworks.yfiles.graph.portlocationmodels

Class BendAnchoredPortLocationModel

java.lang.Object

com.yworks.yfiles.graph.portlocationmodels.BendAnchoredPortLocationModel

All Implemented Interfaces:

ILookup, IPortLocationModel

public final class BendAnchoredPortLocationModel
extends Object
implements IPortLocationModel

An implementation of the IPortLocationModel that can create IPortLocationModelParameters that describe the location of ports that are attached to the bends of IEdges.

Field Summary

Fields

Modifier and Type	Field and Description
static IPortLocationModelParameter	FIRST_BEND A convenience instance of a parameter that is bound to the first IBend of the edge.
static BendAnchoredPortLocationModel	INSTANCE A static immutable global instance of this class.
static IPortLocationModelParameter	LAST_BEND A convenience instance of a parameter that is bound to the last IBend of the edge.

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
BendAnchoredPortLocationModel()

Method Summary

Modifier and Type	Method and Description
IPortLocationModelParameter	createFromSource(int bendIndex) Creates a parameter that indicates the location of the bend with index bendIndex starting from the source side.
IPortLocationModelParameter	createFromTarget(int bendIndex) Creates a parameter that indicates the location of the bend with index bendIndex starting from the target side.
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) This implementation has nothing in its lookup and will always yield .

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

FIRST_BEND

public static final IPortLocationModelParameter FIRST_BEND

A convenience instance of a parameter that is bound to the first IBend of the edge.

See Also:

createFromSource(int)

INSTANCE

public static final BendAnchoredPortLocationModel INSTANCE

A static immutable global instance of this class.

LAST_BEND

public static final IPortLocationModelParameter LAST_BEND

A convenience instance of a parameter that is bound to the last IBend of the edge.

See Also:

createFromTarget(int)

Constructor Detail

BendAnchoredPortLocationModel

public BendAnchoredPortLocationModel()

Method Detail

createFromSource

public final IPortLocationModelParameter createFromSource(int bendIndex)

Creates a parameter that indicates the location of the bend with index bendIndex starting from the source side.

Parameters:

bendIndex - The index of the bend counting from the source side.

Returns:

A parameter that anchors the port at a bend.

createFromTarget

public final IPortLocationModelParameter createFromTarget(int bendIndex)

Creates a parameter that indicates the location of the bend with index bendIndex starting from the target side.

Parameters:

bendIndex - The index of the bend counting from the target side.

Returns:

A parameter that anchors the port at a bend.

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)

This implementation has nothing in its lookup and will always yield .null

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