public class

TextHighlightCreate

extends TextMarkupCreate
java.lang.Object
   ↳ com.pdftron.pdf.tools.Tool
     ↳ com.pdftron.pdf.tools.BaseTool
       ↳ com.pdftron.pdf.tools.TextMarkupCreate
         ↳ com.pdftron.pdf.tools.TextHighlightCreate

Class Overview

This class is for creating text highlight annotation.

Summary

[Expand]
Inherited Constants
From class com.pdftron.pdf.tools.BaseTool
From class com.pdftron.pdf.tools.Tool
[Expand]
Inherited Fields
From class com.pdftron.pdf.tools.Tool
Public Constructors
TextHighlightCreate(PDFViewCtrl ctrl)
Class constructor
Public Methods
int getCreateAnnotType()
Gets what annotation type this tool can create
ToolManager.ToolModeBase getToolMode()
The overload implementation of getToolMode().
void setupAnnotProperty(int color, float opacity, float thickness, int fillColor, String icon, String pdfTronFontName)
The overload implementation of setupAnnotProperty(int, float, float, int, String, String).
[Expand]
Inherited Methods
From class com.pdftron.pdf.tools.TextMarkupCreate
From class com.pdftron.pdf.tools.BaseTool
From class com.pdftron.pdf.tools.Tool
From class java.lang.Object
From interface com.pdftron.pdf.tools.ToolManager.Tool

Public Constructors

public TextHighlightCreate (PDFViewCtrl ctrl)

Class constructor

Public Methods

public int getCreateAnnotType ()

Gets what annotation type this tool can create

Returns
  • annot type for annotation creation tool, or unknown for non-creation tool.

public ToolManager.ToolModeBase getToolMode ()

The overload implementation of getToolMode().

Returns
  • the mode/identifier of this tool.

public void setupAnnotProperty (int color, float opacity, float thickness, int fillColor, String icon, String pdfTronFontName)

The overload implementation of setupAnnotProperty(int, float, float, int, String, String).

Parameters
color The color
opacity The opacity
thickness The thickness
fillColor The color for filling
icon The icon
pdfTronFontName The PDFTron font name