com.yworks.yfiles.view.input

Class PortRelocationHandleProvider

java.lang.Object

com.yworks.yfiles.view.input.PortRelocationHandleProvider

All Implemented Interfaces:

IEdgePortHandleProvider, IHandleProvider

public class PortRelocationHandleProvider
extends Object
implements IHandleProvider, IEdgePortHandleProvider

Simple implementation of a IHandleProvider that can be used for IEdges.

It will return the IHandles for the source and target ports using PortRelocationHandles.

Note that this implementation also explicitly implements the IEdgePortHandleProvider and that it is recommended to decorate the IEdgePortHandleProvider interface with edges in order to influence the handles of the source and target port of the edge instead of directly decorating and implementing the IHandleProvider interface. The default implementation of the IHandleProvider interface in the lookup of the IEdges (see DefaultEdgeLookup) will use the IEdgeReconnectionPortCandidateProvider interface to collect the source and target port handles.

Field Summary

Fields

Modifier and Type	Field and Description
protected IEdge	edge The edge this provider is working on.
protected IGraph	graph The graph this provider is working on.

Constructor Summary

Constructors

Constructor and Description
PortRelocationHandleProvider(IGraph graph, IEdge edge) Initializes a new instance of the PortRelocationHandleProvider class using the given graph and edge.

Method Summary

Modifier and Type	Method and Description
protected IHandle	createPortRelocationHandle(IGraph graph, IEdge edge, boolean sourcePort) Factory method that creates the handle for this provider.
IHandle	getHandle(IInputModeContext context, IEdge edge, boolean sourceHandle) Gets an IHandle implementation for one end of the provided edge.
Iterable<IHandle>	getHandles(IInputModeContext context) Returns a collection of zero or more IHandle implementations that are associated with this instance.

Methods inherited from class java.lang.Object

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

Field Detail

edge

protected final IEdge edge

The edge this provider is working on.

graph

protected final IGraph graph

The graph this provider is working on.

Constructor Detail

PortRelocationHandleProvider

public PortRelocationHandleProvider(IGraph graph,
                                    IEdge edge)

Initializes a new instance of the PortRelocationHandleProvider class using the given graph and edge.

Parameters:

graph - The graph or null. If the graph is null, the handles will try to receive the graph from the IInputModeContext it is used in.

edge - The edge.

Method Detail

createPortRelocationHandle

protected IHandle createPortRelocationHandle(IGraph graph,
                                             IEdge edge,
                                             boolean sourcePort)

Factory method that creates the handle for this provider.

Parameters:

graph - The graph that contains the edge.

edge - The edge.

sourcePort - if set to true the handle for the source port is sought.

Returns:

A handle or null.

getHandle

public final IHandle getHandle(IInputModeContext context,
                               IEdge edge,
                               boolean sourceHandle)

Description copied from interface: IEdgePortHandleProvider

Gets an IHandle implementation for one end of the provided edge.

Specified by:

getHandle in interface IEdgePortHandleProvider

Parameters:

context - The context in which the handle will be used.

edge - The edge for which an handle is needed.

sourceHandle - if set to true the handle for the source side/port should be returned.

Returns:

The handle to use for the provided side or null.

getHandles

public Iterable<IHandle> getHandles(IInputModeContext context)

Description copied from interface: IHandleProvider

Returns a collection of zero or more IHandle implementations that are associated with this instance.

Specified by:

getHandles in interface IHandleProvider

Returns:

A collection of handles.