com.yworks.yfiles.view.input

Class DefaultPortCandidate

java.lang.Object

com.yworks.yfiles.view.input.DefaultPortCandidate

All Implemented Interfaces:

IPortCandidate

public class DefaultPortCandidate
extends Object
implements IPortCandidate

A simple default implementation of an IPortCandidate.

Subclasses need to override createInstance(IInputModeContext, IGraph, IPortLocationModelParameter, IPortStyle, Object) if they don't set a port instance.

Constructor Summary

Constructors

Constructor and Description
DefaultPortCandidate(IPort port) Creates a candidate using the given port as the template.
DefaultPortCandidate(IPortOwner owner) Creates a candidate for the given owner that uses the graph's defaults for the port's style and the given locationParameter.
DefaultPortCandidate(IPortOwner owner, IPortLocationModel model) Creates a candidate for the given owner that uses the graph's defaults for the port's style and a default parameter for the given model.
DefaultPortCandidate(IPortOwner owner, IPortLocationModelParameter locationParameter) Creates a candidate for the given owner that uses the graph's defaults for the port's style and the given locationParameter.
DefaultPortCandidate(IPortOwner owner, IPortLocationModelParameter locationParameter, PortCandidateValidity validity) Creates a candidate for the given owner that uses the graph's defaults for the port's style and the given locationParameter.

Method Summary

Modifier and Type	Method and Description
protected IPort	createInstance(IInputModeContext context, IGraph graph, IPortLocationModelParameter locationParameter, IPortStyle style, Object tag) Actually creates the IPort instance.
IPort	createPort(IInputModeContext context) This implementation will throw a UnsupportedOperationException if the validity is PortCandidateValidity.DYNAMIC.
Object	getCandidateTag() Gets the tag for this candidate.
IPortLocationModelParameter	getLocationParameter() Gets the model parameter that will be used for the LocationParameter if this candidate is chosen.
IPortLocationModel	getModel() The model that will be used by this instance to determine the new LocationParameter if the getPortCandidateAt(IInputModeContext, PointD) is called and the Validity is set to PortCandidateValidity.DYNAMIC.
IPortOwner	getOwner() Gets the owner of the port to be created.
IPort	getPort() Returns the instance provided to the constructor or to the setter.
IPortCandidate	getPortCandidateAt(IInputModeContext context, PointD location) Returns a candidate that is derived from this instance that best fits the provided location.
Object	getPortTag() Gets the port tag to create the port with.
IPortStyle	getStyle() Gets the style to use for the newly created port.
PortCandidateValidity	getValidity() Determines whether this candidate is a valid one depending on the context it has been obtained from.
void	setCandidateTag(Object value) Sets the tag for this candidate.
void	setInstance(IPort port) Sets the instance that will be returned by Port and createPort(IInputModeContext).
void	setLocationParameter(IPortLocationModelParameter value) Sets the model parameter that will be used for the LocationParameter if this candidate is chosen.
void	setModel(IPortLocationModel value) The model that will be used by this instance to determine the new LocationParameter if the getPortCandidateAt(IInputModeContext, PointD) is called and the Validity is set to PortCandidateValidity.DYNAMIC.
void	setOwner(IPortOwner value) Sets the owner of the port to be created.
void	setPortTag(Object value) Sets the port tag to create the port with.
void	setStyle(IPortStyle value) Sets the style to use for the newly created port.
void	setValidity(PortCandidateValidity value) Determines whether this candidate is a valid one depending on the context it has been obtained from.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultPortCandidate

public DefaultPortCandidate(IPort port)

Creates a candidate using the given port as the template.

Parameters:

port - The port to use.

DefaultPortCandidate

public DefaultPortCandidate(IPortOwner owner)

Creates a candidate for the given owner that uses the graph's defaults for the port's style and the given locationParameter.

If no locationParameter is given, the used candidate has a fixed location at PointD.ORIGIN that does not depend on the owner.

Parameters:

owner - The owner.

DefaultPortCandidate

public DefaultPortCandidate(IPortOwner owner,
                            IPortLocationModel model)

Creates a candidate for the given owner that uses the graph's defaults for the port's style and a default parameter for the given model.

The LocationParameter is set to the parameter that best matches the origin for the given model.

Parameters:

owner - The owner.

model - The model.

DefaultPortCandidate

public DefaultPortCandidate(IPortOwner owner,
                            IPortLocationModelParameter locationParameter)

Creates a candidate for the given owner that uses the graph's defaults for the port's style and the given locationParameter.

If no locationParameter is given, the used candidate has a fixed location at PointD.ORIGIN that does not depend on the owner.

Parameters:

owner - The owner.

locationParameter - The location.

DefaultPortCandidate

public DefaultPortCandidate(IPortOwner owner,
                            IPortLocationModelParameter locationParameter,
                            PortCandidateValidity validity)

Creates a candidate for the given owner that uses the graph's defaults for the port's style and the given locationParameter.

If no locationParameter is given, the used candidate has a fixed location at PointD.ORIGIN that does not depend on the owner.

Parameters:

owner - The owner.

locationParameter - The location.

validity - The validity of the port candidate.

Method Detail

createInstance

protected IPort createInstance(IInputModeContext context,
                               IGraph graph,
                               IPortLocationModelParameter locationParameter,
                               IPortStyle style,
                               Object tag)

Actually creates the IPort instance.

This method is called in response to a call to createPort(IInputModeContext) on this instance and the instances created by getPortCandidateAt(IInputModeContext, PointD).

Parameters:

context - The input mode context.

graph - The graph to add the port to.

locationParameter - The parameter to use.

style - The style to use.

tag - The tag to use.

Returns:

The newly created port.

createPort

public IPort createPort(IInputModeContext context)

This implementation will throw a UnsupportedOperationException if the validity is PortCandidateValidity.DYNAMIC.

This implementation will delegate to the createInstance(IInputModeContext, IGraph, IPortLocationModelParameter, IPortStyle, Object) method.

Specified by:

createPort in interface IPortCandidate

Parameters:

context - The input mode context for which the port will be created. Implementations can depend on it providing an IGraph instance in the lookup of the instance.

Returns:

The port instance to use if this candidate has been chosen. This method may not return null.

See Also:

IInputModeContext.getGraph(), IPortCandidate.getPort(), IPortCandidate.getPortCandidateAt(IInputModeContext, PointD)

getCandidateTag

public final Object getCandidateTag()

Gets the tag for this candidate.

The interpretation of this value is implementation dependent and may be used for visual feedback or interactive behavior.

Specified by:

getCandidateTag in interface IPortCandidate

Returns:

The CandidateTag.

See Also:

setCandidateTag(Object)

getLocationParameter

public final IPortLocationModelParameter getLocationParameter()

Gets the model parameter that will be used for the LocationParameter if this candidate is chosen.

The parameter which may not be null.

Specified by:

getLocationParameter in interface IPortCandidate

Returns:

The LocationParameter.

See Also:

setLocationParameter(IPortLocationModelParameter)

getModel

public final IPortLocationModel getModel()

The model that will be used by this instance to determine the new LocationParameter if the getPortCandidateAt(IInputModeContext, PointD) is called and the Validity is set to PortCandidateValidity.DYNAMIC.

Returns:

The Model.

See Also:

setModel(IPortLocationModel)

getOwner

public final IPortOwner getOwner()

Gets the owner of the port to be created.

Specified by:

getOwner in interface IPortCandidate

Returns:

The Owner.

See Also:

setOwner(IPortOwner)

getPort

public IPort getPort()

Returns the instance provided to the constructor or to the setter.

Specified by:

getPort in interface IPortCandidate

Returns:

The instance to use or null otherwise.

See Also:

createPort(IInputModeContext)

getPortCandidateAt

public IPortCandidate getPortCandidateAt(IInputModeContext context,
                                         PointD location)

Returns a candidate that is derived from this instance that best fits the provided location.

The returned implementation will finally call createInstance(IInputModeContext, IGraph, IPortLocationModelParameter, IPortStyle, Object) using the newly calculated LocationParameter.

Specified by:

getPortCandidateAt in interface IPortCandidate

Parameters:

context - The input mode context for which a concrete candidate is queried.

location - The location for which a candidate should be returned.

Returns:

A IPortCandidate implementation whose Validity is guaranteed to be non-PortCandidateValidity.DYNAMIC.

See Also:

getValidity()

getPortTag

public final Object getPortTag()

Gets the port tag to create the port with.

Returns:

The port tag to use when the port is created.

See Also:

setPortTag(Object)

getStyle

public final IPortStyle getStyle()

Gets the style to use for the newly created port.

Returns:

The style. If this property is null, the current default in the graph will be used.

See Also:

setStyle(IPortStyle)

getValidity

public final PortCandidateValidity getValidity()

Determines whether this candidate is a valid one depending on the context it has been obtained from.

Specified by:

getValidity in interface IPortCandidate

Returns:

The Validity.

See Also:

setValidity(PortCandidateValidity)

setCandidateTag

public final void setCandidateTag(Object value)

Sets the tag for this candidate.

The interpretation of this value is implementation dependent and may be used for visual feedback or interactive behavior.

Parameters:

value - The CandidateTag to set.

See Also:

getCandidateTag()

setInstance

public void setInstance(IPort port)

Sets the instance that will be returned by Port and createPort(IInputModeContext).

Parameters:

port - A port that already exists in the graph or null.

setLocationParameter

public final void setLocationParameter(IPortLocationModelParameter value)

Sets the model parameter that will be used for the LocationParameter if this candidate is chosen.

The parameter which may not be null.

Parameters:

value - The LocationParameter to set.

See Also:

getLocationParameter()

setModel

public final void setModel(IPortLocationModel value)

The model that will be used by this instance to determine the new LocationParameter if the getPortCandidateAt(IInputModeContext, PointD) is called and the Validity is set to PortCandidateValidity.DYNAMIC.

Parameters:

value - The Model to set.

See Also:

getModel()

setOwner

public final void setOwner(IPortOwner value)

Sets the owner of the port to be created.

Parameters:

value - The Owner to set.

See Also:

getOwner()

setPortTag

public final void setPortTag(Object value)

Sets the port tag to create the port with.

Parameters:

value - The port tag to use when the port is created.

See Also:

getPortTag()

setStyle

public final void setStyle(IPortStyle value)

Sets the style to use for the newly created port.

Parameters:

value - The style. If this property is null, the current default in the graph will be used.

See Also:

getStyle()

setValidity

public final void setValidity(PortCandidateValidity value)

Determines whether this candidate is a valid one depending on the context it has been obtained from.

Parameters:

value - The Validity to set.

See Also:

getValidity()