public interface

PdfSearchView

implements PSPDFKitViews.PSPDFView
com.pspdfkit.ui.search.PdfSearchView
Known Indirect Subclasses

Class Overview

Interface shared by the PdfSearchViewInline and the PdfSearchViewModular.

Summary

Nested Classes
interface PdfSearchView.Listener Listener for observing the search view. 
Public Methods
abstract void clearSearch()
Clears the search input field as well as any previously collected search results.
abstract boolean isShown()
Returns the value returned when callingisShown() on the search view.
abstract void setInputFieldText(String text, boolean startSearch)
Inserts text in search input field and optionally starts search.
abstract void setSearchConfiguration(SearchConfiguration searchConfiguration)
Sets the search configuration to this search view.
abstract void setSearchViewListener(PdfSearchView.Listener searchViewListener)
Sets a listener to be notified of search events on this view.
[Expand]
Inherited Methods
From interface com.pspdfkit.ui.PSPDFKitViews.PSPDFView

Public Methods

public abstract void clearSearch ()

Clears the search input field as well as any previously collected search results. This will also cancel any currently running search operation. Implementations of PdfSearchView need to call onSearchCleared() on the current listener.

public abstract boolean isShown ()

Returns the value returned when callingisShown() on the search view.

Returns
  • true if search view is shown, false otherwise.

public abstract void setInputFieldText (String text, boolean startSearch)

Inserts text in search input field and optionally starts search.

Parameters
text Search text.
startSearch Hides keyboard and starts search if true

public abstract void setSearchConfiguration (SearchConfiguration searchConfiguration)

Sets the search configuration to this search view.

Parameters
searchConfiguration Search configuration to be set for this PdfSearchView.

public abstract void setSearchViewListener (PdfSearchView.Listener searchViewListener)

Sets a listener to be notified of search events on this view. May be null to remove any previously set listener.

Parameters
searchViewListener A PdfSearchView.Listener which should be notified of search events, or null to remove a previously registered listener.