pspdfkit/com.pspdfkit.ui.search/PdfSearchViewLazy

PdfSearchViewLazy

open class PdfSearchViewLazy : DocumentListenerFrameLayout, PdfSearchView

Lazy implementation of the PdfSearchView interface. Initializes once shown or made visible.

Override createSearchView to return different search implementation.

Constructors

Link copied to clipboard
constructor(@NonNull context: Context)
constructor(@NonNull context: Context, @Nullable attrs: AttributeSet)
constructor(@NonNull context: Context, @Nullable attrs: AttributeSet, defStyleAttr: Int)
constructor(@NonNull context: Context, @Nullable attrs: AttributeSet, defStyleAttr: Int, defStyleRes: Int)

Types

Link copied to clipboard
interface OnViewReadyListener
Listener notified once the lazy view is initialized.

Functions

Link copied to clipboard
open fun addOnVisibilityChangedListener(@NonNull listener: OnVisibilityChangedListener)
Register a listener that would like to receive visibility change events.
Link copied to clipboard
open fun clearDocument()
Called by the activity when the view should unbind the previously set document.
Link copied to clipboard
open fun clearSearch()
Clears the search input field as well as any previously collected search results.
Link copied to clipboard
@NonNull
open fun createSearchView(): PdfSearchView
Factory method called when the search view is being prepared for display.
Link copied to clipboard
@NonNull
open fun getPSPDFViewType(): PSPDFKitViews.Type
Returns the current type of this view.
Link copied to clipboard
@NonNull
open fun getSearchConfiguration(): SearchConfiguration
Config options for search
Link copied to clipboard
@NonNull
open fun getSearchView(): PdfSearchView
Returns the active search view (if initialized).
Link copied to clipboard
open fun hide()
Called by the activity when the view should hide itself.
Link copied to clipboard
open fun isDisplayed(): Boolean
Called when the activity needs to know the visibility of this view.
Link copied to clipboard
open fun isShown(): Boolean
Link copied to clipboard
open fun onPageChanged(@NonNull document: PdfDocument, pageIndex: Int)
Called when user scrolled to a new page.
Link copied to clipboard
@NonNull
open fun prepareForDisplay(): PdfSearchView
Prepares the lazy initialized search view for display.
Link copied to clipboard
open fun removeOnVisibilityChangedListener(@NonNull listener: OnVisibilityChangedListener)
Unregister a previously registered listener that no longer wants to receive visibility change events.
Link copied to clipboard
open fun setDocument(@NonNull document: PdfDocument, @NonNull configuration: PdfConfiguration)
Called when the document has been loaded and is going to be displayed.
Link copied to clipboard
open fun setInputFieldText(@NonNull text: String, startSearch: Boolean)
Inserts text in search input field and optionally starts search.
Link copied to clipboard
open fun setOnViewReadyListener(@Nullable listener: PdfSearchViewLazy.OnViewReadyListener)
Sets listener that will get notified once the lazy view is ready.
Link copied to clipboard
open fun setSearchConfiguration(@NonNull searchConfiguration: SearchConfiguration)
Config options for search
Link copied to clipboard
open fun setSearchViewListener(@Nullable searchViewListener: PdfSearchView.Listener)
Sets a listener to be notified of search events on this view.
Link copied to clipboard
open fun setVisibility(visibility: Int)
Link copied to clipboard
open fun show()
Called by the activity when the view should make itself visible.