Package com.pspdfkit.ui.search

Interface PdfSearchView

    • 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 callingisShown on the search view.
      abstract void clearSearch() Clears the search input field as well as any previously collected search results.
      abstract void setInputFieldText(@NonNull() String text, boolean startSearch) Inserts text in search input field and optionally starts search.
      abstract void setSearchViewListener(@Nullable() PdfSearchView.Listener searchViewListener) Sets a listener to be notified of search events on this view.
      abstract void setSearchConfiguration(@NonNull() SearchConfiguration searchConfiguration) Sets the search configuration to this search view.

      • 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 callingisShown on the search view.

        Returns:

        true if search view is shown, false otherwise.

      • clearSearch

         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.

      • setInputFieldText

         abstract void setInputFieldText(@NonNull() 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 void setSearchViewListener(@Nullable() 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.