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

java.lang.Object
- com.yworks.yfiles.graph.SimplePort

All Implemented Interfaces:

ILookup, IModelItem, IPort, ITagOwner
```
public class SimplePort
extends Object
implements IPort
```
A simple mutable implementation of the IPort interface that can be used stand-alone.
Note that this class is not the one used as the default implementation of a DefaultGraph's IPorts and casting them to SimplePort will fail. Instances of this class can be used without an accompanying graph instance. All of the properties are mutable. An example of a possible use case would be the rendering of a port into a graphics context: Simply create a SimplePort, associate a style with it and use the style's renderer instance to obtain a rendering for the port.

Field Summary
- Fields inherited from interface com.yworks.yfiles.graph.ILookup
  EMPTY

Constructor Summary

Constructors
Constructor and Description
`SimplePort(IPortOwner owner, IPortLocationModelParameter locationParameter)` Creates a port with a `default lookup` using the given location and owner.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`IPortLocationModelParameter`	`getLocationParameter()` Gets the `IPortLocationModelParameter` that is used to determine the location of this port.
`ILookup`	`getLookupImplementation()` Gets the `ILookup` implementation used for calls to `lookup(Class)` on this instance.
`IPortOwner`	`getOwner()` Returns the owner of this port.
`IPortStyle`	`getStyle()` Returns the style that is responsible for the visual representation of this port in a `CanvasControl`.
`Object`	`getTag()` Gets the tag associated with this instance.
`<TLookup> TLookup`	`lookup(Class<TLookup> type)` Returns an instance that implements the given type or `null`.
`void`	`setLocation(PointD location)` Sets the location of this port.
`void`	`setLocationParameter(IPortLocationModelParameter value)` Sets the `IPortLocationModelParameter` that is used to determine the location of this port.
`void`	`setLookupImplementation(ILookup value)` Sets the `ILookup` implementation used for calls to `lookup(Class)` on this instance.
`void`	`setOwner(IPortOwner value)` Returns the owner of this port.
`void`	`setStyle(IPortStyle value)` Returns the style that is responsible for the visual representation of this port in a `CanvasControl`.
`void`	`setTag(Object value)` Sets the tag associated with this instance.

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.IPort
getDynamicLocation, getLocation

Methods inherited from interface com.yworks.yfiles.graph.ILookup
createDictionaryLookup, createDynamic, createSingle, createSingle, createWrapped, lookup, lookup, safeLookup

- Constructor Detail
  - SimplePort
```
public SimplePort(IPortOwner owner,
                  IPortLocationModelParameter locationParameter)
```
    Creates a port with a default lookup using the given location and owner.
    While technically the owner can be null here, this can cause issues, e.g. with port location models that position the port relative to its owner.
    
    Parameters:
    
    owner - The port's owner.
    
    locationParameter - The port's location model parameter.
- Method Detail
  - getLocationParameter
```
public final IPortLocationModelParameter getLocationParameter()
```
    Description copied from interface: IPort
    
    Gets the IPortLocationModelParameter that is used to determine the location of this port.
    The port location can be calculated using the Model's IPortLocationModel.getLocation(IPort, IPortLocationModelParameter) method or the convenience methods IPort.getLocation() and IPort.getDynamicLocation().
    
    Note that parameters may be shared across port instances.
    
    Specified by:
    
    getLocationParameter in interface IPort
    
    Returns:
    
    The LocationParameter.
    
    See Also:
    
    IGraph.setPortLocationParameter(IPort, IPortLocationModelParameter), IPort.getLocation(), IPort.getDynamicLocation()
  - getLookupImplementation
```
public final ILookup getLookupImplementation()
```
    Gets the ILookup implementation used for calls to lookup(Class) on this instance.
    
    Returns:
    
    The LookupImplementation.
    
    See Also:
    
    setLookupImplementation(ILookup)
  - getOwner
```
public final IPortOwner getOwner()
```
    Description copied from interface: IPort
    
    Returns the owner of this port.
    In traditional IGraph implementations, this will be an INode and can safely be cast to one. In order to get to the IEdges that connect to this instance, use IGraph's IGraph.edgesAt(IPort, com.yworks.yfiles.graph.AdjacencyTypes) method.
    
    Specified by:
    
    getOwner in interface IPort
    
    Returns:
    
    The Owner.
  - getStyle
```
public final IPortStyle getStyle()
```
    Description copied from interface: IPort
    
    Returns the style that is responsible for the visual representation of this port in a CanvasControl.
    In order to set the style on an instance, use the IGraph.setStyle(IPort, IPortStyle) method. Note that the style instance associated with a port instance may be shared between multiple port instances and that the modification of this style will result in a change of the appearance of all ports that are associated with the same style instance.
    
    Specified by:
    
    getStyle in interface IPort
    
    Returns:
    
    The Style.
  - getTag
```
public final Object getTag()
```
    Description copied from interface: ITagOwner
    
    Gets the tag associated with this instance.
    The implementation itself does not normally depend on the tag associated with it. It serves as storage for the object only.
    
    Specified by:
    
    getTag in interface ITagOwner
    
    Returns:
    
    The user object associated with this instance.
    
    See Also:
    
    ITagOwner.setTag(Object)
  - lookup
```
public <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
  - setLocation
```
public final void setLocation(PointD location)
```
    Sets the location of this port.
  - setLocationParameter
```
public final void setLocationParameter(IPortLocationModelParameter value)
```
    Sets the IPortLocationModelParameter that is used to determine the location of this port.
    The port location can be calculated using the Model's IPortLocationModel.getLocation(IPort, IPortLocationModelParameter) method or the convenience methods IPort.getLocation() and IPort.getDynamicLocation().
    
    Note that parameters may be shared across port instances.
    
    Parameters:
    
    value - The LocationParameter to set.
    
    See Also:
    
    IGraph.setPortLocationParameter(IPort, IPortLocationModelParameter), IPort.getLocation(), IPort.getDynamicLocation(), getLocationParameter()
  - setLookupImplementation
```
public final void setLookupImplementation(ILookup value)
```
    Sets the ILookup implementation used for calls to lookup(Class) on this instance.
    
    Parameters:
    
    value - The LookupImplementation to set.
    
    See Also:
    
    getLookupImplementation()
  - setOwner
```
public final void setOwner(IPortOwner value)
```
    Returns the owner of this port.
    In traditional IGraph implementations, this will be an INode and can safely be cast to one. In order to get to the IEdges that connect to this instance, use IGraph's IGraph.edgesAt(IPort, com.yworks.yfiles.graph.AdjacencyTypes) method.
    
    Parameters:
    
    value - The Owner to set.
    
    See Also:
    
    getOwner()
  - setStyle
```
public final void setStyle(IPortStyle value)
```
    Returns the style that is responsible for the visual representation of this port in a CanvasControl.
    In order to set the style on an instance, use the IGraph.setStyle(IPort, IPortStyle) method. Note that the style instance associated with a port instance may be shared between multiple port instances and that the modification of this style will result in a change of the appearance of all ports that are associated with the same style instance.
    
    Parameters:
    
    value - The Style to set.
    
    See Also:
    
    getStyle()
  - setTag
```
public final void setTag(Object value)
```
    Description copied from interface: ITagOwner
    
    Sets the tag associated with this instance.
    The implementation itself does not normally depend on the tag associated with it. It serves as storage for the object only.
    
    Specified by:
    
    setTag in interface ITagOwner
    
    Parameters:
    
    value - The user object associated with this instance.
    
    See Also:
    
    ITagOwner.getTag()

Class SimplePort

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.IPort

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

Constructor Detail

SimplePort

Method Detail

getLocationParameter

getLookupImplementation

getOwner

getStyle

getTag

lookup

setLocation

setLocationParameter

setLookupImplementation

setOwner

setStyle

setTag