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

TextSearchResultExpandMode

enum TextSearchResultExpandMode : Enum<TextSearchResultExpandMode>

Used with ITextSearchResultOptions, describing how the text in SearchResultItem.textBefore and the SearchResultItem.textAfter is computed.

Entries

NO_EXPAND

Returns the exact number of characters (if available) as defined in numberOfCharactersAfter and numberOfCharactersBefore. This can result in words being sliced in the middle.

EXPAND_TO_WORD_BOUNDARY

If text ends within a word, this mode expands to the nearest word boundary (whitespace).

EXPAND_TO_CONTENT_BLOCK_BOUNDARY

This mode expands the text to the nearest IContentBlock boundary.

Types

Companion

object Companion

Properties

entries

val entries: EnumEntries<TextSearchResultExpandMode>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

value

val value: String

Functions

serialize

fun serialize(generator: JsonGenerator)

valueOf

fun valueOf(value: String): TextSearchResultExpandMode

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<TextSearchResultExpandMode>

Returns an array containing the constants of this enum type, in the order they're declared.