The RelinkingTool allows the user to reconnect an existing Link if the Link#relinkableTo and/or Link#relinkableFrom properties are true.
You do not normally need to create an instance of this tool because one already exists as the ToolManager#relinkingTool, which you can modify.
Gets the Diagram that owns this tool and for which this tool is handling input events.
Gets or sets a small GraphObject that is copied as a relinking handle for the selected link path at the "from" end of the link.
Gets the GraphObject that is the tool handle being dragged by the user.
Gets or sets whether this tool is started and is actively doing something.
Gets or sets whether this tool can be started by a mouse event.
Gets or sets the name of this tool.
Gets or sets a small GraphObject that is copied as a relinking handle for the selected link path at the "to" end of the link.
Gets or sets the name of the transaction to be committed by #stopTransaction; if null, the transaction will be rolled back.
This tool can run when the diagram allows relinking, the model is modifiable, and there is a relink handle at the mouse-down point.
boolean
This is called to cancel any running "WaitAfter" timer.
any
Start the relinking operation.
any
The diagram will call this method when the user wishes to cancel the current tool's operation.
any
Finishing the linking operation stops the transaction, releases the mouse, and resets the cursor.
any
The diagram will call this method upon a key down event.
any
The diagram will call this method upon a key up event.
any
The diagram will call this method upon a mouse down event.
any
The diagram will call this method upon a mouse move event.
any
A mouse-up ends the relinking operation; if there is a valid #targetPort nearby, this modifies the old link to connect with the target port.
any
The diagram will call this method as the mouse wheel is rotated.
any
This method is called by the diagram when this tool becomes the current tool; you should not call this method.
any
This method is called by the diagram when this tool stops being the current tool; you should not call this method.
any
This is called a certain delay after a call to #standardWaitAfter if there has not been any call to #cancelWaitAfter.
any
This convenience function finds the front-most GraphObject that is at a given point and that is part of an Adornment that is of a given category.
a Point in document coordinates.
the required Part#category of the Adornment.
Return true when the last mouse point is far enough away from the first mouse down point to constitute a drag operation instead of just a potential click.
Point in view coordinates, defaults to Diagram#firstInput's InputEvent#viewPoint.
Point in view coordinates, defaults to Diagram#lastInput's InputEvent#viewPoint.
boolean
Modify an existing Link to connect to a new node and port.
the Node to connect to or from.
the GraphObject port to connect to or from.
If true, this modifies the link's "to" node and port; otherwise it modifies the "from" node and port.
boolean
Implement the standard behavior for mouse clicks, searching for and calling click handler functions on GraphObjects or on Diagram, and raising the corresponding DiagramEvent.
An optional custom navigation function to find target objects.
An optional custom predicate
any
Implement the standard behavior for mouse enter, over, and leave events, where the mouse is moving but no button is pressed.
any
Implement the standard behavior for selecting parts with the mouse, depending on the control and shift modifier keys.
any
Implement the standard behavior for mouse wheel events.
any
This is called to start a new timer to call #doWaitAfter after a given delay.
in milliseconds
any
Call Diagram#startTransaction with the given transaction name.
a description of the transaction
boolean
If the Diagram#currentTool is this tool, stop this tool and start the Diagram#defaultTool by making it be the new current tool.
any
If #transactionResult is null, call Diagram#rollbackTransaction, otherwise call Diagram#commitTransaction.
boolean
Show an Adornment for each end of the Link that the user may reconnect.
any