Summary: Methods | [Expand All]

public static interface

ToolManager.Tool

com.pdftron.pdf.tools.ToolManager.Tool

Known Indirect Subclasses

AdvancedShapeCreate, AnnotEdit, AnnotEditAdvancedShape, AnnotEditLine, AnnotEditRectGroup, AnnotEditTextMarkup, AreaMeasureCreate, ArrowCreate, BaseTool, CalloutCreate, CheckboxFieldCreate, ChoiceFieldCreate, CloudCreate, ComboBoxFieldCreate, CountMeasurementCreateTool, and 45 others.

AdvancedShapeCreate	This class is the base class for several shape creation classes that need clicks to determine vertices vs drag and drop, e.g., Polyline, Polygon, Cloud and etc.
AnnotEdit	This class is responsible for editing a selected annotation, e.g., moving and resizing.
AnnotEditAdvancedShape	This class is responsible for editing a selected advanced shape such as polyline, polygon and cloud.
AnnotEditLine	This class is responsible for editing a selected line or arrow, e.g., moving and resizing.
AnnotEditRectGroup	This class is for selecting a group of annotations
AnnotEditTextMarkup	This class is responsible for editing text markup: highlight/strikeout/underline, e.g., moving and resizing.
AreaMeasureCreate
ArrowCreate	This class is for creating an arrow.
BaseTool
CalloutCreate	A tool for creating callout annotation
CheckboxFieldCreate	This class is for creating checkbox field
ChoiceFieldCreate
CloudCreate	This class is for creating a rectangle annotation.
ComboBoxFieldCreate	This class is for creating combo box field
CountMeasurementCreateTool
DigitalSignature
Eraser	This class is for erasing annotation.
FileAttachmentCreate
FormFill	This class is responsible for filling forms.
FreeHighlighterCreate	This class is for creating a free highlighter annotation.
FreeTextCreate	A tool for creating free text annotation
FreeTextDateCreate
FreeTextSpacingCreate	This class is responsible for creating FreeText annotation with custom spacing.
FreehandCreate	This class is for creating a free hand annotation.
LineCreate	This class is for creating a line annotation.
LinkAction	A tool for handling single tap on `Link` annotation
ListBoxFieldCreate	This class is for creating list box field
OvalCreate	This class is for creating an oval annotation.
Pan	Pan tool implements the following functions: Select the hit annotation and switch to annotation edit tool on single tap event; Bring up annotation creation menu upon long press event.
PerimeterMeasureCreate
PolygonCreate	This class is for creating a rectangle annotation.
PolylineCreate	This class is for creating a rectangle annotation.
RadioGroupFieldCreate	This class is for creating radio group field
RectAreaMeasureCreate
RectCreate	This class is for creating a rectangle annotation.
RectLinkCreate	Used for creating Rectangle link
RectRedactionCreate
RichMedia	A tool for handling single tap on rich media annotation
RubberStampCreate	This class is for creating rubber stamp annotation.
RulerCreate
Signature	This class is for creating signature annotation.
SignatureFieldCreate	This class is for creating a signature field annotation
SimpleShapeCreate	This class is the base class for several shape creation classes, e.g., LineCreate, OvalCreate, etc.
SimpleTapShapeCreate
SmartPenInk
SmartPenMarkup
SoundCreate
Stamper	This class is for creating stamp annotation.
StickyNoteCreate	This class is for creating a sticky note annotation.
TextFieldCreate	This class is for creating multiline text field
TextHighlightCreate	This class is for creating text highlight annotation.
TextHighlighter	This class can be used to highlight all search results.
TextLinkCreate	This tool is for creating link annotation by selected text
TextMarkupCreate	This class is the base class for all text markup creation tools.
TextRedactionCreate
TextSelect	This class selects text on pages.
TextSquigglyCreate	This class is for creating text squiggly annotation.
TextStrikeoutCreate	This class is for creating text strikeout annotation.
TextUnderlineCreate	This class is for creating text underline annotation.
Tool	The base class that implements the ToolManager.Tool interface and several basic tool functionalities.

Class Overview

This interface is used to forward events from PDFViewCtrl.ToolManager to the actual implementation of the Tool.

Summary

Public Methods
abstract int	getCreateAnnotType() Gets what annotation type this tool can create
abstract ToolManager.ToolModeBase	getNextToolMode() Gets the next tool mode.
abstract ToolManager.ToolModeBase	getToolMode() Gets the tool mode.
abstract boolean	isCreatingAnnotation() Propagates `isCreatingAnnotation()` to the tools.
abstract void	onAnnotPainterUpdated(int page, long which, CurvePainter painter) Propagates `onAnnotPainterUpdated(int, long, com.pdftron.pdf.CurvePainter)` to the tools.
abstract void	onClose() Propagates `onClose()` to the tools.
abstract void	onConfigurationChanged(Configuration newConfig) Propagates `onConfigurationChanged(Configuration)` to the tools.
abstract void	onCustomEvent(Object obj) Propagates `onCustomEvent(Object)` to the tools.
abstract void	onDocumentDownloadEvent(PDFViewCtrl.DownloadState state, int page_num, int page_downloaded, int page_count, String message) Propagates `onDocumentDownloadEvent(PDFViewCtrl.DownloadState, int, int, int, String)` to the tools.
abstract boolean	onDoubleTap(MotionEvent e) Propagates `onDoubleTap(MotionEvent)` to the tools.
abstract void	onDoubleTapEnd(MotionEvent e) Propagates `onDoubleTapEnd(MotionEvent)` to the tools.
abstract boolean	onDoubleTapEvent(MotionEvent e) Propagates `onDoubleTapEvent(MotionEvent)` to the tools.
abstract void	onDoubleTapZoomAnimationBegin() Propagates `onDoubleTapZoomAnimationBegin()` to the tools.
abstract void	onDoubleTapZoomAnimationEnd() Propagates `onDoubleTapZoomAnimationEnd()` to the tools.
abstract boolean	onDown(MotionEvent e) Propagates `onDown(MotionEvent)` to the tools.
abstract void	onDraw(Canvas canvas, Matrix tfm) Propagates `onDraw(Canvas, Matrix)` to the tools.
abstract boolean	onDrawEdgeEffects(Canvas canvas, int width, int verticalOffset) Propagates `onDrawEdgeEffects(Canvas, int, int)` to the tools.
abstract boolean	onFlingStop() Propagates `onFlingStop()` to the tools.
abstract boolean	onKeyUp(int keyCode, KeyEvent event) Propagates `onKeyUp(int, KeyEvent)` to the tools.
abstract void	onLayout(boolean changed, int l, int t, int r, int b) Propagates `onLayout(boolean, int, int, int, int)` to the tools.
abstract boolean	onLongPress(MotionEvent e) Propagates `onLongPress(MotionEvent)` to the tools.
abstract boolean	onMove(MotionEvent e1, MotionEvent e2, float x_dist, float y_dist) Propagates `onMove(MotionEvent, MotionEvent, float, float)` to the tools.
abstract void	onNightModeUpdated(boolean isNightMode) Called when night mode has been updated.
abstract void	onPageTurning(int old_page, int cur_page) Propagates `onPageTurning(int, int)` to the tools.
abstract boolean	onPointerDown(MotionEvent e) Propagates `onPointerDown(MotionEvent)` to the tools.
abstract void	onPostSingleTapConfirmed() Propagates `onPostSingleTapConfirmed()` to the tools.
abstract void	onPullEdgeEffects(int which_edge, float delta_distance) Propagates `onPullEdgeEffects(int, float)` to the tools.
abstract void	onReleaseEdgeEffects() Propagates `onReleaseEdgeEffects()` to the tools.
abstract void	onRenderingFinished() Propagates `onRenderingFinished()` to the tools.
abstract boolean	onScale(float x, float y) Propagates `onScale(float, float)` to the tools.
abstract boolean	onScaleBegin(float x, float y) Propagates `onScaleBegin(float, float)` to the tools.
abstract boolean	onScaleEnd(float x, float y) Propagates `onScaleEnd(float, float)` to the tools.
abstract void	onScrollChanged(int l, int t, int oldl, int oldt) Propagates `onScrollChanged(int, int, int, int)` to the tools.
abstract void	onSetDoc() Propagates `onSetDoc()` to the tools.
abstract boolean	onShowPress(MotionEvent e) Propagates `onShowPress(MotionEvent)` to the tools.
abstract boolean	onSingleTapConfirmed(MotionEvent e) Propagates `onSingleTapConfirmed(MotionEvent)` to the tools.
abstract boolean	onSingleTapUp(MotionEvent e) Propagates `onSingleTapUp(MotionEvent)` to the tools.
abstract boolean	onUp(MotionEvent e, PDFViewCtrl.PriorEventMode priorEventMode) Propagates `onUp(MotionEvent, PDFViewCtrl.PriorEventMode)` to the tools.

Public Methods

public abstract int getCreateAnnotType ()

Gets what annotation type this tool can create

Returns

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

public abstract ToolManager.ToolModeBase getNextToolMode ()

Gets the next tool mode.

Returns

the mode of the next tool. Via this method, a tool can indicate the next tool to switch to.

public abstract ToolManager.ToolModeBase getToolMode ()

Gets the tool mode.

Returns

the mode/identifier of this tool.

public abstract boolean isCreatingAnnotation ()

Propagates isCreatingAnnotation() to the tools.

public abstract void onAnnotPainterUpdated (int page, long which, CurvePainter painter)

Propagates onAnnotPainterUpdated(int, long, com.pdftron.pdf.CurvePainter) to the tools.

public abstract void onClose ()

Propagates onClose() to the tools.

public abstract void onConfigurationChanged (Configuration newConfig)

Propagates onConfigurationChanged(Configuration) to the tools.

public abstract void onCustomEvent (Object obj)

Propagates onCustomEvent(Object) to the tools.

public abstract void onDocumentDownloadEvent (PDFViewCtrl.DownloadState state, int page_num, int page_downloaded, int page_count, String message)

Propagates onDocumentDownloadEvent(PDFViewCtrl.DownloadState, int, int, int, String) to the tools.

public abstract boolean onDoubleTap (MotionEvent e)

Propagates onDoubleTap(MotionEvent) to the tools.

public abstract boolean onDown (MotionEvent e)

Propagates onDown(MotionEvent) to the tools.

public abstract void onDraw (Canvas canvas, Matrix tfm)

Propagates onDraw(Canvas, Matrix) to the tools.

public abstract boolean onDrawEdgeEffects (Canvas canvas, int width, int verticalOffset)

Propagates onDrawEdgeEffects(Canvas, int, int) to the tools.

public abstract boolean onFlingStop ()

Propagates onFlingStop() to the tools.

public abstract boolean onKeyUp (int keyCode, KeyEvent event)

Propagates onKeyUp(int, KeyEvent) to the tools.

public abstract void onLayout (boolean changed, int l, int t, int r, int b)

Propagates onLayout(boolean, int, int, int, int) to the tools.

public abstract boolean onLongPress (MotionEvent e)

Propagates onLongPress(MotionEvent) to the tools.

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

Propagates onMove(MotionEvent, MotionEvent, float, float) to the tools.

public abstract void onNightModeUpdated (boolean isNightMode)

Called when night mode has been updated.

public abstract void onPageTurning (int old_page, int cur_page)

Propagates onPageTurning(int, int) to the tools.

public abstract boolean onPointerDown (MotionEvent e)

Propagates onPointerDown(MotionEvent) to the tools.

public abstract void onPostSingleTapConfirmed ()

Propagates onPostSingleTapConfirmed() to the tools.

public abstract void onPullEdgeEffects (int which_edge, float delta_distance)

Propagates onPullEdgeEffects(int, float) to the tools.

public abstract void onReleaseEdgeEffects ()

Propagates onReleaseEdgeEffects() to the tools.

public abstract void onRenderingFinished ()

Propagates onRenderingFinished() to the tools.

public abstract boolean onScale (float x, float y)

Propagates onScale(float, float) to the tools.

public abstract boolean onScaleBegin (float x, float y)

Propagates onScaleBegin(float, float) to the tools.

public abstract boolean onScaleEnd (float x, float y)

Propagates onScaleEnd(float, float) to the tools.

public abstract void onScrollChanged (int l, int t, int oldl, int oldt)

Propagates onScrollChanged(int, int, int, int) to the tools.

public abstract void onSetDoc ()

Propagates onSetDoc() to the tools.

public abstract boolean onShowPress (MotionEvent e)

Propagates onShowPress(MotionEvent) to the tools.

public abstract boolean onSingleTapConfirmed (MotionEvent e)

Propagates onSingleTapConfirmed(MotionEvent) to the tools.

public abstract boolean onSingleTapUp (MotionEvent e)

Propagates onSingleTapUp(MotionEvent) to the tools.

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

Propagates onUp(MotionEvent, PDFViewCtrl.PriorEventMode) to the tools.

Interfaces

Classes

Annotations

Enums

ToolManager.Tool

Class Overview

Summary

Public Methods

public abstract int getCreateAnnotType ()

Returns

public abstract ToolManager.ToolModeBase getNextToolMode ()

Returns

public abstract ToolManager.ToolModeBase getToolMode ()

Returns

public abstract boolean isCreatingAnnotation ()

public abstract void onAnnotPainterUpdated (int page, long which, CurvePainter painter)

public abstract void onClose ()

public abstract void onConfigurationChanged (Configuration newConfig)

public abstract void onCustomEvent (Object obj)

public abstract void onDocumentDownloadEvent (PDFViewCtrl.DownloadState state, int page_num, int page_downloaded, int page_count, String message)

public abstract boolean onDoubleTap (MotionEvent e)

public abstract void onDoubleTapEnd (MotionEvent e)

public abstract boolean onDoubleTapEvent (MotionEvent e)

public abstract void onDoubleTapZoomAnimationBegin ()

public abstract void onDoubleTapZoomAnimationEnd ()

public abstract boolean onDown (MotionEvent e)

public abstract void onDraw (Canvas canvas, Matrix tfm)

public abstract boolean onDrawEdgeEffects (Canvas canvas, int width, int verticalOffset)

public abstract boolean onFlingStop ()

public abstract boolean onKeyUp (int keyCode, KeyEvent event)

public abstract void onLayout (boolean changed, int l, int t, int r, int b)

public abstract boolean onLongPress (MotionEvent e)

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

public abstract void onNightModeUpdated (boolean isNightMode)

public abstract void onPageTurning (int old_page, int cur_page)

public abstract boolean onPointerDown (MotionEvent e)

public abstract void onPostSingleTapConfirmed ()

public abstract void onPullEdgeEffects (int which_edge, float delta_distance)

public abstract void onReleaseEdgeEffects ()

public abstract void onRenderingFinished ()

public abstract boolean onScale (float x, float y)

public abstract boolean onScaleBegin (float x, float y)

public abstract boolean onScaleEnd (float x, float y)

public abstract void onScrollChanged (int l, int t, int oldl, int oldt)

public abstract void onSetDoc ()

public abstract boolean onShowPress (MotionEvent e)

public abstract boolean onSingleTapConfirmed (MotionEvent e)

public abstract boolean onSingleTapUp (MotionEvent e)

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