Interface PdfSearchView.Listener
-
- All Implemented Interfaces:
public interface PdfSearchView.Listener
Listener for observing the search view.
-
-
Method Summary
Modifier and Type Method Description abstract void
onSearchStarted(@NonNull() String searchTerm)
Called by the PdfSearchView once it has started searching the document. abstract void
onMoreSearchResults(@NonNull() List<SearchResult> results)
Called every time the PdfSearchView has a new chunk of SearchResult instances. abstract void
onSearchCompleted()
Called by the PdfSearchView as soon as it has finished the search. abstract void
onSearchCleared()
Called by the PdfSearchView when the current search results have been cleared. abstract void
onSearchError(@NonNull() Throwable error)
Called by the PdfSearchView if search could not be completed because of an error
.abstract void
onSearchResultSelected(@Nullable() SearchResult result)
Called by the PdfSearchView if the user touched a SearchResult, providing the actual result
as an argument, ornull
if the previous search result selection was cleared.-
-
Method Detail
-
onSearchStarted
abstract void onSearchStarted(@NonNull() String searchTerm)
Called by the PdfSearchView once it has started searching the document.
- Parameters:
searchTerm
- The term which is searched.
-
onMoreSearchResults
abstract void onMoreSearchResults(@NonNull() 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.
-
onSearchCompleted
abstract void onSearchCompleted()
Called by the PdfSearchView as soon as it has finished the search.
-
onSearchCleared
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.
-
onSearchError
abstract void onSearchError(@NonNull() Throwable error)
Called by the PdfSearchView if search could not be completed because of an
error
.- Parameters:
error
- Throwable describing the error.
-
onSearchResultSelected
abstract void onSearchResultSelected(@Nullable() SearchResult result)
Called by the PdfSearchView if the user touched a SearchResult, providing the actual
result
as an argument, ornull
if the previous search result selection was cleared.- Parameters:
result
- The touched SearchResult, ornull
if the previous search result selection was cleared.
-
-
-
-