com.yworks.yfiles.view.input

Class OrthogonalEdgeHelper

java.lang.Object

com.yworks.yfiles.view.input.OrthogonalEdgeHelper

All Implemented Interfaces:

IOrthogonalEdgeHelper

public class OrthogonalEdgeHelper
extends Object
implements IOrthogonalEdgeHelper

Default implementation of the IOrthogonalEdgeHelper.

This class inspects the edges in question and infers the SegmentOrientations of the segments from the current geometry of the edge path.

Constructor Summary

Constructors

Constructor and Description
OrthogonalEdgeHelper()

Method Summary

Modifier and Type	Method and Description
protected boolean	canRemoveBend(IInputModeContext context, IBend bend) Returns whether the given bend can be removed.
void	cleanUpEdge(IInputModeContext context, IGraph graph, IEdge edge) Callback method that is invoked after the provided edge has been edited orthogonally.
SegmentOrientation	getSegmentOrientation(IInputModeContext context, IEdge edge, int segmentIndex) Gets the orientation of the given segment by looking at the geometry of the segment.
boolean	shouldEditOrthogonally(IInputModeContext context, IEdge edge) Determines whether the provided edge should be edited orthogonally in the specified input mode context.
boolean	shouldMoveEndImplicitly(IInputModeContext context, IEdge edge, boolean sourceEnd) Determines whether this end of the provided edge can be moved in the input mode context.

Methods inherited from class java.lang.Object

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

Constructor Detail

OrthogonalEdgeHelper

public OrthogonalEdgeHelper()

Method Detail

canRemoveBend

protected boolean canRemoveBend(IInputModeContext context,
                                IBend bend)

Returns whether the given bend can be removed.

This implementation always returns true.

Parameters:

context - The input mode context.

bend - The bend that is designated for removal.

cleanUpEdge

public void cleanUpEdge(IInputModeContext context,
                        IGraph graph,
                        IEdge edge)

Callback method that is invoked after the provided edge has been edited orthogonally.

The default implementation in this class removes duplicate and collinear bends, as well as segments of zero length.

Specified by:

cleanUpEdge in interface IOrthogonalEdgeHelper

Parameters:

context - The input mode context which edited the edge.

graph - The graph to use for modifying the edge instance.

edge - The edge to clean up the path.

getSegmentOrientation

public SegmentOrientation getSegmentOrientation(IInputModeContext context,
                                                IEdge edge,
                                                int segmentIndex)

Gets the orientation of the given segment by looking at the geometry of the segment.

If the segment has a zero length, the adjacent segments will be inspected to infer the orientation such that the orientation toggles between SegmentOrientation.VERTICAL and SegmentOrientation.HORIZONTAL.

Specified by:

getSegmentOrientation in interface IOrthogonalEdgeHelper

Parameters:

context - The input mode context in which the orientation is needed.

edge - The edge to inspect.

segmentIndex - The index of the segment.

Returns:

The declared orientation of the segment.

shouldEditOrthogonally

public boolean shouldEditOrthogonally(IInputModeContext context,
                                      IEdge edge)

Determines whether the provided edge should be edited orthogonally in the specified input mode context.

If this method returns false, the other methods will not be queried at all.

The default implementation in this class always returns true.

Specified by:

shouldEditOrthogonally in interface IOrthogonalEdgeHelper

Parameters:

context - The input mode context in which the edge is about to be edited.

edge - The edge to inspect.

Returns:

true if the edge should be orthogonally edited in the specified input mode context; false otherwise.

shouldMoveEndImplicitly

public boolean shouldMoveEndImplicitly(IInputModeContext context,
                                       IEdge edge,
                                       boolean sourceEnd)

Determines whether this end of the provided edge can be moved in the input mode context.

This information is required to determine whether an edge's first or last segment needs to be split or the adjacent edge end can be moved along with the other end of the segment.

The default implementation in this class always returns false.

Specified by:

shouldMoveEndImplicitly in interface IOrthogonalEdgeHelper

Parameters:

context - The input mode context in which the segment is edited.

edge - The edge to inspect.

sourceEnd - if set to true the source end of the edge is queried, otherwise the target end.

Returns:

true if the end of the edge can be moved for the specified input mode context; false otherwise, in which case the corresponding segment needs to be split to keep the segment orientation orthogonal.