colibrio-reader-framework/com.colibrio.readingsystem.search/ReaderDocumentSearch

ReaderDocumentSearch

interface ReaderDocumentSearch

This interface serves as an entry-point for all APIs related to searching in ReaderDocuments.

You can retrieve an instance of this interface though ReadingSystemEngine.readerDocumentSearch.

Functions

Link copied to clipboard
abstract fun createReaderViewSearchAgent(annotationLayer: ReaderViewAnnotationLayer): ReaderViewSearchAgent

Creates a new ReaderViewSearchAgent using the specified annotationLayer. Use a ReaderViewSearchAgent to highlight search matches in the ReaderView.

Link copied to clipboard
abstract fun createTextQuery(queryString: String, options: TextSearchQueryOptions = TextSearchQueryOptions()): ReaderDocumentSearchQuery

Creates a new text search query using the specified queryString. The search will be performed using a variant of exact matching, but with special handling for whitespace and case-sensitivity, etc. Please see TextSearchQueryOptions for available options. No control words such as "AND" or "OR" is supported.

Link copied to clipboard
abstract fun destroyReaderViewSearchAgent(agent: ReaderViewSearchAgent)

Destroys a ReaderViewSearchAgent previously created with createReaderViewSearchAgent. This will cause the agent to remove all ReaderViewAnnotations it has created, and release any used resources.