nutrient/com.pspdfkit.ui.search/PdfSearchView

PdfSearchView

interface PdfSearchView : PSPDFKitViews.PSPDFView

Interface implemented by the PdfSearchViewModular (and the transitional Compose inline-search handle).

Inheritors

PdfSearchViewLazy

Types

Listener

interface Listener

Listener for observing the search view.

Properties

searchConfiguration

abstract var searchConfiguration: SearchConfiguration

Config options for search

Functions

clearSearch

abstract fun 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 Listener.onSearchCleared on the current listener.

isShown

abstract fun isShown(): Boolean

Returns the value returned when callingView.isShown on the search view.

setInputFieldText

abstract fun setInputFieldText(text: String, startSearch: Boolean)

Inserts text in search input field and optionally starts search.

setSearchViewListener

abstract fun setSearchViewListener(searchViewListener: PdfSearchView.Listener?)

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