Class: AnnotationSelectTool

Tools. AnnotationSelectTool

Represents a tool that can select annotations


new AnnotationSelectTool(docViewer)

Parameters:
Name Type Description
docViewer CoreControls.DocumentViewer

an instance of DocumentViewer.

Properties:
Name Type Description
PAGE_PADDING Annotations.Rect

padding at the page edges that defines how close annotations can be created and dragged to the edge

overrideSelection boolean

Whether to override the default annotation selection behavior of the tool. If true then annotations will not be selected by the tool.

Extends

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

Inherited From:

getDocumentViewer()

Returns the instance of DocumentViewer for this tool.

Inherited From:
Returns:

the instance of DocumentViewer for this tool.

Type
CoreControls.DocumentViewer

getMouseLocation(e)

Takes an event object from a mouse event and converts the location into window coordinates

Parameters:
Name Type Description
e

the event object containing mouse coordinates

Inherited From:

keyDown(e)

The function called when a keyboard key is down.

Parameters:
Name Type Description
e

the event object containing keyboard key data.

Inherited From:

mouseDoubleClick(e)

The function called when the mouse left button is double clicked.

Parameters:
Name Type Description
e

the event object containing mouse coordinates.

Inherited From:

mouseLeftDown(e)

The function called when the left mouse button is down

Parameters:
Name Type Description
e

the event object containing mouse coordinates.

Inherited From:

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.

Inherited From:

mouseMove(e)

The function called when the mouse moves.

Parameters:
Name Type Description
e

the event object containing mouse coordinates.

Inherited From:

setName(name)

Set the name of the tool, which can be accessed by toolObject.name

Parameters:
Name Type Description
name string

name of the tool

Inherited From:

setStyles(callback)

Set the style for the tool, which will be applied to annotations drawn afterwards

Parameters:
Name Type Description
callback

callback function that returns new style object from old style object argument.

Inherited From:

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.

Inherited From:

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.

Inherited From: