new GenericAnnotationCreateTool(docViewer, annotationPrototype [, constructorArg])
Creates a new instance of GenericAnnotationCreateTool.
Parameters:
Name | Type | Argument | Description |
---|---|---|---|
docViewer |
CoreControls.DocumentViewer | the instance of the corresponding DocumentViewer |
|
annotationPrototype |
Annotations.Annotation | the prototype of the Annotation to create. |
|
constructorArg |
object |
<optional> |
optional argument to pass to the annotation's constructor |
Properties:
Name | Type | Description |
---|---|---|
annotation |
Annotations.Annotation | the instance of the annotation object created |
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.
-
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:
Events
-
annotationAdded
-
Triggered when an annotation has been added to the document by the tool
Parameters:
Name Type Description evt
object Event object
annotation
Annotations.Annotation The annotation that was added
-
annotationCreated
-
Triggered when an annotation has been created by the tool
Parameters:
Name Type Description evt
object Event object
annotations
Annotations.Annotation The annotation that was created