new Tool(docViewer)
Parameters:
Name | Type | Description |
---|---|---|
docViewer |
CoreControls.DocumentViewer | an instance of DocumentViewer. |
Properties:
Name | Type | Description |
---|---|---|
docViewer |
CoreControls.DocumentViewer | the reference to the current DocumentViewer instance |
pageCoordinates |
Array.<Tools.PageCoordinate> | an array of page coordinates this tool currently holds. The default is index 0 for the mouse left down and index 1 for mouse left up. |
ENABLE_TEXT_SELECTION |
boolean | A boolean indicating whether text selection is enabled |
ENABLE_AUTO_SWITCH |
boolean | A boolean indicating whether the text select tool should automatically switch if the cursor is hovering over text or not |
Methods
-
contextMenu(e)
-
The function called when a context menu should be shown. Use e.preventDefault to disable the default browser context menu
Parameters:
Name Type Description e
the event object
-
getDocumentViewer()
-
Returns the instance of DocumentViewer for this tool.
Returns:
the instance of DocumentViewer for this tool.
-
keyDown(e)
-
The function called when a keyboard key is down.
Parameters:
Name Type Description e
the event object containing keyboard key data.
-
mouseDoubleClick(e)
-
The function called when the mouse left button is double clicked.
Parameters:
Name Type Description e
the event object containing mouse coordinates.
-
mouseLeftDown(e)
-
The function called when the left mouse button is down
Parameters:
Name Type Description e
the event object containing mouse coordinates.
-
mouseLeftUp(e)
-
The function called when the left mouse button is up. Typically, annotations are created and added to the annotation manager at this point.
Parameters:
Name Type Description e
the event object containing mouse coordinates.
-
mouseMove(e)
-
The function called when the mouse moves.
Parameters:
Name Type Description e
the event object containing mouse coordinates.
-
switchIn(oldTool)
-
The function called when this tool is selected. Typically use for changing mouse cursors, and initializing states for the tool.
Parameters:
Name Type Description oldTool
Tools.Tool the Tool class that was previously selected.
-
switchOut(newTool)
-
The function called when this tool is deselected. Typically use for changing mouse cursors, and cleaning up states for the tool.
Parameters:
Name Type Description newTool
Tools.Tool the Tool class that was newly selected.