pspdfkit/com.pspdfkit.ui.search/PdfSearchViewModular

PdfSearchViewModular

class PdfSearchViewModular : AbstractPdfSearchView, PSPDFKitViews.PSPDFView

Search view sitting inside a panel that slides in above the rest of the content.

Constructors

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

Properties

Link copied to clipboard
@ColorInt
@get:ColorInt
open var backgroundColor: Int
Modular search view background color.
Link copied to clipboard
@ColorInt
@get:ColorInt
open var highlightBackgroundColor: Int
Background color of the highlighted search result.
Link copied to clipboard
@ColorInt
@get:ColorInt
open var highlightBorderColor: Int
Border color of the highlighted search result.
Link copied to clipboard
@ColorInt
@get:ColorInt
open var highlightTextColor: Int
Text color of the highlighted text result.
Link copied to clipboard
@ColorInt
@get:ColorInt
open var inputFieldBackgroundColor: Int
Search input field background color.
Link copied to clipboard
@ColorInt
@get:ColorInt
open var inputFieldHintColor: Int
Search input field hint text color.
Link copied to clipboard
@ColorInt
@get:ColorInt
open var inputFieldTextColor: Int
Search input field text color.
Link copied to clipboard
open val isDisplayed: Boolean
Link copied to clipboard
@ColorInt
@get:ColorInt
open var listItemBackgroundColor: Int
Background color of the list item.
Link copied to clipboard
@ColorInt
@get:ColorInt
open var listItemSubtitleColor: Int
List item subtitle (snippet) text color.
Link copied to clipboard
@ColorInt
@get:ColorInt
open var listItemTitleColor: Int
List item title (page) text color.
Link copied to clipboard
@DrawableRes
@get:DrawableRes
open var listSelector: Int
Selector for the search result list.
Link copied to clipboard
@ColorInt
@get:ColorInt
open var separatorColor: Int
Color of the input field and results list separator line.

Functions

Link copied to clipboard
open fun hide()
Hides the modular search view.
Link copied to clipboard
open fun isIdle(): Boolean
Link copied to clipboard
open fun onMoreSearchResults(@NonNull results: List<SearchResult>)
Called when another chunk of search results is ready.
Link copied to clipboard
open fun onSearchCanceled()
Called when search has been cancelled.
Link copied to clipboard
open fun onSearchComplete()
Called when searching has finished.
Link copied to clipboard
open fun onSearchError(@NonNull ex: Throwable)
Called in case of an error that prevented searching the document.
Link copied to clipboard
open fun onSearchStarted(@NonNull query: String)
Called when a fresh search has been started.
Link copied to clipboard
open fun onTouchEvent(@NonNull event: MotionEvent): Boolean
Link copied to clipboard
open fun performClick(): Boolean
Link copied to clipboard
open fun setShowPageLabels(showPageLabels: Boolean)
Link copied to clipboard
open fun show()
Shows the modular search view.