PdfSearchView

All Implemented Interfaces:

com.pspdfkit.ui.PSPDFKitViews.PSPDFView
```
public interface PdfSearchView
 implements PSPDFKitViews.PSPDFView
                    
```
Interface shared by the PdfSearchViewInline and the PdfSearchViewModular.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public interface`	`PdfSearchView.Listener`	Listener for observing the search view.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`abstract Boolean`	`isShown()`	Returns the value returned when callingView.isShown on the search view.
`abstract Unit`	`clearSearch()`	Clears the search input field as well as any previously collected search results.
`abstract Unit`	`setInputFieldText(String text, Boolean startSearch)`	Inserts text in search input field and optionally starts search.
`abstract Unit`	`setSearchViewListener(PdfSearchView.Listener searchViewListener)`	Sets a listener to be notified of search events on this view.
`abstract SearchConfiguration`	`getSearchConfiguration()`	Config options for search
`abstract Unit`	`setSearchConfiguration(SearchConfiguration searchConfiguration)`	Config options for search

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - isShown
```
 abstract Boolean isShown()
```
    Returns the value returned when callingView.isShown on the search view.
    
    Returns:
    
    true if search view is shown, false otherwise.
  - clearSearch
```
 abstract Unit 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.
  - setInputFieldText
```
 abstract Unit 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
  - setSearchViewListener
```
 abstract Unit 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 Listener which should be notified of search events, or null to remove a previously registered listener.
  - getSearchConfiguration
```
 abstract SearchConfiguration getSearchConfiguration()
```
    Config options for search
  - setSearchConfiguration
```
 abstract Unit setSearchConfiguration(SearchConfiguration searchConfiguration)
```
    Config options for search