nutrient/com.pspdfkit.document.search/SearchResult

SearchResult

class SearchResult : Comparable<T>

Represents a result found when searching for text.

See also

Constructors

constructor( @IntRange(from = 0) pageIndex: Int, @NonNull textBlock: TextBlock, @Nullable snippet: SearchResult.TextSnippet, @Nullable annotation: Annotation, @NonNull document: PdfDocument)

Private constructor.

Types

class TextSnippet

The TextSnippet can be extracted with a search result to present a preview text to the user.

Properties

val annotation: Annotation

Annotation that contains the search result.

val document: PdfDocument

@IntRange(from = 0)

val pageIndex: Int

Page number of the page holding the search result.

val snippet: SearchResult.TextSnippet

Search result snippet (preview text).

val textBlock: TextBlock

The search result text (containing the actual string, indices and text coordinates).

Functions

open fun compareTo(@NonNull another: SearchResult): Int

open fun create( @NonNull document: PdfDocument, @NonNull annotation: Annotation, @NonNull range: Range, @IntRange(from = 0) snippetLength: Int): SearchResult

Create an immutable search result with a preview snippet from annotation text.

open fun create( @NonNull document: PdfDocument, @IntRange(from = 0) pageIndex: Int, @NonNull range: Range, @IntRange(from = 0) snippetLength: Int): SearchResult

Creates an immutable search result with a preview snippet from page text

open fun toString(): String