Class Tools.GenericAnnotationCreateTool
Extends
Tools.AnnotationSelectTool.
Represents a generic tool use to create markup annotations based on two mouse points (mouse left down and mouse left up).
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Tools.GenericAnnotationCreateTool(docViewer, annotationPrototype, constructorArg)
Creates a new instance of GenericAnnotationCreateTool.
|
| Field Attributes | Field Name and Description |
|---|---|
|
the instance of the annotation object created
|
- Fields borrowed from class Tools.AnnotationSelectTool:
- overrideSelection, PAGE_PADDING
- Fields borrowed from class Tools.Tool:
- docViewer, pageCoordinates
- Methods borrowed from class Tools.Tool:
- contextMenu, getDocumentViewer, keyDown, mouseDoubleClick, mouseLeftDown, mouseLeftUp, mouseMove, switchIn, switchOut
| Event Attributes | Event Name and Description |
|---|---|
|
annotationAdded(evt, annotation)
Triggered when an annotation has been added to the document by the tool
|
|
|
annotationCreated(evt, annotations)
Triggered when an annotation has been created by the tool
|
Class Detail
Tools.GenericAnnotationCreateTool(docViewer, annotationPrototype, constructorArg)
Creates a new instance of GenericAnnotationCreateTool.
- Parameters:
- {CoreControls.DocumentViewer} docViewer
- the instance of the corresponding DocumentViewer
- {Annotations.Annotation} annotationPrototype
- the prototype of the Annotation to create.
- {object} constructorArg Optional
- optional argument to pass to the annotation's constructor
Field Detail
{Annotations.Annotation}
annotation
the instance of the annotation object created
Event Detail
annotationAdded(evt, annotation)
Triggered when an annotation has been added to the document by the tool
- Parameters:
- {object} evt
- Event object
- {Annotations.Annotation} annotation
- The annotation that was added
annotationCreated(evt, annotations)
Triggered when an annotation has been created by the tool
- Parameters:
- {object} evt
- Event object
- {Annotations.Annotation} annotations
- The annotation that was created