colibrio-reader-framework/com.colibrio.readingsystem.base/TextSearchResultOptions

TextSearchResultOptions

data class TextSearchResultOptions(val expandMode: TextSearchResultExpandMode = TextSearchResultExpandMode.EXPAND_TO_WORD_BOUNDARY, val numberOfCharactersAfter: Int = 40, val numberOfCharactersBefore: Int = 40)

Options object controlling the data available in search result items

Constructors

Link copied to clipboard
fun TextSearchResultOptions(expandMode: TextSearchResultExpandMode = TextSearchResultExpandMode.EXPAND_TO_WORD_BOUNDARY, numberOfCharactersAfter: Int = 40, numberOfCharactersBefore: Int = 40)

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
fun serialize(generator: JsonGenerator)

Properties

Link copied to clipboard
val expandMode: TextSearchResultExpandMode

This option controls how the text in SearchResultItem.textBefore and the SearchResultItem.textAfter is computed. This property is related to the options numberOfCharactersAfter and numberOfCharactersBefore

Link copied to clipboard
val numberOfCharactersAfter: Int = 40

Number of UTF-16/UCS-2 char codes after the match that should be included in the textAfter property in SearchResultItems.

Link copied to clipboard
val numberOfCharactersBefore: Int = 40

Number of UTF-16/UCS-2 char codes before the match that should be included in the textBefore property in SearchResultItems.