com.foxit.uiextensions.ToolHandler Interface Reference
Inheritance diagram for com.foxit.uiextensions.ToolHandler:
com.foxit.sdk.PDFViewCtrl.IDrawEventListener

Public Member Functions

String getType ()
 
boolean isContinueAddAnnot ()
 
void onActivate ()
 
void onDeactivate ()
 
boolean onLongPress (int pageIndex, MotionEvent motionEvent)
 
boolean onSingleTapConfirmed (int pageIndex, MotionEvent motionEvent)
 
boolean onTouchEvent (int pageIndex, MotionEvent motionEvent)
 
void setContinueAddAnnot (boolean continueAddAnnot)
 
- Public Member Functions inherited from com.foxit.sdk.PDFViewCtrl.IDrawEventListener
void onDraw (int pageIndex, Canvas canvas)
 

Public Attributes

String TH_TYPE_ARROW = "Arrow Tool"
 
String TH_TYPE_BLANKSELECT = "BlankSelect Tool"
 
String TH_TYPE_CALLOUT = "Callout Tool"
 
String TH_TYPE_CIRCLE = "Circle Tool"
 
String TH_TYPE_DISTANCE = "Distance Tool"
 
String TH_TYPE_ERASER = "Eraser Tool"
 
String TH_TYPE_FILEATTACHMENT = "FileAttachment Tool"
 
String TH_TYPE_FORMFILLER = "FormFiller Tool"
 
String TH_TYPE_HIGHLIGHT = "Highlight Tool"
 
String TH_TYPE_INK = "Ink Tool"
 
String TH_TYPE_LINE = "Line Tool"
 
String TH_TYPE_NOTE = "Note Tool"
 
String TH_TYPE_PDFIMAGE = "PDFImage Tool"
 
String TH_TYPE_POLYGON = "polygon Tool"
 
String TH_TYPE_POLYGONCLOUD = "polygon cloud Tool"
 
String TH_TYPE_POLYLINE = "polyline Tool"
 
String TH_TYPE_REPLACE = "Replace Tool"
 
String TH_TYPE_SCREEN_AUDIO = "Audio Tool"
 
String TH_TYPE_SCREEN_VIDEO = "Video Tool"
 
String TH_TYPE_SELECT_ANNOTATIONS = "Select Annotations Tool"
 
String TH_TYPE_SIGNATURE = "Signature Tool"
 
String TH_TYPE_SQUARE = "Square Tool"
 
String TH_TYPE_SQUIGGLY = "Squiggly Tool"
 
String TH_TYPE_STAMP = "Stamp Tool"
 
String TH_TYPE_STRIKEOUT = "Strikeout Tool"
 
String TH_TYPE_TEXTBOX = "Textbox Tool"
 
String TH_TYPE_TEXTSELECT = "TextSelect Tool"
 
String TH_TYPE_TYPEWRITER = "Typewriter Tool"
 
String TH_TYPE_UNDERLINE = "Underline Tool"
 
String TH_TYPR_INSERTTEXT = "InsetText Tool"
 

Detailed Description

Interface that defines a tool to add annotation or select text.

Member Function Documentation

◆ getType()

String com.foxit.uiextensions.ToolHandler.getType ( )
Returns
the type of the tool handler, refer to
TH_TYPE_XXX
.

◆ isContinueAddAnnot()

boolean com.foxit.uiextensions.ToolHandler.isContinueAddAnnot ( )
Returns
whether or not the annotation can be created continuously.

◆ onActivate()

void com.foxit.uiextensions.ToolHandler.onActivate ( )

Called when a tool handler is selected as the current tool handler.

◆ onDeactivate()

void com.foxit.uiextensions.ToolHandler.onDeactivate ( )

Called when the current tool handler is changed.

◆ onLongPress()

boolean com.foxit.uiextensions.ToolHandler.onLongPress ( int  pageIndex,
MotionEvent  motionEvent 
)

Called when PDFViewCtrl.UIExtensionsManager#onLongPress(MotionEvent) is called.

Parameters
pageIndexThe page index.Valid range: from 0 to (count-1). count is the page count.
motionEventA MotionEvent object which species the event.
Returns
PDFViewCtrl.UIExtensionsManager#onLongPress(MotionEvent)

◆ onSingleTapConfirmed()

boolean com.foxit.uiextensions.ToolHandler.onSingleTapConfirmed ( int  pageIndex,
MotionEvent  motionEvent 
)

Called when PDFViewCtrl.UIExtensionsManager#onSingleTapConfirmed(MotionEvent) is called.

Parameters
pageIndexThe page index.Valid range: from 0 to (count-1). count is the page count.
motionEventA MotionEvent object which species the event.
Returns
PDFViewCtrl.UIExtensionsManager#onSingleTapConfirmed(MotionEvent)

◆ onTouchEvent()

boolean com.foxit.uiextensions.ToolHandler.onTouchEvent ( int  pageIndex,
MotionEvent  motionEvent 
)

Called when PDFViewCtrl.UIExtensionsManager#onTouchEvent(int, MotionEvent) is called

Parameters
pageIndexThe page index.Valid range: from 0 to (count-1). count is the page count.
motionEventA MotionEvent object which species the event.
Returns
PDFViewCtrl.UIExtensionsManager#onTouchEvent(int, MotionEvent)

◆ setContinueAddAnnot()

void com.foxit.uiextensions.ToolHandler.setContinueAddAnnot ( boolean  continueAddAnnot)

Set whether the annot can be created continuously. The default is false.

Parameters
continueAddAnnotwhether the annotation can be created continuously.

Member Data Documentation

◆ TH_TYPE_ARROW

String com.foxit.uiextensions.ToolHandler.TH_TYPE_ARROW = "Arrow Tool"

Tool Handler type: arrow.

◆ TH_TYPE_BLANKSELECT

String com.foxit.uiextensions.ToolHandler.TH_TYPE_BLANKSELECT = "BlankSelect Tool"

Tool Handler type: a tool to add annotation or signature on blank position.

◆ TH_TYPE_CALLOUT

String com.foxit.uiextensions.ToolHandler.TH_TYPE_CALLOUT = "Callout Tool"

Tool Handler type: callout.

◆ TH_TYPE_CIRCLE

String com.foxit.uiextensions.ToolHandler.TH_TYPE_CIRCLE = "Circle Tool"

Tool Handler type: circle.

◆ TH_TYPE_DISTANCE

String com.foxit.uiextensions.ToolHandler.TH_TYPE_DISTANCE = "Distance Tool"

Tool Handler type: distance.

◆ TH_TYPE_ERASER

String com.foxit.uiextensions.ToolHandler.TH_TYPE_ERASER = "Eraser Tool"

Tool Handler type: eraser.

◆ TH_TYPE_FILEATTACHMENT

String com.foxit.uiextensions.ToolHandler.TH_TYPE_FILEATTACHMENT = "FileAttachment Tool"

Tool Handler type: file attachment.

◆ TH_TYPE_FORMFILLER

String com.foxit.uiextensions.ToolHandler.TH_TYPE_FORMFILLER = "FormFiller Tool"

Tool Handler type: form filler.

◆ TH_TYPE_HIGHLIGHT

String com.foxit.uiextensions.ToolHandler.TH_TYPE_HIGHLIGHT = "Highlight Tool"

Tool Handler type: highlight.

◆ TH_TYPE_INK

String com.foxit.uiextensions.ToolHandler.TH_TYPE_INK = "Ink Tool"

Tool Handler type: ink.

◆ TH_TYPE_LINE

String com.foxit.uiextensions.ToolHandler.TH_TYPE_LINE = "Line Tool"

Tool Handler type: line.

◆ TH_TYPE_NOTE

String com.foxit.uiextensions.ToolHandler.TH_TYPE_NOTE = "Note Tool"

Tool Handler type: note.

◆ TH_TYPE_PDFIMAGE

String com.foxit.uiextensions.ToolHandler.TH_TYPE_PDFIMAGE = "PDFImage Tool"

Tool Handler type: image.

◆ TH_TYPE_POLYGON

String com.foxit.uiextensions.ToolHandler.TH_TYPE_POLYGON = "polygon Tool"

Tool Handler type: polygon.

◆ TH_TYPE_POLYGONCLOUD

String com.foxit.uiextensions.ToolHandler.TH_TYPE_POLYGONCLOUD = "polygon cloud Tool"

Tool Handler type: polygon cloud.

◆ TH_TYPE_POLYLINE

String com.foxit.uiextensions.ToolHandler.TH_TYPE_POLYLINE = "polyline Tool"

Tool Handler type: polyline.

◆ TH_TYPE_REPLACE

String com.foxit.uiextensions.ToolHandler.TH_TYPE_REPLACE = "Replace Tool"

Tool Handler type: replace.

◆ TH_TYPE_SCREEN_AUDIO

String com.foxit.uiextensions.ToolHandler.TH_TYPE_SCREEN_AUDIO = "Audio Tool"

Tool Handler type: audio.

◆ TH_TYPE_SCREEN_VIDEO

String com.foxit.uiextensions.ToolHandler.TH_TYPE_SCREEN_VIDEO = "Video Tool"

Tool Handler type: video.

◆ TH_TYPE_SELECT_ANNOTATIONS

String com.foxit.uiextensions.ToolHandler.TH_TYPE_SELECT_ANNOTATIONS = "Select Annotations Tool"

Tool Handler type: select multiple annotations.

◆ TH_TYPE_SIGNATURE

String com.foxit.uiextensions.ToolHandler.TH_TYPE_SIGNATURE = "Signature Tool"

Tool Handler type: signature.

◆ TH_TYPE_SQUARE

String com.foxit.uiextensions.ToolHandler.TH_TYPE_SQUARE = "Square Tool"

Tool Handler type: square.

◆ TH_TYPE_SQUIGGLY

String com.foxit.uiextensions.ToolHandler.TH_TYPE_SQUIGGLY = "Squiggly Tool"

Tool Handler type: squiggly.

◆ TH_TYPE_STAMP

String com.foxit.uiextensions.ToolHandler.TH_TYPE_STAMP = "Stamp Tool"

Tool Handler type: stamp.

◆ TH_TYPE_STRIKEOUT

String com.foxit.uiextensions.ToolHandler.TH_TYPE_STRIKEOUT = "Strikeout Tool"

Tool Handler type: strikeout.

◆ TH_TYPE_TEXTBOX

String com.foxit.uiextensions.ToolHandler.TH_TYPE_TEXTBOX = "Textbox Tool"

Tool Handler type: textbox.

◆ TH_TYPE_TEXTSELECT

String com.foxit.uiextensions.ToolHandler.TH_TYPE_TEXTSELECT = "TextSelect Tool"

Tool Handler type: select text.

◆ TH_TYPE_TYPEWRITER

String com.foxit.uiextensions.ToolHandler.TH_TYPE_TYPEWRITER = "Typewriter Tool"

Tool Handler type: typewriter.

◆ TH_TYPE_UNDERLINE

String com.foxit.uiextensions.ToolHandler.TH_TYPE_UNDERLINE = "Underline Tool"

Tool Handler type: underline.

◆ TH_TYPR_INSERTTEXT

String com.foxit.uiextensions.ToolHandler.TH_TYPR_INSERTTEXT = "InsetText Tool"

Tool Handler type: insert text.