FreeNodePortLocationModel (yFiles-for-JavaFX-Complete-3.0 API)

java.lang.Object
- com.yworks.yfiles.graph.portlocationmodels.FreeNodePortLocationModel

All Implemented Interfaces:

ILookup, IPortLocationModel
```
public final class FreeNodePortLocationModel
extends Object
implements IPortLocationModel
```
A straightforward implementation of an IPortLocationModel for IPorts at INodes that determine the location dynamically using the Layout.
Internally the location is stored as the ratios by which the Width and Height of the Layout need to be scaled and additional offsets to obtain the offset to the top-left corner of the node layout.

Field Summary

Fields
Modifier and Type	Field and Description
`static FreeNodePortLocationModel`	`INSTANCE` A read only immutable instance of the `FreeNodePortLocationModel`.
`static IPortLocationModelParameter`	`NODE_BOTTOM_ANCHORED` A read only immutable singleton instance of a parameter that locates the port at the center of the bottom border of the node layout.
`static IPortLocationModelParameter`	`NODE_BOTTOM_LEFT_ANCHORED` A read only immutable singleton instance of a parameter that locates the port at the bottom left corner of the node layout.
`static IPortLocationModelParameter`	`NODE_BOTTOM_RIGHT_ANCHORED` A read only immutable singleton instance of a parameter that locates the port at the bottom right corner of the node layout.
`static IPortLocationModelParameter`	`NODE_CENTER_ANCHORED` A read only immutable singleton instance of a parameter that locates the port at the center of the node layout.
`static IPortLocationModelParameter`	`NODE_LEFT_ANCHORED` A read only immutable singleton instance of a parameter that locates the port at the center of the left border of the node layout.
`static IPortLocationModelParameter`	`NODE_RIGHT_ANCHORED` A read only immutable singleton instance of a parameter that locates the port at the center of the right border of the node layout.
`static IPortLocationModelParameter`	`NODE_TOP_ANCHORED` A read only immutable singleton instance of a parameter that locates the port at the center of the top border of the node layout.
`static IPortLocationModelParameter`	`NODE_TOP_LEFT_ANCHORED` A read only immutable singleton instance of a parameter that locates the port at the top left corner of the node layout.
`static IPortLocationModelParameter`	`NODE_TOP_RIGHT_ANCHORED` A read only immutable singleton instance of a parameter that locates the port at the top right corner of the node layout.

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

Constructor Summary

Constructors
Constructor and Description

FreeNodePortLocationModel()

Constructors
Constructor and Description
`FreeNodePortLocationModel()`

Method Summary

All Methods Instance Methods Concrete Methods
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.
`IPortLocationModelParameter`	`createParameter(PointD ratios)` Creates a parameter that uses the given ratios and offsets.
`IPortLocationModelParameter`	`createParameter(PointD ratios, PointD offset)` Creates a parameter that uses the given ratios and offsets.
`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 FreeNodePortLocationModel INSTANCE
```
    A read only immutable instance of the FreeNodePortLocationModel.
  - NODE_BOTTOM_ANCHORED
```
public static final IPortLocationModelParameter NODE_BOTTOM_ANCHORED
```
    A read only immutable singleton instance of a parameter that locates the port at the center of the bottom border of the node layout.
    This is the same as creating a parameter using (0.5,1) as ratios and (0,0) as offsets.
  - NODE_BOTTOM_LEFT_ANCHORED
```
public static final IPortLocationModelParameter NODE_BOTTOM_LEFT_ANCHORED
```
    A read only immutable singleton instance of a parameter that locates the port at the bottom left corner of the node layout.
    This is the same as creating a parameter using (0,1) as ratios and (0,0) as offsets.
  - NODE_BOTTOM_RIGHT_ANCHORED
```
public static final IPortLocationModelParameter NODE_BOTTOM_RIGHT_ANCHORED
```
    A read only immutable singleton instance of a parameter that locates the port at the bottom right corner of the node layout.
    This is the same as creating a parameter using (1,1) as ratios and (0,0) as offsets.
  - NODE_CENTER_ANCHORED
```
public static final IPortLocationModelParameter NODE_CENTER_ANCHORED
```
    A read only immutable singleton instance of a parameter that locates the port at the center of the node layout.
    This is the same as creating a parameter using (0.5,0.5) as ratios and (0,0) as offsets.
  - NODE_LEFT_ANCHORED
```
public static final IPortLocationModelParameter NODE_LEFT_ANCHORED
```
    A read only immutable singleton instance of a parameter that locates the port at the center of the left border of the node layout.
    This is the same as creating a parameter using (0,0.5) as ratios and (0,0) as offsets.
  - NODE_RIGHT_ANCHORED
```
public static final IPortLocationModelParameter NODE_RIGHT_ANCHORED
```
    A read only immutable singleton instance of a parameter that locates the port at the center of the right border of the node layout.
    This is the same as creating a parameter using (1,0.5) as ratios and (0,0) as offsets.
  - NODE_TOP_ANCHORED
```
public static final IPortLocationModelParameter NODE_TOP_ANCHORED
```
    A read only immutable singleton instance of a parameter that locates the port at the center of the top border of the node layout.
    This is the same as creating a parameter using (0.5,0) as ratios and (0,0) as offsets.
  - NODE_TOP_LEFT_ANCHORED
```
public static final IPortLocationModelParameter NODE_TOP_LEFT_ANCHORED
```
    A read only immutable singleton instance of a parameter that locates the port at the top left corner of the node layout.
    This is the same as creating a parameter using (0,0) as ratios and (0,0) as offsets.
  - NODE_TOP_RIGHT_ANCHORED
```
public static final IPortLocationModelParameter NODE_TOP_RIGHT_ANCHORED
```
    A read only immutable singleton instance of a parameter that locates the port at the top right corner of the node layout.
    This is the same as creating a parameter using (1,0) as ratios and (0,0) as offsets.
- Constructor Detail
  - FreeNodePortLocationModel
```
public FreeNodePortLocationModel()
```
- Method Detail
  - 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.
  - createParameter
```
public final IPortLocationModelParameter createParameter(PointD ratios)
```
    Creates a parameter that uses the given ratios and offsets.
    The ratios will be scaled by the node layout's size and added to the node's top left corner and the offset to determine the port location.
    
    Parameters:
    
    ratios - The ratios of the node layout's size.
    
    Returns:
    
    A new parameter that matches the specification.
  - createParameter
```
public final IPortLocationModelParameter createParameter(PointD ratios,
                                                         PointD offset)
```
    Creates a parameter that uses the given ratios and offsets.
    The ratios will be scaled by the node layout's size and added to the node's top left corner and the offset to determine the port location.
    
    Parameters:
    
    ratios - The ratios of the node layout's size.
    
    offset - The offset that is added after the ratios are applied.
    
    Returns:
    
    A new parameter that matches the specification.
  - 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

Class FreeNodePortLocationModel

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

NODE_BOTTOM_ANCHORED

NODE_BOTTOM_LEFT_ANCHORED

NODE_BOTTOM_RIGHT_ANCHORED

NODE_CENTER_ANCHORED

NODE_LEFT_ANCHORED

NODE_RIGHT_ANCHORED

NODE_TOP_ANCHORED

NODE_TOP_LEFT_ANCHORED

NODE_TOP_RIGHT_ANCHORED

Constructor Detail

FreeNodePortLocationModel

Method Detail

createParameter

createParameter

createParameter

getContext

getLocation

lookup