public static interface

PdfSearchView.Listener

com.pspdfkit.ui.search.PdfSearchView.Listener
Known Indirect Subclasses

Class Overview

Listener for observing the search view.

Summary

Public Methods
abstract void onMoreSearchResults(List<SearchResult> results)
Called every time the PdfSearchView has a new chunk of SearchResult instances.
abstract void onSearchCleared()
Called by the PdfSearchView when the current search results have been cleared.
abstract void onSearchCompleted()
Called by the PdfSearchView as soon as it has finished the search.
abstract void onSearchError(Throwable error)
Called by the PdfSearchView if search could not be completed because of an error.
abstract void onSearchResultSelected(SearchResult result)
Called by the PdfSearchView if the user touched a SearchResult, providing the actual result as an argument, or null if the previous search result selection was cleared.
abstract void onSearchStarted(String searchTerm)
Called by the PdfSearchView once it has started searching the document.

Public Methods

public abstract void onMoreSearchResults (List<SearchResult> results)

Called every time the PdfSearchView has a new chunk of SearchResult instances. The listener implementation must be abel to handle multiple subsequent calls, since the search view may call this method multiple times during a search.

Parameters
results The next chunk of search results.

public abstract void onSearchCleared ()

Called by the PdfSearchView when the current search results have been cleared. This may be called if the user clears and hides the search view.

public abstract void onSearchCompleted ()

Called by the PdfSearchView as soon as it has finished the search.

public abstract void onSearchError (Throwable error)

Called by the PdfSearchView if search could not be completed because of an error.

Parameters
error Throwable describing the error.

public abstract void onSearchResultSelected (SearchResult result)

Called by the PdfSearchView if the user touched a SearchResult, providing the actual result as an argument, or null if the previous search result selection was cleared.

Parameters
result The touched SearchResult, or null if the previous search result selection was cleared.

public abstract void onSearchStarted (String searchTerm)

Called by the PdfSearchView once it has started searching the document.

Parameters
searchTerm The term which is searched.