com.yworks.yfiles.view.input

Class CollectGraphSnapLinesEventArgs

java.lang.Object

com.yworks.yfiles.view.input.InputModeEventArgs

com.yworks.yfiles.view.input.CollectGraphSnapLinesEventArgs

All Implemented Interfaces:

IEventArgs

public class CollectGraphSnapLinesEventArgs
extends InputModeEventArgs

Event arguments for the CollectSnapLines event.

Instances of this class are also passed to ISnapLineProvider.addSnapLines(GraphSnapContext, CollectGraphSnapLinesEventArgs, com.yworks.yfiles.graph.IModelItem). Implementations of that interface can use the following methods to add snap lines for specific purposes:

• addFixedNodeSnapLine(OrthogonalSnapLine) – Adds an orthogonal snap line for nodes.
• addFixedSegmentSnapLine(OrthogonalSnapLine) – Adds an orthogonal snap line for edge segments and bends.
• addPortSnapLine(OrthogonalSnapLine) – Adds an orthogonal snap line for ports.
• addAdditionalSnapLine(OrthogonalSnapLine) – Adds an additional orthogonal snap line to which all element will snap.

Field Summary

Fields inherited from interface com.yworks.yfiles.utils.IEventArgs

EMPTY

Constructor Summary

Constructors

Constructor and Description
CollectGraphSnapLinesEventArgs(IInputModeContext context, Collection<OrthogonalSnapLine> fixedNodeSnapLines, Collection<OrthogonalSnapLine> fixedSegmentSnapLines, Collection<OrthogonalSnapLine> fixedPortSnapLines, Collection<OrthogonalSnapLine> additionalSnapLines) Initializes a new instance of the CollectGraphSnapLinesEventArgs class.

Method Summary

Modifier and Type	Method and Description
void	addAdditionalSnapLine(OrthogonalSnapLine snapLine) Adds a snap line all elements will snap to.
void	addFixedNodeSnapLine(OrthogonalSnapLine snapLine) Adds a snap line for nodes.
void	addFixedSegmentSnapLine(OrthogonalSnapLine snapLine) Adds a snap line for edge segments and bends.
void	addPortSnapLine(OrthogonalSnapLine snapLine) Adds a snap line for ports.

Methods inherited from class com.yworks.yfiles.view.input.InputModeEventArgs

getContext

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectGraphSnapLinesEventArgs

public CollectGraphSnapLinesEventArgs(IInputModeContext context,
                                      Collection<OrthogonalSnapLine> fixedNodeSnapLines,
                                      Collection<OrthogonalSnapLine> fixedSegmentSnapLines,
                                      Collection<OrthogonalSnapLine> fixedPortSnapLines,
                                      Collection<OrthogonalSnapLine> additionalSnapLines)

Initializes a new instance of the CollectGraphSnapLinesEventArgs class.

Parameters:

context - The context where the event is being used in.

fixedNodeSnapLines - The fixed node snap lines collection to add to.

fixedSegmentSnapLines - The fixed segment snap lines collection to add to.

fixedPortSnapLines - The fixed port snap lines collection to add to.

additionalSnapLines - The additional snap lines collection to add to.

Method Detail

addAdditionalSnapLine

public final void addAdditionalSnapLine(OrthogonalSnapLine snapLine)

Adds a snap line all elements will snap to.

Parameters:

snapLine - The snap line to add to the list of lines that all elements snap to by default.

See Also:

GraphSnapContext.getAdditionalSnapLines()

addFixedNodeSnapLine

public final void addFixedNodeSnapLine(OrthogonalSnapLine snapLine)

Adds a snap line for nodes.

Parameters:

snapLine - The snap line to add to the list of lines that nodes snap to by default.

See Also:

GraphSnapContext.getFixedNodeSnapLines()

addFixedSegmentSnapLine

public final void addFixedSegmentSnapLine(OrthogonalSnapLine snapLine)

Adds a snap line for edge segments and bends.

Parameters:

snapLine - The snap line to add to the list of lines that segments snap to by default.

See Also:

GraphSnapContext.getFixedSegmentSnapLines()

addPortSnapLine

public final void addPortSnapLine(OrthogonalSnapLine snapLine)

Adds a snap line for ports.

Parameters:

snapLine - The snap line to add to the list of lines that ports snap to by default.

See Also:

GraphSnapContext.getFixedPortSnapLines()