TextSearchResult class

Represents a single text search result within a publication. Contains a Locator to the location of the search result, an optional chapter title, and optional page numbers. This class was created to provide a simpler structure rather than sending full LocatorCollection over the bridge.

Implemented types

• JSONable

Available extensions

• TextSearchResultExtension

Constructors

TextSearchResult({required Locator locator, String? chapterTitle, List<String>? pageNumbers})

const

TextSearchResult.fromJson(Map<String, dynamic>? json)

factory

Properties

chapterTitle → String?

final

hashCode → int

The hash code for this object.

no setter, inherited

locator → Locator

final

pageNumbers → List<String>?

final

props → List<Object?>

The list of properties that will be used to determine whether two instances are equal.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

stringify → bool?

If set to true, the toString method will be overridden to output this instance's props.

no setter, inherited

text → LocatorText?

Available on TextSearchResult, provided by the TextSearchResultExtension extension

no setter

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

Serializes the object to its JSON representation.

override

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

fromJsonDynamic(dynamic json) → TextSearchResult?

fromJsonString(String jsonString) → TextSearchResult?