ToolManager$Typings extension
Properties
-
actionTool
↔ ActionTool
-
Gets or sets the mode-less ActionTool, normally one of the #mouseDownTools.
getter/setter pair
-
clickCreatingTool
↔ ClickCreatingTool
-
Gets or sets the mode-less ClickCreatingTool, normally one of the #mouseUpTools.
getter/setter pair
-
clickSelectingTool
↔ ClickSelectingTool
-
Gets or sets the mode-less ClickSelectingTool, normally one of the #mouseUpTools.
getter/setter pair
-
Gets or sets the mode-less ContextMenuTool, normally one of the #mouseUpTools.
getter/setter pair
-
currentToolTip
↔ dynamic
-
This read-only property returns the currently showing tooltip, or null if there is none.
getter/setter pair
-
draggingTool
↔ DraggingTool
-
Gets or sets the mode-less DraggingTool, normally one of the #mouseMoveTools.
getter/setter pair
-
dragSelectingTool
↔ DragSelectingTool
-
Gets or sets the mode-less DragSelectingTool, normally one of the #mouseMoveTools.
getter/setter pair
-
dragSize
↔ Size
-
Gets or sets the distance in view coordinates within which a mouse down-and-up is considered a click and beyond which a mouse movement is considered a drag.
The default value is 2 pixels horizontally and vertically for mouse events, and increases by 6 pixels for touch events.
This value is used by Tool#isBeyondDragSize.
getter/setter pair
-
gestureBehavior
↔ EnumValue
-
Gets or sets the ToolManager's touch pinching behavior.
Allowed values are ToolManager.GestureZoom and
ToolManager.GestureCancel and ToolManager.GestureNone.
The default value is ToolManager.GestureZoom.
getter/setter pair
-
holdDelay
↔ num
-
Gets or sets the time between when the mouse stops moving and a hold event,
in milliseconds.
The default value is 850 milliseconds.
getter/setter pair
-
hoverDelay
↔ num
-
Gets or sets the time between when the mouse stops moving and a hover event,
in milliseconds. This value affects the delay before GraphObject#toolTips are shown.
The default value is 850 milliseconds.
getter/setter pair
-
linkingTool
↔ LinkingTool
-
Gets or sets the mode-less LinkingTool, normally one of the #mouseMoveTools.
getter/setter pair
-
linkReshapingTool
↔ LinkReshapingTool
-
Gets or sets the mode-less LinkReshapingTool, normally one of the #mouseDownTools.
getter/setter pair
-
mouseDownTools
↔ List<Tool>
-
This read-only property returns the list of Tools that might be started upon a mouse or finger press event.
When the ToolManager handles a mouse-down or touch-down event in #doMouseDown,
it searches this list in order, starting the first tool for which
Tool#canStart returns true.
getter/setter pair
-
mouseMoveTools
↔ List<Tool>
-
This read-only property returns the list of Tools that might be started upon a mouse or finger move event.
When the ToolManager handles a mouse-move or touch-move event in #doMouseMove,
it searches this list in order, starting the first tool for which
Tool#canStart returns true.
getter/setter pair
-
mouseUpTools
↔ List<Tool>
-
This read-only property returns the list of Tools that might be started upon a mouse or finger up event.
When the ToolManager handles a mouse-up or touch-up event in #doMouseUp,
it searches this list in order, starting the first tool for which
Tool#canStart returns true.
getter/setter pair
-
mouseWheelBehavior
↔ EnumValue
-
Gets or sets the ToolManager's mouse wheel behavior. Allowed values are ToolManager.WheelScroll and
ToolManager.WheelZoom and ToolManager.WheelNone.
getter/setter pair
-
panningTool
↔ PanningTool
-
Gets or sets the mode-less PanningTool, normally one of the #mouseMoveTools.
getter/setter pair
-
relinkingTool
↔ RelinkingTool
-
Gets or sets the mode-less RelinkingTool, normally one of the #mouseDownTools.
getter/setter pair
-
resizingTool
↔ ResizingTool
-
Gets or sets the mode-less ResizingTool, normally one of the #mouseDownTools.
getter/setter pair
-
rotatingTool
↔ RotatingTool
-
Gets or sets the mode-less RotatingTool, normally one of the #mouseDownTools.
getter/setter pair
-
textEditingTool
↔ TextEditingTool
-
Gets or sets the mode-less TextEditingTool, normally one of the #mouseUpTools.
getter/setter pair
-
toolTipDuration
↔ num
-
Gets or sets how long a tool tip is visible.
The default value is 5000 milliseconds.
getter/setter pair
Methods
-
doKeyDown()
→ void
-
This just calls CommandHandler#doKeyDown on the diagram's Diagram#commandHandler.
-
doKeyUp()
→ void
-
This just calls CommandHandler#doKeyUp on the diagram's Diagram#commandHandler.
-
doMouseDown()
→ void
-
Iterate over the #mouseDownTools list and start the first tool
for which its Tool#canStart predicate returns true.
-
doMouseHover()
→ void
-
Implement the standard behavior for mouse hover and mouse hold events,
called by #doWaitAfter when the mouse has not moved for a period of time.
-
doMouseMove()
→ void
-
Iterate over the #mouseMoveTools list and start the first tool
for which its Tool#canStart predicate returns true.
-
doMouseUp()
→ void
-
Iterate over the #mouseUpTools list and start the first tool
for which its Tool#canStart predicate returns true.
-
doMouseWheel()
→ void
-
The diagram will call this method as the mouse wheel is rotated.
-
doToolTip()
→ void
-
Implement the standard behavior for tooltips,
called by #doWaitAfter when the mouse has not moved for a period of time.
-
doWaitAfter(InputEvent event)
→ void
-
Implement the standard behavior for when the mouse has not moved for a period of time.
This is due to an expired timer started by calling Tool#standardWaitAfter.
-
findTool(String name)
→ Tool?
-
Find a mouse tool of a given name.
This searches the #mouseDownTools, #mouseMoveTools, and #mouseUpTools lists.
-
hideToolTip()
→ void
-
Hide any tooltip.
-
initializeStandardTools()
→ void
-
Initialize the three mouse tool lists with instances of the standard tools.
This adds new instances of tools to the following three mouse tool lists:
#mouseDownTools, #mouseMoveTools, or #mouseUpTools.
This also sets the various tool properties of this ToolManager
to those newly created tools.
Please read the Introduction page on Extensions for how to override methods and how to call this base method.
@expose
-
positionToolTip(Adornment tooltip, GraphObject obj)
→ void
-
This is called by #showToolTip to position the part within the viewport.
It normally goes just below the cursor.
But if the mouse is too close to the right edge or the bottom edge of the viewport,
it is positioned left and/or above the cursor.
-
replaceStandardTool(String name, Tool newtool, List<Tool> list)
→ void
-
(undocumented)
@param {string} name
@param {Tool} newtool
@param {List.
-
replaceTool(String name, Tool newtool)
→ Tool?
-
Replace a mouse tool of a given name with a new tool, or remove an existing tool (if the newtool is null).
This searches the #mouseDownTools, #mouseMoveTools,
and #mouseUpTools lists.
The new tool is inserted into the same list in which the same-named tool is found,
at the same position as the old tool.
However, if no existing tool with the given name is present, this does not add the new tool to any list, since it cannot know where it should be added.
Please read the Introduction page on Extensions for how to override methods and how to call this base method.
@expose
@param {string} name the type of tool, such as "Dragging" or "ClickSelecting".
@param {Tool} newtool If null, any tool that the search finds will just be removed
from the list in which it was found.
@return {Tool} the old tool that was replaced by the new one; this is null if none was found and the new tool was not added to any mouse tool list
-
showToolTip(Object tooltip, GraphObject obj)
→ void
-
Show a tooltip Adornment or HTMLInfo.
This is called by #doToolTip once that method has found a tooltip to display.
