Search
Generic interface for handling searching the document with a query.
Parameters
: The type of the search result
: The type of the search query
: The type of the search state
Inheritors
Functions
Returns true if the given query can/should be searched.
Returns true if the search is completed for the given query - and hence no search is needed.
Cancel the current search and clear results
Searches the document with the given query. This function will update the search state associated with this SearchActions object in the DocumentController. (e.g. calling DocumentController.textSearch.actions.search(query) will emit to the StateFlow of DocumentController.textSearch).
Mark the result at the given index as selected. This method will always update the search state of the feature.
Assigns a SearchState to the search feature, which can be used to highlight search results on the document pages. Use this method with caution, as inconsistent data can lead to unexpected behavior. If you just pass in the the status as you receive it from the search, you should be fine, but be careful when manipulating the results (e.g. removing or adding results).