com.yworks.yfiles.view.input

Class GraphSnapContext

java.lang.Object

com.yworks.yfiles.view.input.SnapContext

com.yworks.yfiles.view.input.GraphSnapContext

public class GraphSnapContext
extends SnapContext

Concrete SnapContext implementation which handles snapping movement for IGraph items.

This class provides a set of properties that determine the way snapping operations are being performed in the context of IGraphs. IPositionHandler implementations and the like can use the following idiom to retrieve instances of this class:

See Also:

GraphEditorInputMode, GraphEditorInputMode.getSnapContext()

Constructor Summary

Constructors

Constructor and Description
GraphSnapContext() Creates a new instance with default settings.

Method Summary

Modifier and Type	Method and Description
void	addBendToBeMoved(MovementInfo info) Adds MovementInfo representing an IBend that will be considered for the next drag gesture.
void	addCollectSnapLinesListener(IEventHandler<CollectGraphSnapLinesEventArgs> collectSnapLinesEvent) Adds the given listener for the CollectSnapLines event that occurs every time this instance has been initialized to collect OrthogonalSnapLines.
void	addEdgeEndToBeMoved(MovementInfo info, boolean sourceEnd) Adds MovementInfo representing the end of an IEdge that will be considered for the next drag gesture.
void	addItemToBeReshaped(IModelItem item) Adds an item which will be reshaped.
void	addNodeToBeMoved(MovementInfo info) Adds MovementInfo representing an INode that will be considered for the next drag gesture.
void	addOrthogonalSegment(MovementInfo start, MovementInfo end) Adds an orthogonally moved segment to this context for which this instance will automatically collect SnapResults and provide a default visualization.
void	addPortToBeMoved(MovementInfo info) Adds MovementInfo representing an IPort that will be considered for the next drag gesture.
void	addSameHeightEntry(RectD rectangle) Adds an entry for the same-height-snapping.
void	addSameWidthEntry(RectD rectangle) Adds an entry for the same-width-snapping.
protected void	cleanUp() Disposes of all previously temporarily collected state and clears the SnapResults collection.
protected void	collectFixedNodeSnapLines(CollectGraphSnapLinesEventArgs args) Collects the OrthogonalSnapLines for the nodes which are not moving.
protected void	collectFixedPortSnapLines(CollectGraphSnapLinesEventArgs args) Collects the OrthogonalSnapLines for the ports which are not moving.
protected void	collectFixedSegmentSnapLines(CollectGraphSnapLinesEventArgs args) Collects snap lines for edge segments.
protected void	collectSameSizeEntries() Collects all node widths and heights in the collections findSameWidthEntries(double, double, double) and findSameHeightEntries(double, double, double).
protected void	collectVisibleNodePairs() Finds pairs of nodes that are visually adjacent to create center and same distance snap lines.
void	dragInitialized() Collects a list of snap lines.
IListEnumerable<RectD>	findSameHeightEntries(double size, double maxSize, double minSize) Finds the entries (RectDs) that have been registered using the addSameHeightEntry(RectD) previously that best match the given constraints.
IListEnumerable<RectD>	findSameWidthEntries(double size, double maxSize, double minSize) Finds the entries (RectDs) that have been registered using the addSameWidthEntry(RectD) previously that best match the given constraints.
IEnumerable<OrthogonalSnapLine>	getAdditionalSnapLines() The collection of additional OrthogonalSnapLines.
IEnumerable<OrthogonalSnapLine>	getAdditionalSnapLines(SnapLineOrientation orientation, SnapLineSnapTypes snapType, RectD area) Gets a subset of AdditionalSnapLines that matches the given orientation, snapType and intersects with the provided area.
IGridConstraintProvider<IBend>	getBendGridConstraintProvider() Gets the grid constraint provider for the IBends.
double	getEdgeToEdgeDistance() Gets the preferred distance between edges.
protected Collection<INode>	getFixedNodes() Gets the nodes that stay fixed for the current edit.
IEnumerable<OrthogonalSnapLine>	getFixedNodeSnapLines() The collection of OrthogonalSnapLines for fixed nodes.
IEnumerable<OrthogonalSnapLine>	getFixedNodeSnapLines(SnapLineOrientation orientation, SnapLineSnapTypes snapType, RectD area) Gets a subset of FixedNodeSnapLines that matches the given orientation, snapType and intersects with the provided area.
IEnumerable<OrthogonalSnapLine>	getFixedPortSnapLines() The collection of OrthogonalSnapLines to which ports should be snapping.
IEnumerable<OrthogonalSnapLine>	getFixedPortSnapLines(SnapLineOrientation orientation, SnapLineSnapTypes snapType, RectD area) Gets a subset of FixedPortSnapLines that matches the given orientation, snapType and intersects with the provided area.
IEnumerable<OrthogonalSnapLine>	getFixedSegmentSnapLines() The collection of OrthogonalSnapLines for fixed segments.
IEnumerable<OrthogonalSnapLine>	getFixedSegmentSnapLines(SnapLineOrientation orientation, SnapLineSnapTypes snapType, RectD area) Gets a subset of FixedSegmentSnapLines that matches the given orientation, snapType and intersects with the provided area.
double	getGridSnapDistance() Gets the GridSnapDistance.
GridSnapTypes	getGridSnapType() Gets the type of the grid snapping that should be performed.
MovementInfo	getMovementInfo(IBend bend) Gets the movement info for the given bend.
MovementInfo	getMovementInfo(INode node) Gets the movement info for the given node.
MovementInfo	getMovementInfo(IPort port) Gets the movement info for the given port.
IListEnumerable<MovementInfo>	getMovementInfos(IEdge edge) Gets the movement information for the provided edge.
IGridConstraintProvider<INode>	getNodeGridConstraintProvider() Gets the grid constraint provider for the INodes.
double	getNodeToEdgeDistance() The preferred distance between node borders and edge segments.
double	getNodeToNodeDistance() The preferred distance between node borders.
IGridConstraintProvider<IPort>	getPortGridConstraintProvider() Gets the grid constraint provider for the IPorts.
double	getSnapLineExtension() Gets the amount by which snap lines that are induced by existing edge segments and node borders are being extended.
void	initializeDrag(IInputModeContext context, PointD originalLocation) Called by IInputMode implementations when an interactive drag is started.
boolean	isCollectingEdgeSnapLinesEnabled() Determines whether this instance should collect fixed snap lines for edge segments.
boolean	isCollectingNodePairCenterSnapLinesEnabled() Determines whether this instance will try to align the centers of adjacent nodes so that their centers are equally far away from each other.
boolean	isCollectingNodePairSegmentSnapLinesEnabled() Gets a value indicating whether this instance will collect pairs of adjacent nodes and add snapping logic so that moved edge segments will snap so that the distances to the adjacent nodes are equal.
boolean	isCollectingNodePairSnapLinesEnabled() Gets a value indicating whether this instance will collect pairs of adjacent nodes and add snapping logic so that moved nodes will snap so that the distances to the adjacent nodes are equal.
boolean	isCollectingNodeSizesEnabled() Determines whether this instance should collect the sizes of fixed nodes.
boolean	isCollectingNodeSnapLinesEnabled() Determines whether this instance should collect fixed snap lines for nodes.
boolean	isCollectingPortSnapLinesEnabled() Determines whether this instance should collect fixed snap lines for ports.
boolean	isSnapLineCroppingEnabled() Gets a value indicating whether to crop the snap lines at obstacles.
boolean	isSnappingBendAdjacentSegmentsEnabled() Whether this context will automatically snap the movements of bends so that the two adjacent segments become horizontally or vertically oriented.
boolean	isSnappingBendsToSnapLinesEnabled() Whether this context will automatically snap the bends to snap lines.
boolean	isSnappingNodesToSnapLinesEnabled() Whether INodeSnapResultProvider implementations should snap nodes to snap lines.
boolean	isSnappingOrthogonalMovementEnabled() Determines whether this context will automatically snap the movement in such a way that the overall move gesture is constrained to the horizontal or vertical axis.
boolean	isSnappingPortAdjacentSegmentsEnabled() Whether this context will automatically snap the movements of nodes so that the first and last segments of edges become orthogonal.
boolean	isSnappingSegmentsToSnapLinesEnabled() Determines whether this context will automatically snap orthogonal edge segments to snap lines.
protected void	onCollectSnapLines(CollectGraphSnapLinesEventArgs args) Raises the CollectSnapLines event.
void	removeCollectSnapLinesListener(IEventHandler<CollectGraphSnapLinesEventArgs> collectSnapLinesEvent) Removes the given listener for the CollectSnapLines event that occurs every time this instance has been initialized to collect OrthogonalSnapLines.
void	setBendGridConstraintProvider(IGridConstraintProvider<IBend> value) Sets the grid constraint provider for the IBends.
void	setCollectingEdgeSnapLinesEnabled(boolean value) Determines whether this instance should collect fixed snap lines for edge segments.
void	setCollectingNodePairCenterSnapLinesEnabled(boolean value) Determines whether this instance will try to align the centers of adjacent nodes so that their centers are equally far away from each other.
void	setCollectingNodePairSegmentSnapLinesEnabled(boolean value) Sets a value indicating whether this instance will collect pairs of adjacent nodes and add snapping logic so that moved edge segments will snap so that the distances to the adjacent nodes are equal.
void	setCollectingNodePairSnapLinesEnabled(boolean value) Sets a value indicating whether this instance will collect pairs of adjacent nodes and add snapping logic so that moved nodes will snap so that the distances to the adjacent nodes are equal.
void	setCollectingNodeSizesEnabled(boolean value) Determines whether this instance should collect the sizes of fixed nodes.
void	setCollectingNodeSnapLinesEnabled(boolean value) Determines whether this instance should collect fixed snap lines for nodes.
void	setCollectingPortSnapLinesEnabled(boolean value) Determines whether this instance should collect fixed snap lines for ports.
void	setEdgeToEdgeDistance(double value) Sets the preferred distance between edges.
void	setGridSnapDistance(double value) Sets the GridSnapDistance.
void	setGridSnapType(GridSnapTypes value) Sets the type of the grid snapping that should be performed.
void	setNodeGridConstraintProvider(IGridConstraintProvider<INode> value) Sets the grid constraint provider for the INodes.
void	setNodeToEdgeDistance(double value) The preferred distance between node borders and edge segments.
void	setNodeToNodeDistance(double value) The preferred distance between node borders.
void	setPortGridConstraintProvider(IGridConstraintProvider<IPort> value) Sets the grid constraint provider for the IPorts.
void	setSnapLineCroppingEnabled(boolean value) Sets a value indicating whether to crop the snap lines at obstacles.
void	setSnapLineExtension(double value) Sets the amount by which snap lines that are induced by existing edge segments and node borders are being extended.
void	setSnappingBendAdjacentSegmentsEnabled(boolean value) Whether this context will automatically snap the movements of bends so that the two adjacent segments become horizontally or vertically oriented.
void	setSnappingBendsToSnapLinesEnabled(boolean value) Whether this context will automatically snap the bends to snap lines.
void	setSnappingNodesToSnapLinesEnabled(boolean value) Whether INodeSnapResultProvider implementations should snap nodes to snap lines.
void	setSnappingOrthogonalMovementEnabled(boolean value) Determines whether this context will automatically snap the movement in such a way that the overall move gesture is constrained to the horizontal or vertical axis.
void	setSnappingPortAdjacentSegmentsEnabled(boolean value) Whether this context will automatically snap the movements of nodes so that the first and last segments of edges become orthogonal.
void	setSnappingSegmentsToSnapLinesEnabled(boolean value) Determines whether this context will automatically snap orthogonal edge segments to snap lines.
IInputModeContext	wrapContext(IInputModeContext context) Helper method that wraps the given context so that a ILookup.lookup(Class) query on the wrapped context for the SnapContext type yields this instance.

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

addCleanedUpListener, addCollectSnapResultsListener, addInitializedListener, addInitializingListener, cancelDrag, createSnapResultCanvasObjectDescriptor, createSnapResultsModelManager, dragFinished, dragged, getCurrentInputModeContext, getOriginalLocation, getSnapDistance, getSnapResults, handleMove, isEnabled, isInitialized, isInitializing, isSnapResultVisualizationEnabled, onCleanUp, onCollectSnapResults, onInitialized, onInitializing, processSnapResults, removeCleanedUpListener, removeCollectSnapResultsListener, removeInitializedListener, removeInitializingListener, setEnabled, setSnapDistance, setSnapResultVisualizationEnabled

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphSnapContext

public GraphSnapContext()

Creates a new instance with default settings.

Method Detail

addBendToBeMoved

public void addBendToBeMoved(MovementInfo info)

Adds MovementInfo representing an IBend that will be considered for the next drag gesture.

The default IHandle of an IBend calls this method in its IDragHandler.initializeDrag(IInputModeContext) method so snap results are calculated when this bend is repositioned. Custom IHandle implementations can add infos created by getMovementInfo(IBend).

Parameters:

info - The MovementInfo representing the bend to be moved. Can be created with getMovementInfo(IBend).

addCollectSnapLinesListener

public final void addCollectSnapLinesListener(IEventHandler<CollectGraphSnapLinesEventArgs> collectSnapLinesEvent)

Adds the given listener for the CollectSnapLines event that occurs every time this instance has been initialized to collect OrthogonalSnapLines.

Event handlers should add snap lines to the caller using the methods provided by CollectGraphSnapLinesEventArgs.

Parameters:

collectSnapLinesEvent - The listener to add.

See Also:

removeCollectSnapLinesListener(IEventHandler)

addEdgeEndToBeMoved

public void addEdgeEndToBeMoved(MovementInfo info,
                                boolean sourceEnd)

Adds MovementInfo representing the end of an IEdge that will be considered for the next drag gesture.

The IHandle returned by the default IEdgePortHandleProvider of an IEdge calls this method in its IDragHandler.initializeDrag(IInputModeContext) method so snap results are calculated when reparenting this edge end. Custom IHandle implementations can call getMovementInfos(IEdge) and add the first or last MovementInfo of the returned list.

Parameters:

info - The MovementInfo representing the edge end to be reparented. Can be created with getMovementInfos(IEdge).

sourceEnd - true if the info represents the source end of the edge.

addItemToBeReshaped

public void addItemToBeReshaped(IModelItem item)

Adds an item which will be reshaped.

Parameters:

item - The item to be reshaped.

addNodeToBeMoved

public void addNodeToBeMoved(MovementInfo info)

Adds MovementInfo representing an INode that will be considered for the next drag gesture.

The default IPositionHandler of an INode calls this method in its IDragHandler.initializeDrag(IInputModeContext) method so snap results are calculated when this node is repositioned. Custom IPositionHandler implementations can add infos created by getMovementInfo(INode).

Parameters:

info - The MovementInfo representing the node to be moved. Can be created with getMovementInfo(INode).

addOrthogonalSegment

public void addOrthogonalSegment(MovementInfo start,
                                 MovementInfo end)

Adds an orthogonally moved segment to this context for which this instance will automatically collect SnapResults and provide a default visualization.

This method can be called during initialization to collect orthogonal segments that should be tested against FixedSegmentSnapLines and AdditionalSnapLines.

Parameters:

start - The starting point of the manipulated segment.

end - The end point of the manipulated segment.

addPortToBeMoved

public void addPortToBeMoved(MovementInfo info)

Adds MovementInfo representing an IPort that will be considered for the next drag gesture.

The default IHandle of an IPort calls this method in its IDragHandler.initializeDrag(IInputModeContext) method so snap results are calculated for this port. Custom IHandle implementations can add infos created by getMovementInfo(IPort).

Parameters:

info - The MovementInfo representing the port to be moved. Can be created with getMovementInfo(IPort).

addSameHeightEntry

public void addSameHeightEntry(RectD rectangle)

Adds an entry for the same-height-snapping.

During initialization this method can be used to register entries that can later be retrieved using the findSameHeightEntries(double, double, double) method. The rectangle will be used to obtain the height value and will also be used for the visualization of the snap result.

Parameters:

rectangle - The rectangle to obtain the height value from. This rectangle will be used for the snap result visualization.

See Also:

addSameWidthEntry(RectD)

addSameWidthEntry

public void addSameWidthEntry(RectD rectangle)

Adds an entry for the same-width-snapping.

During initialization this method can be used to register entries that can later be retrieved using the findSameWidthEntries(double, double, double) method. The rectangle will be used to obtain the width value and will also be used for the visualization of the snap result.

Parameters:

rectangle - The rectangle to obtain the width value from. This rectangle will be used for the snap result visualization.

See Also:

addSameHeightEntry(RectD)

cleanUp

protected void cleanUp()

Disposes of all previously temporarily collected state and clears the SnapResults collection.

Subclasses should make sure to call the base implementation as their last operation.

Overrides:

cleanUp in class SnapContext

collectFixedNodeSnapLines

protected void collectFixedNodeSnapLines(CollectGraphSnapLinesEventArgs args)

Collects the OrthogonalSnapLines for the nodes which are not moving.

Delegates to the ISnapLineProvider implementation in the lookup of the INode.

collectFixedPortSnapLines

protected void collectFixedPortSnapLines(CollectGraphSnapLinesEventArgs args)

Collects the OrthogonalSnapLines for the ports which are not moving.

Delegates to the ISnapLineProvider implementation in the lookup of the IPort.

collectFixedSegmentSnapLines

protected void collectFixedSegmentSnapLines(CollectGraphSnapLinesEventArgs args)

Collects snap lines for edge segments.

Delegates to the ISnapLineProvider implementation in the lookup of the IEdge. This implementation should then make us of getMovementInfos(IEdge) to determine what segments are fixed.

collectSameSizeEntries

protected void collectSameSizeEntries()

Collects all node widths and heights in the collections findSameWidthEntries(double, double, double) and findSameHeightEntries(double, double, double).

This method will only be called if CollectingNodeSizesEnabled is enabled and delegates to addSameHeightEntry(RectD) and addSameWidthEntry(RectD).

collectVisibleNodePairs

protected void collectVisibleNodePairs()

Finds pairs of nodes that are visually adjacent to create center and same distance snap lines.

dragInitialized

public void dragInitialized()

Collects a list of snap lines.

This method has been overridden to collect the snap lines for all fixed graph elements and crop them after collection.

Overrides:

dragInitialized in class SnapContext

See Also:

onCollectSnapLines(CollectGraphSnapLinesEventArgs), isSnapLineCroppingEnabled()

findSameHeightEntries

public IListEnumerable<RectD> findSameHeightEntries(double size,
                                                    double maxSize,
                                                    double minSize)

Finds the entries (RectDs) that have been registered using the addSameHeightEntry(RectD) previously that best match the given constraints.

Parameters:

size - The size to find the closest set of identical sizes.

maxSize - The maximum allowed size.

minSize - The minimum allowed size.

Returns:

The set of rectangles that have been added previously using addSameHeightEntry(RectD).

findSameWidthEntries

public IListEnumerable<RectD> findSameWidthEntries(double size,
                                                   double maxSize,
                                                   double minSize)

Finds the entries (RectDs) that have been registered using the addSameWidthEntry(RectD) previously that best match the given constraints.

Parameters:

size - The size to find the closest set of identical sizes.

maxSize - The maximum allowed size.

minSize - The minimum allowed size.

Returns:

The set of rectangles that have been added previously using addSameWidthEntry(RectD).

getAdditionalSnapLines

public final IEnumerable<OrthogonalSnapLine> getAdditionalSnapLines()

The collection of additional OrthogonalSnapLines.

This collection is only available if IsInitialized is true.

Returns:

The AdditionalSnapLines.

See Also:

getAdditionalSnapLines(SnapLineOrientation, SnapLineSnapTypes, RectD)

getAdditionalSnapLines

public final IEnumerable<OrthogonalSnapLine> getAdditionalSnapLines(SnapLineOrientation orientation,
                                                                    SnapLineSnapTypes snapType,
                                                                    RectD area)

Gets a subset of AdditionalSnapLines that matches the given orientation, snapType and intersects with the provided area.

Parameters:

orientation - The orientation of the lines to return.

snapType - The snap type to be included.

area - The area to test for intersection.

Returns:

An enumerable of the snap lines that match the provided criteria.

getBendGridConstraintProvider

public final IGridConstraintProvider<IBend> getBendGridConstraintProvider()

Gets the grid constraint provider for the IBends.

Returns:

The bend grid constraint provider, or null if none is set.

See Also:

setBendGridConstraintProvider(IGridConstraintProvider)

getEdgeToEdgeDistance

public final double getEdgeToEdgeDistance()

Gets the preferred distance between edges.

This will influence the creation of the segment snap lines. For each orthogonally oriented fixed segment there will be snap lines on the segment itself and to both sides of the segment at the specified distance.

The default is 0.0d which disables parallel snap lines.

Returns:

The EdgeToEdgeDistance.

See Also:

setEdgeToEdgeDistance(double)

getFixedNodes

protected final Collection<INode> getFixedNodes()

Gets the nodes that stay fixed for the current edit.

Returns:

The fixed nodes.

getFixedNodeSnapLines

public final IEnumerable<OrthogonalSnapLine> getFixedNodeSnapLines()

The collection of OrthogonalSnapLines for fixed nodes.

This collection is only available if IsInitialized is true.

Returns:

The FixedNodeSnapLines.

See Also:

getFixedNodeSnapLines(SnapLineOrientation, SnapLineSnapTypes, RectD)

getFixedNodeSnapLines

public final IEnumerable<OrthogonalSnapLine> getFixedNodeSnapLines(SnapLineOrientation orientation,
                                                                   SnapLineSnapTypes snapType,
                                                                   RectD area)

Gets a subset of FixedNodeSnapLines that matches the given orientation, snapType and intersects with the provided area.

Parameters:

orientation - The orientation of the lines to return.

snapType - The snap type to be included.

area - The area to test for intersection.

Returns:

An enumerable of the snap lines that match the provided criteria.

getFixedPortSnapLines

public final IEnumerable<OrthogonalSnapLine> getFixedPortSnapLines()

The collection of OrthogonalSnapLines to which ports should be snapping.

This collection is only available if IsInitialized is true.

Returns:

The FixedPortSnapLines.

See Also:

getFixedPortSnapLines(SnapLineOrientation, SnapLineSnapTypes, RectD)

getFixedPortSnapLines

public final IEnumerable<OrthogonalSnapLine> getFixedPortSnapLines(SnapLineOrientation orientation,
                                                                   SnapLineSnapTypes snapType,
                                                                   RectD area)

Gets a subset of FixedPortSnapLines that matches the given orientation, snapType and intersects with the provided area.

Parameters:

orientation - The orientation of the lines to return.

snapType - The snap type to be included.

area - The area to test for intersection.

Returns:

An enumerable of the snap lines that match the provided criteria.

getFixedSegmentSnapLines

public final IEnumerable<OrthogonalSnapLine> getFixedSegmentSnapLines()

The collection of OrthogonalSnapLines for fixed segments.

This collection is only available if IsInitialized is true.

Returns:

The FixedSegmentSnapLines.

See Also:

getFixedSegmentSnapLines(SnapLineOrientation, SnapLineSnapTypes, RectD)

getFixedSegmentSnapLines

public final IEnumerable<OrthogonalSnapLine> getFixedSegmentSnapLines(SnapLineOrientation orientation,
                                                                      SnapLineSnapTypes snapType,
                                                                      RectD area)

Gets a subset of FixedSegmentSnapLines that matches the given orientation, snapType and intersects with the provided area.

Parameters:

orientation - The orientation of the lines to return.

snapType - The snap type to be included.

area - The area to test for intersection.

Returns:

An enumerable of the snap lines that match the provided criteria.

getGridSnapDistance

public final double getGridSnapDistance()

Gets the GridSnapDistance.

The maximum distance between the current mouse coordinates and the coordinates to which the mouse will snap. The distance is interpreted in view coordinates.

Returns:

The GridSnapDistance.

See Also:

setGridSnapDistance(double)

getGridSnapType

public final GridSnapTypes getGridSnapType()

Gets the type of the grid snapping that should be performed.

Determines which grid elements an object should snap to.

Returns:

The GridSnapType.

See Also:

getNodeGridConstraintProvider(), getBendGridConstraintProvider(), getPortGridConstraintProvider(), setGridSnapType(GridSnapTypes)

getMovementInfo

public MovementInfo getMovementInfo(IBend bend)

Gets the movement info for the given bend.

This is either the info passed to addBendToBeMoved(MovementInfo) or a dynamically created instance if no specific one had been registered.

Parameters:

bend - The bend to obtain the info for.

Returns:

An instance of MovementInfo that describes the movement of the bend.

getMovementInfo

public MovementInfo getMovementInfo(INode node)

Gets the movement info for the given node.

This is either the info passed to addNodeToBeMoved(MovementInfo) or another, dynamically created instance, if no specific one had been registered.

Parameters:

node - The node to obtain the info for.

Returns:

An instance of MovementInfo that describes the movement of the node.

getMovementInfo

public MovementInfo getMovementInfo(IPort port)

Gets the movement info for the given port.

This is either the info passed to addNodeToBeMoved(MovementInfo) or another, dynamically created instance, if no specific one had been registered.

Parameters:

port - The port to obtain the info for.

Returns:

An instance of MovementInfo that describes the movement of the port.

getMovementInfos

public IListEnumerable<MovementInfo> getMovementInfos(IEdge edge)

Gets the movement information for the provided edge.

The result describes the shape of the edge and the reshaping behavior of the geometry. The first element in the enumerable is the source end of the edge, followed by bend like elements and the target side. Note that it cannot in general be assumed MovedItem of the first and last element is either a IPort or IEdge, also items in between may not necessarily be bound to IBends and therefore their MovedItem can be of a different type than IBend.

Parameters:

edge - The edge to obtain the movement information of.

Returns:

An IListEnumerable of MovementInfos items that describe the geometry of the edge being modified.

getNodeGridConstraintProvider

public final IGridConstraintProvider<INode> getNodeGridConstraintProvider()

Gets the grid constraint provider for the INodes.

Returns:

The node grid constraint provider, or null if none is set.

See Also:

setNodeGridConstraintProvider(IGridConstraintProvider)

getNodeToEdgeDistance

public final double getNodeToEdgeDistance()

The preferred distance between node borders and edge segments. T

This will influence the creation of the node snap lines. For each fixed node there will be snap lines on the borders of the node itself and around the node at the specified distance to which orthogonal edge segments can snap.

The default is -1.0d which disables distant snap lines around the nodes for edge segments.

Returns:

The NodeToEdgeDistance.

See Also:

setNodeToEdgeDistance(double)

getNodeToNodeDistance

public final double getNodeToNodeDistance()

The preferred distance between node borders.

This will influence the creation of the node snap lines. For each fixed node there will be snap lines on the borders of the node itself and around the node at the specified distance.

The default is 0.0d which disables distant snap lines around the nodes.

Returns:

The NodeToNodeDistance.

See Also:

setNodeToNodeDistance(double)

getPortGridConstraintProvider

public final IGridConstraintProvider<IPort> getPortGridConstraintProvider()

Gets the grid constraint provider for the IPorts.

Returns:

The port grid constraint provider, or null if none is set.

See Also:

setPortGridConstraintProvider(IGridConstraintProvider)

getSnapLineExtension

public final double getSnapLineExtension()

Gets the amount by which snap lines that are induced by existing edge segments and node borders are being extended.

The default is 40.0d, this value will be used to extend the ends of the snap lines.

Returns:

The SnapLineExtension.

See Also:

setSnapLineExtension(double)

initializeDrag

public void initializeDrag(IInputModeContext context,
                           PointD originalLocation)

Called by IInputMode implementations when an interactive drag is started.

Initializes the list of nodes to be moved. Called by the wrapping position handler on initialization of a drag action.

Overrides:

initializeDrag in class SnapContext

Throws:

IllegalStateException - If this context is already initialized.

Parameters:

context - The context in which the interactive drag is started.

originalLocation - The original location of the mouse.

isCollectingEdgeSnapLinesEnabled

public final boolean isCollectingEdgeSnapLinesEnabled()

Determines whether this instance should collect fixed snap lines for edge segments.

The default is true.

Returns:

The CollectingEdgeSnapLinesEnabled.

See Also:

ISnapLineProvider, collectFixedSegmentSnapLines(CollectGraphSnapLinesEventArgs), setCollectingEdgeSnapLinesEnabled(boolean)

isCollectingNodePairCenterSnapLinesEnabled

public final boolean isCollectingNodePairCenterSnapLinesEnabled()

Determines whether this instance will try to align the centers of adjacent nodes so that their centers are equally far away from each other.

Note that this will only make a difference for differently sized nodes.

By default this feature is turned off, so that the instance will try to distribute nodes evenly, so that there is the same spacing between their borders, not between their centers.

Returns:

The CollectingNodePairCenterSnapLinesEnabled.

See Also:

setCollectingNodePairCenterSnapLinesEnabled(boolean)

isCollectingNodePairSegmentSnapLinesEnabled

public final boolean isCollectingNodePairSegmentSnapLinesEnabled()

Gets a value indicating whether this instance will collect pairs of adjacent nodes and add snapping logic so that moved edge segments will snap so that the distances to the adjacent nodes are equal.

Returns:

true if pairs of nodes should be collected for additional edge snap lines; false otherwise. The default is true

See Also:

setCollectingNodePairSegmentSnapLinesEnabled(boolean)

isCollectingNodePairSnapLinesEnabled

public final boolean isCollectingNodePairSnapLinesEnabled()

Gets a value indicating whether this instance will collect pairs of adjacent nodes and add snapping logic so that moved nodes will snap so that the distances to the adjacent nodes are equal.

Returns:

true if pairs of nodes should be collected for additional snap lines; false otherwise. The default is true

See Also:

setCollectingNodePairSnapLinesEnabled(boolean)

isCollectingNodeSizesEnabled

public final boolean isCollectingNodeSizesEnabled()

Determines whether this instance should collect the sizes of fixed nodes.

The default is true.

Returns:

The CollectingNodeSizesEnabled.

See Also:

collectSameSizeEntries(), setCollectingNodeSizesEnabled(boolean)

isCollectingNodeSnapLinesEnabled

public final boolean isCollectingNodeSnapLinesEnabled()

Determines whether this instance should collect fixed snap lines for nodes.

The default is true.

Returns:

The CollectingNodeSnapLinesEnabled.

See Also:

ISnapLineProvider, collectFixedNodeSnapLines(CollectGraphSnapLinesEventArgs), setCollectingNodeSnapLinesEnabled(boolean)

isCollectingPortSnapLinesEnabled

public final boolean isCollectingPortSnapLinesEnabled()

Determines whether this instance should collect fixed snap lines for ports.

The default is true.

Returns:

The CollectingPortSnapLinesEnabled.

See Also:

ISnapLineProvider, collectFixedPortSnapLines(CollectGraphSnapLinesEventArgs), setCollectingPortSnapLinesEnabled(boolean)

isSnapLineCroppingEnabled

public final boolean isSnapLineCroppingEnabled()

Gets a value indicating whether to crop the snap lines at obstacles.

The default is true

Returns:

The SnapLineCroppingEnabled.

See Also:

setSnapLineCroppingEnabled(boolean)

isSnappingBendAdjacentSegmentsEnabled

public final boolean isSnappingBendAdjacentSegmentsEnabled()

Whether this context will automatically snap the movements of bends so that the two adjacent segments become horizontally or vertically oriented.

The default is true.

Returns:

The SnappingBendAdjacentSegmentsEnabled.

See Also:

setSnappingBendAdjacentSegmentsEnabled(boolean)

isSnappingBendsToSnapLinesEnabled

public final boolean isSnappingBendsToSnapLinesEnabled()

Whether this context will automatically snap the bends to snap lines.

The default is false.

Returns:

The SnappingBendsToSnapLinesEnabled.

See Also:

setSnappingBendsToSnapLinesEnabled(boolean)

isSnappingNodesToSnapLinesEnabled

public final boolean isSnappingNodesToSnapLinesEnabled()

Whether INodeSnapResultProvider implementations should snap nodes to snap lines.

The default is true.

Returns:

The SnappingNodesToSnapLinesEnabled.

See Also:

setSnappingNodesToSnapLinesEnabled(boolean)

isSnappingOrthogonalMovementEnabled

public final boolean isSnappingOrthogonalMovementEnabled()

Determines whether this context will automatically snap the movement in such a way that the overall move gesture is constrained to the horizontal or vertical axis.

The default is false.

Returns:

The SnappingOrthogonalMovementEnabled.

See Also:

setSnappingOrthogonalMovementEnabled(boolean)

isSnappingPortAdjacentSegmentsEnabled

public final boolean isSnappingPortAdjacentSegmentsEnabled()

Whether this context will automatically snap the movements of nodes so that the first and last segments of edges become orthogonal.

The default is true.

Returns:

The SnappingPortAdjacentSegmentsEnabled.

See Also:

setSnappingPortAdjacentSegmentsEnabled(boolean)

isSnappingSegmentsToSnapLinesEnabled

public final boolean isSnappingSegmentsToSnapLinesEnabled()

Determines whether this context will automatically snap orthogonal edge segments to snap lines.

The default is true.

Returns:

The SnappingSegmentsToSnapLinesEnabled.

See Also:

setSnappingSegmentsToSnapLinesEnabled(boolean)

onCollectSnapLines

protected void onCollectSnapLines(CollectGraphSnapLinesEventArgs args)

Raises the CollectSnapLines event.

Parameters:

args - The CollectGraphSnapLinesEventArgs instance containing the event data.

removeCollectSnapLinesListener

public final void removeCollectSnapLinesListener(IEventHandler<CollectGraphSnapLinesEventArgs> collectSnapLinesEvent)

Removes the given listener for the CollectSnapLines event that occurs every time this instance has been initialized to collect OrthogonalSnapLines.

Event handlers should add snap lines to the caller using the methods provided by CollectGraphSnapLinesEventArgs.

Parameters:

collectSnapLinesEvent - The listener to remove.

See Also:

addCollectSnapLinesListener(IEventHandler)

setBendGridConstraintProvider

public final void setBendGridConstraintProvider(IGridConstraintProvider<IBend> value)

Sets the grid constraint provider for the IBends.

Parameters:

value - The bend grid constraint provider, or null if none is set.

See Also:

getBendGridConstraintProvider()

setCollectingEdgeSnapLinesEnabled

public final void setCollectingEdgeSnapLinesEnabled(boolean value)

Determines whether this instance should collect fixed snap lines for edge segments.

The default is true.

Parameters:

value - The CollectingEdgeSnapLinesEnabled to set.

See Also:

ISnapLineProvider, collectFixedSegmentSnapLines(CollectGraphSnapLinesEventArgs), isCollectingEdgeSnapLinesEnabled()

setCollectingNodePairCenterSnapLinesEnabled

public final void setCollectingNodePairCenterSnapLinesEnabled(boolean value)

Determines whether this instance will try to align the centers of adjacent nodes so that their centers are equally far away from each other.

Note that this will only make a difference for differently sized nodes.

By default this feature is turned off, so that the instance will try to distribute nodes evenly, so that there is the same spacing between their borders, not between their centers.

Parameters:

value - The CollectingNodePairCenterSnapLinesEnabled to set.

See Also:

isCollectingNodePairCenterSnapLinesEnabled()

setCollectingNodePairSegmentSnapLinesEnabled

public final void setCollectingNodePairSegmentSnapLinesEnabled(boolean value)

Sets a value indicating whether this instance will collect pairs of adjacent nodes and add snapping logic so that moved edge segments will snap so that the distances to the adjacent nodes are equal.

Parameters:

value - true if pairs of nodes should be collected for additional edge snap lines; false otherwise. The default is true

See Also:

isCollectingNodePairSegmentSnapLinesEnabled()

setCollectingNodePairSnapLinesEnabled

public final void setCollectingNodePairSnapLinesEnabled(boolean value)

Sets a value indicating whether this instance will collect pairs of adjacent nodes and add snapping logic so that moved nodes will snap so that the distances to the adjacent nodes are equal.

Parameters:

value - true if pairs of nodes should be collected for additional snap lines; false otherwise. The default is true

See Also:

isCollectingNodePairSnapLinesEnabled()

setCollectingNodeSizesEnabled

public final void setCollectingNodeSizesEnabled(boolean value)

Determines whether this instance should collect the sizes of fixed nodes.

The default is true.

Parameters:

value - The CollectingNodeSizesEnabled to set.

See Also:

collectSameSizeEntries(), isCollectingNodeSizesEnabled()

setCollectingNodeSnapLinesEnabled

public final void setCollectingNodeSnapLinesEnabled(boolean value)

Determines whether this instance should collect fixed snap lines for nodes.

The default is true.

Parameters:

value - The CollectingNodeSnapLinesEnabled to set.

See Also:

ISnapLineProvider, collectFixedNodeSnapLines(CollectGraphSnapLinesEventArgs), isCollectingNodeSnapLinesEnabled()

setCollectingPortSnapLinesEnabled

public final void setCollectingPortSnapLinesEnabled(boolean value)

Determines whether this instance should collect fixed snap lines for ports.

The default is true.

Parameters:

value - The CollectingPortSnapLinesEnabled to set.

See Also:

ISnapLineProvider, collectFixedPortSnapLines(CollectGraphSnapLinesEventArgs), isCollectingPortSnapLinesEnabled()

setEdgeToEdgeDistance

public final void setEdgeToEdgeDistance(double value)

Sets the preferred distance between edges.

This will influence the creation of the segment snap lines. For each orthogonally oriented fixed segment there will be snap lines on the segment itself and to both sides of the segment at the specified distance.

The default is 0.0d which disables parallel snap lines.

Parameters:

value - The EdgeToEdgeDistance to set.

See Also:

getEdgeToEdgeDistance()

setGridSnapDistance

public final void setGridSnapDistance(double value)

Sets the GridSnapDistance.

The maximum distance between the current mouse coordinates and the coordinates to which the mouse will snap. The distance is interpreted in view coordinates.

Parameters:

value - The GridSnapDistance to set.

See Also:

getGridSnapDistance()

setGridSnapType

public final void setGridSnapType(GridSnapTypes value)

Sets the type of the grid snapping that should be performed.

Determines which grid elements an object should snap to.

Parameters:

value - The GridSnapType to set.

See Also:

getNodeGridConstraintProvider(), getBendGridConstraintProvider(), getPortGridConstraintProvider(), getGridSnapType()

setNodeGridConstraintProvider

public final void setNodeGridConstraintProvider(IGridConstraintProvider<INode> value)

Sets the grid constraint provider for the INodes.

Parameters:

value - The node grid constraint provider, or null if none is set.

See Also:

getNodeGridConstraintProvider()

setNodeToEdgeDistance

public final void setNodeToEdgeDistance(double value)

The preferred distance between node borders and edge segments. T

This will influence the creation of the node snap lines. For each fixed node there will be snap lines on the borders of the node itself and around the node at the specified distance to which orthogonal edge segments can snap.

The default is -1.0d which disables distant snap lines around the nodes for edge segments.

Parameters:

value - The NodeToEdgeDistance to set.

See Also:

getNodeToEdgeDistance()

setNodeToNodeDistance

public final void setNodeToNodeDistance(double value)

The preferred distance between node borders.

This will influence the creation of the node snap lines. For each fixed node there will be snap lines on the borders of the node itself and around the node at the specified distance.

The default is 0.0d which disables distant snap lines around the nodes.

Parameters:

value - The NodeToNodeDistance to set.

See Also:

getNodeToNodeDistance()

setPortGridConstraintProvider

public final void setPortGridConstraintProvider(IGridConstraintProvider<IPort> value)

Sets the grid constraint provider for the IPorts.

Parameters:

value - The port grid constraint provider, or null if none is set.

See Also:

getPortGridConstraintProvider()

setSnapLineCroppingEnabled

public final void setSnapLineCroppingEnabled(boolean value)

Sets a value indicating whether to crop the snap lines at obstacles.

The default is true

Parameters:

value - The SnapLineCroppingEnabled to set.

See Also:

isSnapLineCroppingEnabled()

setSnapLineExtension

public final void setSnapLineExtension(double value)

Sets the amount by which snap lines that are induced by existing edge segments and node borders are being extended.

The default is 40.0d, this value will be used to extend the ends of the snap lines.

Parameters:

value - The SnapLineExtension to set.

See Also:

getSnapLineExtension()

setSnappingBendAdjacentSegmentsEnabled

public final void setSnappingBendAdjacentSegmentsEnabled(boolean value)

Whether this context will automatically snap the movements of bends so that the two adjacent segments become horizontally or vertically oriented.

The default is true.

Parameters:

value - The SnappingBendAdjacentSegmentsEnabled to set.

See Also:

isSnappingBendAdjacentSegmentsEnabled()

setSnappingBendsToSnapLinesEnabled

public final void setSnappingBendsToSnapLinesEnabled(boolean value)

Whether this context will automatically snap the bends to snap lines.

The default is false.

Parameters:

value - The SnappingBendsToSnapLinesEnabled to set.

See Also:

isSnappingBendsToSnapLinesEnabled()

setSnappingNodesToSnapLinesEnabled

public final void setSnappingNodesToSnapLinesEnabled(boolean value)

Whether INodeSnapResultProvider implementations should snap nodes to snap lines.

The default is true.

Parameters:

value - The SnappingNodesToSnapLinesEnabled to set.

See Also:

isSnappingNodesToSnapLinesEnabled()

setSnappingOrthogonalMovementEnabled

public final void setSnappingOrthogonalMovementEnabled(boolean value)

Determines whether this context will automatically snap the movement in such a way that the overall move gesture is constrained to the horizontal or vertical axis.

The default is false.

Parameters:

value - The SnappingOrthogonalMovementEnabled to set.

See Also:

isSnappingOrthogonalMovementEnabled()

setSnappingPortAdjacentSegmentsEnabled

public final void setSnappingPortAdjacentSegmentsEnabled(boolean value)

Whether this context will automatically snap the movements of nodes so that the first and last segments of edges become orthogonal.

The default is true.

Parameters:

value - The SnappingPortAdjacentSegmentsEnabled to set.

See Also:

isSnappingPortAdjacentSegmentsEnabled()

setSnappingSegmentsToSnapLinesEnabled

public final void setSnappingSegmentsToSnapLinesEnabled(boolean value)

Determines whether this context will automatically snap orthogonal edge segments to snap lines.

The default is true.

Parameters:

value - The SnappingSegmentsToSnapLinesEnabled to set.

See Also:

isSnappingSegmentsToSnapLinesEnabled()

wrapContext

public IInputModeContext wrapContext(IInputModeContext context)

Description copied from class: SnapContext

Helper method that wraps the given context so that a ILookup.lookup(Class) query on the wrapped context for the SnapContext type yields this instance.

Overrides:

wrapContext in class SnapContext

Parameters:

context - The context to wrap and delegate all calls to.

Returns:

A modified instance that yields this instance if it is queried for the SnapContext type.