public class

FindTextOverlay

extends ConstraintLayout
implements PDFViewCtrl.TextSearchListener
java.lang.Object
   ↳ ConstraintLayout
     ↳ com.pdftron.pdf.controls.FindTextOverlay

Summary

Nested Classes
interface FindTextOverlay.FindTextOverlayListener  
Public Constructors
FindTextOverlay(Context context)
FindTextOverlay(Context context, AttributeSet attrs)
FindTextOverlay(Context context, AttributeSet attrs, int defStyleAttr)
Public Methods
void cancelFindText()
Cancels finding text.
void exitSearchMode()
Exits the search mode.
void findText()
void findText(int pageNum)
void gotoNextSearch()
Goes to the next text in search.
void gotoPreviousSearch()
Goes to the previous text in search.
void highlightFullTextSearchResult(TextSearchResult result)
Highlights the results of full text search.
void highlightSearchResults()
Starts the TextHighlighter tool.
void onTextSearchEnd(PDFViewCtrl.TextSearchResult result)
Handles when PDFViewCtrl has progress on search text.
void onTextSearchProgress(int progress)
Handles when PDFViewCtrl has progress on search text.
void onTextSearchStart()
Handles when PDFViewCtrl starts to search text.
void queryTextSubmit(String text)
Submits the query text.
void queryTextSubmit(String text, int startPageNum)
Submits the query text.
void resetFullTextResults()
Resets full text results.
void setFindTextOverlayListener(FindTextOverlay.FindTextOverlayListener listener)
void setPdfViewCtrl(PDFViewCtrl pdfViewCtrl)
Sets the PDFViewCtrl
void setSearchMatchCase(boolean matchCase)
Sets the search rule for match case.
void setSearchQuery(String text)
Specifies the search query.
void setSearchSettings(boolean matchCase, boolean wholeWord)
Sets the search rules for match case and whole word.
void setSearchWholeWord(boolean wholeWord)
Sets the search rule for whole word.
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.pdftron.pdf.PDFViewCtrl.TextSearchListener

Public Constructors

public FindTextOverlay (Context context)

public FindTextOverlay (Context context, AttributeSet attrs)

public FindTextOverlay (Context context, AttributeSet attrs, int defStyleAttr)

Public Methods

public void cancelFindText ()

Cancels finding text.

public void exitSearchMode ()

Exits the search mode.

public void findText ()

public void findText (int pageNum)

public void gotoNextSearch ()

Goes to the next text in search.

public void gotoPreviousSearch ()

Goes to the previous text in search.

public void highlightFullTextSearchResult (TextSearchResult result)

Highlights the results of full text search.

Parameters
result The TextSearchResult

public void highlightSearchResults ()

Starts the TextHighlighter tool.

public void onTextSearchEnd (PDFViewCtrl.TextSearchResult result)

Handles when PDFViewCtrl has progress on search text.

Parameters
result search result.

public void onTextSearchProgress (int progress)

Handles when PDFViewCtrl has progress on search text.

Parameters
progress progress indicator in the range [0, 100]

public void onTextSearchStart ()

Handles when PDFViewCtrl starts to search text.

public void queryTextSubmit (String text)

Submits the query text.

Parameters
text The query text

public void queryTextSubmit (String text, int startPageNum)

Submits the query text. Starting from a specific page

Parameters
text The query text
startPageNum The starting page for the search

public void resetFullTextResults ()

Resets full text results.

public void setFindTextOverlayListener (FindTextOverlay.FindTextOverlayListener listener)

public void setPdfViewCtrl (PDFViewCtrl pdfViewCtrl)

Sets the PDFViewCtrl

Parameters
pdfViewCtrl the PDFViewCtrl

public void setSearchMatchCase (boolean matchCase)

Sets the search rule for match case.

Parameters
matchCase True if match case is enabled

public void setSearchQuery (String text)

Specifies the search query.

Parameters
text The search query

public void setSearchSettings (boolean matchCase, boolean wholeWord)

Sets the search rules for match case and whole word.

Parameters
matchCase True if match case is enabled
wholeWord True if whole word is enabled

public void setSearchWholeWord (boolean wholeWord)

Sets the search rule for whole word.

Parameters
wholeWord True if whole word is enabled