public class

FreeHighlighterCreate

extends SimpleShapeCreate
java.lang.Object
   ↳ com.pdftron.pdf.tools.Tool
     ↳ com.pdftron.pdf.tools.BaseTool
       ↳ com.pdftron.pdf.tools.SimpleShapeCreate
         ↳ com.pdftron.pdf.tools.FreeHighlighterCreate
Known Direct Subclasses

Class Overview

This class is for creating a free highlighter annotation.

Summary

Constants
float AUTO_SMOOTH_RANGE_DEFAULT
float BLEND_OPACITY
[Expand]
Inherited Constants
From class com.pdftron.pdf.tools.SimpleShapeCreate
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
FreeHighlighterCreate(PDFViewCtrl ctrl)
Class constructor
Public Methods
void applyAutoSmooth()
int getCreateAnnotType()
Gets what annotation type this tool can create
ToolManager.ToolModeBase getToolMode()
The overload implementation of getToolMode().
boolean onDoubleTap(MotionEvent e)
The overload implementation of onDoubleTap(MotionEvent).
boolean onDoubleTapEvent(MotionEvent e)
The overload implementation of onDoubleTapEvent(MotionEvent).
boolean onDown(MotionEvent e)
The overload implementation of onDown(MotionEvent).
void onDraw(Canvas canvas, Matrix tfm)
The overload implementation of onDraw(Canvas, Matrix).
boolean onMove(MotionEvent e1, MotionEvent e2, float x_dist, float y_dist)
The overload implementation of onMove(MotionEvent, MotionEvent, float, float).
void onRenderingFinished()
The overload implementation of onRenderingFinished().
boolean onUp(MotionEvent e, PDFViewCtrl.PriorEventMode priorEventMode)
The overload implementation of onUp(MotionEvent, PDFViewCtrl.PriorEventMode).
void setAutoSmoothingRange(float range)
Sets how wide the range would be for auto smoothing vertical and horizontal strokes, in dp independent of zoom.
static void setDebug(boolean debug)
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.SimpleShapeCreate
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

Constants

public static final float AUTO_SMOOTH_RANGE_DEFAULT

Constant Value: 20.0

public static final float BLEND_OPACITY

Constant Value: 0.8

Public Constructors

public FreeHighlighterCreate (PDFViewCtrl ctrl)

Class constructor

Public Methods

public void applyAutoSmooth ()

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 boolean onDoubleTap (MotionEvent e)

The overload implementation of onDoubleTap(MotionEvent).

public boolean onDoubleTapEvent (MotionEvent e)

The overload implementation of onDoubleTapEvent(MotionEvent).

public boolean onDown (MotionEvent e)

The overload implementation of onDown(MotionEvent).

public void onDraw (Canvas canvas, Matrix tfm)

The overload implementation of onDraw(Canvas, Matrix).

public boolean onMove (MotionEvent e1, MotionEvent e2, float x_dist, float y_dist)

The overload implementation of onMove(MotionEvent, MotionEvent, float, float).

public void onRenderingFinished ()

The overload implementation of onRenderingFinished().

public boolean onUp (MotionEvent e, PDFViewCtrl.PriorEventMode priorEventMode)

The overload implementation of onUp(MotionEvent, PDFViewCtrl.PriorEventMode).

public void setAutoSmoothingRange (float range)

Sets how wide the range would be for auto smoothing vertical and horizontal strokes, in dp independent of zoom.

Parameters
range indicating how wide is the range to auto smooth vertical and horizontal strokes, in dp.

public static void setDebug (boolean debug)

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