Class Tools.TextAnnotationCreateTool
Extends
Tools.TextTool.
Represents an abstract class for text-based annotation creation tools.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Tools.TextAnnotationCreateTool(docViewer, textAnnotationPrototype)
This class should not be instantiated.
|
| Field Attributes | Field Name and Description |
|---|---|
|
toggle whether selected text should be set as annotation note contents
|
- Fields borrowed from class Tools.TextTool:
- SELECTION_MODE
- Fields borrowed from class Tools.AnnotationSelectTool:
- overrideSelection, PAGE_PADDING
- Fields borrowed from class Tools.Tool:
- docViewer, pageCoordinates
- Methods borrowed from class Tools.TextTool:
- select, textSelected
- 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.TextAnnotationCreateTool(docViewer, textAnnotationPrototype)
This class should not be instantiated.
- Parameters:
- {CoreControls.DocumentViewer} docViewer
- an instance of DocumentViewer.
- {Annotations.Annotation} textAnnotationPrototype
- the prototype the text-based annotation to create.
Field Detail
{boolean}
AUTO_SET_TEXT
toggle whether selected text should be set as annotation note contents
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