com.yworks.yfiles.view.input

Class AbstractPortCandidateProvider

java.lang.Object

com.yworks.yfiles.view.input.AbstractPortCandidateProvider

All Implemented Interfaces:

IPortCandidateProvider

public abstract class AbstractPortCandidateProvider
extends Object
implements IPortCandidateProvider

An abstract convenience implementation of the IPortCandidateProvider interface.

Field Summary

Fields inherited from interface com.yworks.yfiles.view.input.IPortCandidateProvider

NO_CANDIDATES

Constructor Summary

Constructors

Constructor and Description
AbstractPortCandidateProvider()

Method Summary

Modifier and Type	Method and Description
protected void	addExistingPorts(IPortOwner owner, List<IPortCandidate> list) Convenience method for subclasses that adds all existing Ports of the owner to the provided list.
protected DefaultPortCandidate	createCandidate(IPortOwner owner, IPortLocationModelParameter locationParameter) Factory method that creates a simple candidate that will use the createInstance(IInputModeContext, DefaultPortCandidate) method of this instance to delegate IPortCandidate.createPort(IInputModeContext) queries to.
protected DefaultPortCandidate	createCandidate(IPortOwner owner, IPortLocationModelParameter locationParameter, boolean valid) Factory method that creates a simple candidate that will use the createInstance(IInputModeContext, DefaultPortCandidate) method of this instance to delegate IPortCandidate.createPort(IInputModeContext) queries to.
protected IPort	createInstance(IInputModeContext context, DefaultPortCandidate candidate) Callback method used by the ports created using the factory methods createCandidate(IPortOwner, IPortLocationModelParameter, boolean).
protected IPortCandidate	getPortCandidateAt(IInputModeContext context, DefaultPortCandidate candidate, PointD suggestedLocation) Callback method used by the ports created using the factory methods createCandidate(IPortOwner, IPortLocationModelParameter, boolean).
protected abstract Iterable<IPortCandidate>	getPortCandidates(IInputModeContext context) Creates an enumeration of possibly port candidates.
Iterable<IPortCandidate>	getSourcePortCandidates(IInputModeContext context) Convenience implementation that simply delegates to getPortCandidates(IInputModeContext).
Iterable<IPortCandidate>	getSourcePortCandidates(IInputModeContext context, IPortCandidate target) Convenience implementation that simply delegates to getPortCandidates(IInputModeContext).
IPortStyle	getStyle() Gets the style to use for the creation of the port in createInstance(IInputModeContext, DefaultPortCandidate).
Object	getTag() The tag to assign to the port in createInstance(IInputModeContext, DefaultPortCandidate).
Iterable<IPortCandidate>	getTargetPortCandidates(IInputModeContext context) Convenience implementation that simply delegates to getPortCandidates(IInputModeContext).
Iterable<IPortCandidate>	getTargetPortCandidates(IInputModeContext context, IPortCandidate source) Convenience implementation that simply delegates to getPortCandidates(IInputModeContext).
void	setStyle(IPortStyle value) Sets the style to use for the creation of the port in createInstance(IInputModeContext, DefaultPortCandidate).
void	setTag(Object value) The tag to assign to the port in createInstance(IInputModeContext, DefaultPortCandidate).

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.view.input.IPortCandidateProvider

combine, combine, fromCandidates, fromCandidates, fromExistingPorts, fromNodeCenter, fromPortDefaults, fromShapeGeometry, fromShapeGeometry, fromUnoccupiedPorts

Constructor Detail

AbstractPortCandidateProvider

public AbstractPortCandidateProvider()

Method Detail

addExistingPorts

protected void addExistingPorts(IPortOwner owner,
                                List<IPortCandidate> list)

Convenience method for subclasses that adds all existing Ports of the owner to the provided list.

Parameters:

owner - The port owner whose ports should be added.

list - The list to add candidates for existing ports to.

createCandidate

protected final DefaultPortCandidate createCandidate(IPortOwner owner,
                                                     IPortLocationModelParameter locationParameter)

Factory method that creates a simple candidate that will use the createInstance(IInputModeContext, DefaultPortCandidate) method of this instance to delegate IPortCandidate.createPort(IInputModeContext) queries to.

Parameters:

owner - The owner to use for the candidate.

locationParameter - The location of the candidate. This instance is assigned by reference to the candidate.

Returns:

A candidate whose IPortCandidate.createPort(IInputModeContext) method delegates to this instance's createInstance(IInputModeContext, DefaultPortCandidate).

createCandidate

protected final DefaultPortCandidate createCandidate(IPortOwner owner,
                                                     IPortLocationModelParameter locationParameter,
                                                     boolean valid)

Factory method that creates a simple candidate that will use the createInstance(IInputModeContext, DefaultPortCandidate) method of this instance to delegate IPortCandidate.createPort(IInputModeContext) queries to.

Parameters:

locationParameter - The location of the candidate. This instance is assigned by reference to the candidate.

owner - The owner to use for the candidate.

valid - Whether the port should be PortCandidateValidity.VALID.

Returns:

A candidate whose IPortCandidate.createPort(IInputModeContext) method delegates to this instance's createInstance(IInputModeContext, DefaultPortCandidate).

createInstance

protected IPort createInstance(IInputModeContext context,
                               DefaultPortCandidate candidate)

Callback method used by the ports created using the factory methods createCandidate(IPortOwner, IPortLocationModelParameter, boolean).

This method can be overridden by subclasses to perform more sophisticated port creation logic.

Parameters:

context - The context in which the instance is created.

candidate - The candidate to create a port for.

Returns:

The new port.

getPortCandidateAt

protected IPortCandidate getPortCandidateAt(IInputModeContext context,
                                            DefaultPortCandidate candidate,
                                            PointD suggestedLocation)

Callback method used by the ports created using the factory methods createCandidate(IPortOwner, IPortLocationModelParameter, boolean).

This method can be overridden by subclasses to perform more sophisticated candidate creation logic.

Parameters:

context - The context in which the instance is created.

candidate - The candidate to create a port for.

suggestedLocation - The location to get a candidate for.

Returns:

The new candidate whose Validity may not be PortCandidateValidity.DYNAMIC.

getPortCandidates

protected abstract Iterable<IPortCandidate> getPortCandidates(IInputModeContext context)

Creates an enumeration of possibly port candidates.

This method is used as a callback by most of the getter methods in this class. Subclasses should override this method to provide the same candidates for all use-cases.

Parameters:

context - The context for which the candidates should be provided.

Returns:

An enumerable collection of port candidates.

getSourcePortCandidates

public Iterable<IPortCandidate> getSourcePortCandidates(IInputModeContext context)

Convenience implementation that simply delegates to getPortCandidates(IInputModeContext).

Specified by:

getSourcePortCandidates in interface IPortCandidateProvider

Parameters:

context - The context for which the candidates should be provided.

Returns:

An enumerable over all source port candidates that are associated with the current context.

getSourcePortCandidates

public Iterable<IPortCandidate> getSourcePortCandidates(IInputModeContext context,
                                                        IPortCandidate target)

Convenience implementation that simply delegates to getPortCandidates(IInputModeContext).

Specified by:

getSourcePortCandidates in interface IPortCandidateProvider

target - The opposite port candidate.

Returns:

An enumerable over all port candidates that are associated with the given opposite port.

getStyle

public final IPortStyle getStyle()

Gets the style to use for the creation of the port in createInstance(IInputModeContext, DefaultPortCandidate).

A value of null will make the implementation use the corresponding current default port style.

Returns:

The Style.

See Also:

setStyle(IPortStyle)

getTag

public final Object getTag()

The tag to assign to the port in createInstance(IInputModeContext, DefaultPortCandidate).

Returns:

The Tag.

See Also:

setTag(Object)

getTargetPortCandidates

public Iterable<IPortCandidate> getTargetPortCandidates(IInputModeContext context)

Convenience implementation that simply delegates to getPortCandidates(IInputModeContext).

Specified by:

getTargetPortCandidates in interface IPortCandidateProvider

Parameters:

context - The context for which the candidates should be provided.

Returns:

An enumerable over all target port candidates that are associated with the current context.

getTargetPortCandidates

public Iterable<IPortCandidate> getTargetPortCandidates(IInputModeContext context,
                                                        IPortCandidate source)

Convenience implementation that simply delegates to getPortCandidates(IInputModeContext).

Specified by:

getTargetPortCandidates in interface IPortCandidateProvider

Parameters:

context - The context for which the candidates should be provided.

source - The opposite port candidate.

Returns:

An enumerable over all port candidates that are associated with the given opposite port.

setStyle

public final void setStyle(IPortStyle value)

Sets the style to use for the creation of the port in createInstance(IInputModeContext, DefaultPortCandidate).

A value of null will make the implementation use the corresponding current default port style.

Parameters:

value - The Style to set.

See Also:

getStyle()

setTag

public final void setTag(Object value)

The tag to assign to the port in createInstance(IInputModeContext, DefaultPortCandidate).

Parameters:

value - The Tag to set.

See Also:

getTag()