nutrient/com.pspdfkit.ui.search/SearchResultHighlighter

SearchResultHighlighter

class SearchResultHighlighter(context: Context) : PdfDrawableProvider

PdfDrawableProvider creating highlights based on a list of SearchResult instances.

Constructors

constructor(context: Context)

Functions

addSearchResults

fun addSearchResults(results: List<SearchResult>)

Adds the given results to the set of previously added results. In contrast to setSearchResults a call to this will not clear previously set results. Also any previously selected search result will not be cleared.

clearSearchResults

fun clearSearchResults()

Clears all previously selected search results.

getDrawablesForPage

open suspend override fun getDrawablesForPage(context: Context, document: PdfDocument, @IntRange(from = 0) pageIndex: Int): List<ERROR CLASS: Symbol not found for PdfDrawable>

Returns all drawables for the given document and pageIndex. The framework may call this method on any thread.

getSearchResultAnimationPadding

@IntRange(from = 0)

fun getSearchResultAnimationPadding(): Int

Returns padding of the highlighted search result used when pop-out animating the currently selected search result. This defaults to R.dimen.pspdf__search_result_animation_padding.

getSearchResultAnnotationPadding

@IntRange(from = 0)

fun getSearchResultAnnotationPadding(): Int

Returns padding of the highlighted search result used when highlighting annotations. This defaults to R.dimen.pspdf__search_result_annotation_padding.

getSearchResultBackgroundColor

@ColorInt

fun getSearchResultBackgroundColor(): Int

Returns color of the highlighted search result. This defaults to R.color.pspdf__color_highlight.

getSearchResultBorderColor

@ColorInt

fun getSearchResultBorderColor(): Int

Returns border color of the highlighted search result. This defaults to R.color.pspdf__border_color_highlight.

getSearchResultBorderWidth

@IntRange(from = 0)

fun getSearchResultBorderWidth(): Int

Returns border width of the highlighted search result. This defaults to R.dimen.pspdf__search_result_border_width.

getSearchResultCornerRadiusToHeightRatio

@FloatRange(from = 0.0)

fun getSearchResultCornerRadiusToHeightRatio(): Float

Returns ratio between corner radius of the search result rectangle and its height. This defaults to 0.1f.

getSearchResultMaxCornerRadius

@IntRange(from = 0)

fun getSearchResultMaxCornerRadius(): Int

Returns maximal corner radius of the highlighted search result. This defaults to R.dimen.pspdf__search_result_max_corner_radius.

getSearchResultMinCornerRadius

@IntRange(from = 0)

fun getSearchResultMinCornerRadius(): Int

Returns minimal corner radius of the highlighted search result. This defaults to R.dimen.pspdf__search_result_min_corner_radius.

getSearchResultPadding

@IntRange(from = 0)

fun getSearchResultPadding(): Int

Returns padding of the the highlighted search result used when highlighting document text. This defaults to R.dimen.pspdf__search_result_padding.

setSearchResultAnimationPadding

fun setSearchResultAnimationPadding(@IntRange(from = 0) searchResultAnimationPadding: Int)

Sets padding of the highlighted search result used when pop-out animating the currently selected search result. Once you've set this property, you need to call getDrawablesForPage in order to get search highlight drawables with latest properties applied.

setSearchResultAnnotationPadding

fun setSearchResultAnnotationPadding(@IntRange(from = 0) searchResultAnnotationPadding: Int)

Sets padding of the highlighted search result used when highlighting annotations. Once you've set this property, you need to call getDrawablesForPage in order to get search highlight drawables with latest properties applied.

setSearchResultBackgroundColor

fun setSearchResultBackgroundColor(@ColorInt searchResultBackgroundColor: Int)

Sets color of the highlighted search result. Once you've set this property, you need to call getDrawablesForPage in order to get search highlight drawables with latest properties applied.

setSearchResultBorderColor

fun setSearchResultBorderColor(@ColorInt searchResultBorderColor: Int)

Sets border color of the highlighted search result. Once you've set this property, you need to call getDrawablesForPage in order to get search highlight drawables with latest properties applied.

setSearchResultBorderWidth

fun setSearchResultBorderWidth(@IntRange(from = 0) searchResultBorderWidth: Int)

Sets border width of the highlighted search result. Once you've set this property, you need to call getDrawablesForPage in order to get search highlight drawables with latest properties applied.

setSearchResultCornerRadiusToHeightRatio

fun setSearchResultCornerRadiusToHeightRatio(@FloatRange(from = 0.0) searchResultCornerRadiusToHeightRatio: Float)

Sets ratio between corner radius of the search result rectangle and its height. Once you've set this property, you need to call getDrawablesForPage in order to get search highlight drawables with latest properties applied.

setSearchResultMaxCornerRadius

fun setSearchResultMaxCornerRadius(@IntRange(from = 0) searchResultMaxCornerRadius: Int)

Sets maximal corner radius of the highlighted search result. Once you've set this property, you need to call getDrawablesForPage in order to get search highlight drawables with latest properties applied.

setSearchResultMinCornerRadius

fun setSearchResultMinCornerRadius(@IntRange(from = 0) searchResultMinCornerRadius: Int)

Sets minimal corner radius of the highlighted search result. Once you've set this property, you need to call getDrawablesForPage in order to get search highlight drawables with latest properties applied.

setSearchResultPadding

fun setSearchResultPadding(@IntRange(from = 0) searchResultPadding: Int)

Sets padding of the the highlighted search result used when highlighting document text. Once you've set this property, you need to call getDrawablesForPage in order to get search highlight drawables with latest properties applied.

setSearchResults

fun setSearchResults(results: List<SearchResult>)

Sets new search results. Calling this will replace any previously set search results and also clear the currently selected search result.

setSelectedSearchResult

fun setSelectedSearchResult(newSelectedSearchResult: SearchResult?)

Marks a single search results as selected, deselecting any previously selected search result. Callers must ensure that the selected search results has been set previously using setSearchResults or an exception will be thrown.