com.yworks.yfiles.view.input

Class EdgeSnapLineProvider

java.lang.Object

com.yworks.yfiles.view.input.EdgeSnapLineProvider

All Implemented Interfaces:

ISnapLineProvider

public class EdgeSnapLineProvider
extends Object
implements ISnapLineProvider

Simple implementation of the ISnapLineProvider interface that can be used to add snap lines for orthogonally routed IEdges.

This implementation can be put into the ILookup.lookup(java.lang.Class) of an IEdge.

See Also:

EdgeDecorator.getSnapLineProviderDecorator()

Constructor Summary

Constructors

Constructor and Description
EdgeSnapLineProvider()

Method Summary

Modifier and Type	Method and Description
protected void	addHorizontalSegmentSnapLines(GraphSnapContext context, CollectGraphSnapLinesEventArgs args, IEdge edge, PointD segmentStart, PointD segmentEnd) Adds horizontal snap lines for a horizontally oriented fixed segment snap lines.
void	addSnapLines(GraphSnapContext context, CollectGraphSnapLinesEventArgs args, IModelItem item) Adds the snap lines for the given model item to the args.
protected void	addVerticalSegmentSnapLines(GraphSnapContext context, CollectGraphSnapLinesEventArgs args, IEdge edge, PointD segmentStart, PointD segmentEnd) Adds vertical snap lines for a vertically oriented fixed segment snap lines.

Methods inherited from class java.lang.Object

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

Constructor Detail

EdgeSnapLineProvider

public EdgeSnapLineProvider()

Method Detail

addHorizontalSegmentSnapLines

protected void addHorizontalSegmentSnapLines(GraphSnapContext context,
                                             CollectGraphSnapLinesEventArgs args,
                                             IEdge edge,
                                             PointD segmentStart,
                                             PointD segmentEnd)

Adds horizontal snap lines for a horizontally oriented fixed segment snap lines.

Parameters:

context - The context which holds the settings for the snap lines. Note that implementations should not change the state of the context explicitly.

edge - The edge to add snap lines for.

segmentStart - The start of the segment.

args - The argument to use for adding snap lines.

segmentEnd - The end of the segment.

See Also:

addVerticalSegmentSnapLines(GraphSnapContext, CollectGraphSnapLinesEventArgs, IEdge, PointD, PointD)

addSnapLines

public void addSnapLines(GraphSnapContext context,
                         CollectGraphSnapLinesEventArgs args,
                         IModelItem item)

Adds the snap lines for the given model item to the args.

This implementation queries the movement information for the provided edge to determine which edge segments stay fixed. For each fixed segment, it will call addVerticalSegmentSnapLines(GraphSnapContext, CollectGraphSnapLinesEventArgs, IEdge, PointD, PointD) or addHorizontalSegmentSnapLines(GraphSnapContext, CollectGraphSnapLinesEventArgs, IEdge, PointD, PointD) respectively.

Specified by:

addSnapLines in interface ISnapLineProvider

Parameters:

context - The context which holds the settings for the snap lines. Note that implementations should not change the state of the context explicitly.

item - The item to add snap lines for.

args - The argument to use for adding snap lines.

addVerticalSegmentSnapLines

protected void addVerticalSegmentSnapLines(GraphSnapContext context,
                                           CollectGraphSnapLinesEventArgs args,
                                           IEdge edge,
                                           PointD segmentStart,
                                           PointD segmentEnd)

Adds vertical snap lines for a vertically oriented fixed segment snap lines.

Parameters:

context - The context which holds the settings for the snap lines. Note that implementations should not change the state of the context explicitly.

edge - The edge to add snap lines for.

segmentStart - The start of the segment.

segmentEnd - The end of the segment.

args - The argument to use for adding snap lines.

See Also:

addHorizontalSegmentSnapLines(GraphSnapContext, CollectGraphSnapLinesEventArgs, IEdge, PointD, PointD)