com.yworks.yfiles.graph.portlocationmodels

Class GenericPortLocationModel

java.lang.Object

com.yworks.yfiles.graph.portlocationmodels.GenericPortLocationModel

All Implemented Interfaces:

ILookup, IPortLocationModel, IMarkupExtensionConverter, IEnumerable<IPortLocationModelParameter>, Iterable<IPortLocationModelParameter>

public final class GenericPortLocationModel
extends Object
implements IPortLocationModel, IMarkupExtensionConverter, IEnumerable<IPortLocationModelParameter>

An implementation of IPortLocationModel that can be used to create custom port location models out of existing IPortLocationModelParameter instances.

This class holds a number of parameters and serves as a container for these parameters.

Custom models can easily be created in the following way:

Note that in order to work, this model needs to have at least one parameter added.

See Also:

addParameter(IPortLocationModelParameter)

Field Summary

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

EMPTY

Fields inherited from interface com.yworks.yfiles.utils.IEnumerable

EMPTY

Constructor Summary

Constructors

Constructor and Description
GenericPortLocationModel() Initializes a new instance of the GenericPortLocationModel class.

Method Summary

Modifier and Type	Method and Description
void	add(IPortLocationModelParameter locationParameter) This method simply delegates to addParameter(IPortLocationModelParameter).
IPortLocationModelParameter	addParameter(IPortLocationModelParameter locationParameter) Adds the given parameter to the LocationParameters of this instance.
boolean	canConvert(IWriteContext context, Object value) Returns if the converter can convert the value to a MarkupExtension in the current write context.
MarkupExtension	convert(IWriteContext context, Object value) Converts the value to a MarkupExtension using the current write context.
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.
IEnumerator<IPortLocationModelParameter>	enumerator() Returns an IEnumerator over a set of elements of type T.
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.
Iterable<IPortLocationModelParameter>	getLocationParameters() Gets all parameters that are associated with this instance.
<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

Methods inherited from interface com.yworks.yfiles.utils.IEnumerable

concat, concat, create, create, iterator, parallelStream, stream

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

GenericPortLocationModel

public GenericPortLocationModel()

Initializes a new instance of the GenericPortLocationModel class.

Method Detail

add

public final void add(IPortLocationModelParameter locationParameter)

This method simply delegates to addParameter(IPortLocationModelParameter).

It is there to allow for convenient initialization in code.

This method is used by the compiler if the collection initializer syntax is used.

Parameters:

locationParameter - The parameter to add to this instance.

See Also:

addParameter(IPortLocationModelParameter)

addParameter

public final IPortLocationModelParameter addParameter(IPortLocationModelParameter locationParameter)

Adds the given parameter to the LocationParameters of this instance.

Note that this will create a new parameter instance that is then actually bound to this instance and returned. The instance is stored by reference so if this is a mutable instance this instance will be modified, implicitly, too.

Parameters:

locationParameter - The parameter to add to this instance.

Returns:

The parameter to use with this model that wraps the given parameter.

See Also:

add(IPortLocationModelParameter)

canConvert

public final boolean canConvert(IWriteContext context,
                                Object value)

Description copied from interface: IMarkupExtensionConverter

Returns if the converter can convert the value to a MarkupExtension in the current write context.

Specified by:

canConvert in interface IMarkupExtensionConverter

Parameters:

context - The current write context.

value - The object to convert.

Returns:

Whether the converter can convert the passed value.

convert

public final MarkupExtension convert(IWriteContext context,
                                     Object value)

Description copied from interface: IMarkupExtensionConverter

Converts the value to a MarkupExtension using the current write context.

Specified by:

convert in interface IMarkupExtensionConverter

Parameters:

context - The current write context.

value - The object to convert.

Returns:

The MarkupExtension the value was converted to.

createParameter

public final 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.

This implementation iterates over all LocationParameters to return the one that matches the given location the best.

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.

enumerator

public final IEnumerator<IPortLocationModelParameter> enumerator()

Description copied from interface: IEnumerable

Returns an IEnumerator over a set of elements of type T.

Specified by:

enumerator in interface IEnumerable<IPortLocationModelParameter>

Returns:

an IEnumerator.

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.

getLocationParameters

public final Iterable<IPortLocationModelParameter> getLocationParameters()

Gets all parameters that are associated with this instance.

This enumerates the instances that wraps the parameters that have been added to this instance via addParameter(IPortLocationModelParameter)

Returns:

The parameters that are managed by this instance.

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