com.yworks.yfiles.view.input

Class NodeSnapResultProvider

java.lang.Object

com.yworks.yfiles.view.input.NodeSnapResultProvider

All Implemented Interfaces:

INodeSnapResultProvider

public class NodeSnapResultProvider
extends Object
implements INodeSnapResultProvider

The default implementation of the INodeSnapResultProvider interface.

Field Summary

Fields

Modifier and Type	Field and Description
static INodeSnapResultProvider	INSTANCE Yields the static shared instance of this class.

Constructor Summary

Constructors

Constructor and Description
NodeSnapResultProvider()

Method Summary

Modifier and Type	Method and Description
protected void	addGridSnapResult(GraphSnapContext context, CollectSnapResultsEventArgs args, PointD location, INode node) Calculates a SnapResult and adds it to the argument.
protected void	addGridSnapResultCore(GraphSnapContext context, CollectSnapResultsEventArgs args, PointD location, INode node, GridSnapTypes gridSnapType, SnapPolicy xSnapPolicy, SnapPolicy ySnapPolicy) Calculates a SnapResult and adds it to the argument.
protected void	collectGridSnapResults(GraphSnapContext context, CollectSnapResultsEventArgs args, RectD suggestedLayout, INode node) Collects snap results that snap the node to a grid and adds them to the argument.
protected void	collectSnapLineSnapResults(GraphSnapContext context, CollectSnapResultsEventArgs args, RectD suggestedLayout, INode node) Collects the results for the given layout for all snap lines in question.
protected void	collectSnapResults(CollectSnapResultsEventArgs args, OrthogonalSnapLine snapLine, RectD suggestedLayout, INode node) Verifies whether the node will snap to the given snap line.
void	collectSnapResults(GraphSnapContext context, CollectSnapResultsEventArgs args, RectD suggestedLayout, INode node) Called when a node is dragged to add SnapResults for OrthogonalSnapLines to which this node can potentially snap.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final INodeSnapResultProvider INSTANCE

Yields the static shared instance of this class.

Since this implementation does not carry any state, this instance can safely be used even in multi-threaded environments.

Constructor Detail

NodeSnapResultProvider

public NodeSnapResultProvider()

Method Detail

addGridSnapResult

protected void addGridSnapResult(GraphSnapContext context,
                                 CollectSnapResultsEventArgs args,
                                 PointD location,
                                 INode node)

Calculates a SnapResult and adds it to the argument.

This method delegates to addGridSnapResultCore(GraphSnapContext, CollectSnapResultsEventArgs, PointD, INode, GridSnapTypes, SnapPolicy, SnapPolicy) using GridSnapType and SnapPolicy.TO_NEAREST as the additional arguments. This method snaps the location to the next grid point or grid lines that are determined by NodeGridConstraintProvider or obtained from the Context.

Parameters:

context - The context in which the snapping is performed.

args - The arguments to add the results to.

location - A location in the layout of the suggested layout of the node that will be snapped to a grid point location.

node - The node that is currently being processed.

addGridSnapResultCore

protected void addGridSnapResultCore(GraphSnapContext context,
                                     CollectSnapResultsEventArgs args,
                                     PointD location,
                                     INode node,
                                     GridSnapTypes gridSnapType,
                                     SnapPolicy xSnapPolicy,
                                     SnapPolicy ySnapPolicy)

Calculates a SnapResult and adds it to the argument.

This method snaps the location to the next grid point or grid lines that are determined by NodeGridConstraintProvider or obtained from the Context.

Parameters:

context - The context in which the snapping is performed.

args - The arguments to add the results to.

location - A location in the layout of the suggested layout of the node that will be snapped to a grid point location.

node - The node that is currently being processed.

gridSnapType - The type of snapping that should be performed.

xSnapPolicy - How to snap the x coordinate.

ySnapPolicy - How to snap the y coordinate.

collectGridSnapResults

protected void collectGridSnapResults(GraphSnapContext context,
                                      CollectSnapResultsEventArgs args,
                                      RectD suggestedLayout,
                                      INode node)

Collects snap results that snap the node to a grid and adds them to the argument.

This implementation simply delegates to addGridSnapResult(GraphSnapContext, CollectSnapResultsEventArgs, PointD, INode) using the center of the suggestedLayout.

Parameters:

context - The context in which the snapping is performed.

args - The arguments to add the results to.

suggestedLayout - The layout of the node if it would move without snapping.

node - The node that is currently being processed.

collectSnapLineSnapResults

protected void collectSnapLineSnapResults(GraphSnapContext context,
                                          CollectSnapResultsEventArgs args,
                                          RectD suggestedLayout,
                                          INode node)

Collects the results for the given layout for all snap lines in question.

For each snap line that could be snapped to, this method calls collectSnapResults(CollectSnapResultsEventArgs, OrthogonalSnapLine, RectD, INode).

Parameters:

context - The context for which the results are being queried.

args - The CollectSnapResultsEventArgs instance to which the results should be added.

suggestedLayout - The suggested layout of the node.

node - The node that is being dragged.

collectSnapResults

protected void collectSnapResults(CollectSnapResultsEventArgs args,
                                  OrthogonalSnapLine snapLine,
                                  RectD suggestedLayout,
                                  INode node)

Verifies whether the node will snap to the given snap line.

If the node will snap, a SnapResult for a SnapLine will be created and added to the event argument.

Parameters:

args - The arguments to add the results to.

snapLine - The snap line to test snapping for.

suggestedLayout - The layout of the node if it would move without snapping.

node - The node that is currently being processed.

collectSnapResults

public void collectSnapResults(GraphSnapContext context,
                               CollectSnapResultsEventArgs args,
                               RectD suggestedLayout,
                               INode node)

Description copied from interface: INodeSnapResultProvider

Called when a node is dragged to add SnapResults for OrthogonalSnapLines to which this node can potentially snap.

Specified by:

collectSnapResults in interface INodeSnapResultProvider

Parameters:

context - The snap context which manages the snap lines and the settings.

args - The event argument to obtain the necessary information from and add results to.

suggestedLayout - The layout of the node if the node would not snap.

node - The node that is being moved.