Class Tools.TextTool
Extends
Tools.Tool.
Represents an extendable class for text-based tool.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Tools.TextTool(docViewer)
|
| Field Attributes | Field Name and Description |
|---|---|
|
Selection mode used by text tools (structural or rectangular)
|
- Fields borrowed from class Tools.Tool:
- docViewer, pageCoordinates
| Method Attributes | Method Name and Description |
|---|---|
|
select(pagePt1, pagePt2)
Select text based on two points
|
- Methods borrowed from class Tools.Tool:
- getDocumentViewer
| Event Attributes | Event Name and Description |
|---|---|
|
textSelected(quads, text)
The event triggered when a text region is selected.
|
- Events borrowed from class Tools.Tool:
- contextMenu, keyDown, mouseDoubleClick, mouseLeftDown, mouseLeftUp, mouseMove, switchIn, switchOut
Class Detail
Tools.TextTool(docViewer)
- Parameters:
- {CoreControls.DocumentViewer} docViewer
- an instance of DocumentViewer.
Field Detail
{string}
SELECTION_MODE
Selection mode used by text tools (structural or rectangular)
Method Detail
select(pagePt1, pagePt2)
Select text based on two points
- Parameters:
- {object} pagePt1
- The start point to select from. Is an object with pageIndex, x and y properties.
- {object} pagePt2
- The end point to select to. Is an object with pageIndex, x and y properties.
Event Detail
textSelected(quads, text)
The event triggered when a text region is selected.
- Parameters:
- quads
- the quad coordinates fo the selected text.
- {string} text
- the text selected.