Class GenericSearchProvider

constructor

• new GenericSearchProvider(widget: Widget): GenericSearchProvider

• Constructor

  Parameters

  • widget: Widget

    The widget to search in

  Returns GenericSearchProvider

ReadonlyisReadOnly

currentMatch

• get currentMatch(): null | IHTMLSearchMatch

• The current match

  Returns null | IHTMLSearchMatch

currentMatchIndex

• get currentMatchIndex(): null | number

• The current index of the selected match.

  Returns null | number

matches

• get matches(): IHTMLSearchMatch[]

• The current matches

  Returns IHTMLSearchMatch[]

matchesCount

• get matchesCount(): null | number

• The number of matches.

  Returns null | number

clearHighlight

• clearHighlight(): Promise<void>

• Clear currently highlighted match.

  Returns Promise<void>

dispose

• dispose(): void

• Dispose of the resources held by the search provider.

  Notes

  If the object's dispose method is called more than once, all calls made after the first will be a no-op.

  Undefined Behavior

  It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

  Returns void

endQuery

• endQuery(): Promise<void>

• Clear the highlighted matches and any internal state.

  Returns Promise<void>

highlightNext

• highlightNext(loop?: boolean): Promise<undefined | IHTMLSearchMatch>

• Move the current match indicator to the next match.

  Parameters

  • Optionalloop: boolean

    Whether to loop within the matches list.

  Returns Promise<undefined | IHTMLSearchMatch>

  A promise that resolves once the action has completed.

highlightPrevious

• highlightPrevious(loop?: boolean): Promise<undefined | IHTMLSearchMatch>

• Move the current match indicator to the previous match.

  Parameters

  • Optionalloop: boolean

    Whether to loop within the matches list.

  Returns Promise<undefined | IHTMLSearchMatch>

  A promise that resolves once the action has completed.

replaceAllMatches

• replaceAllMatches(newText: string): Promise<boolean>

• Replace all matches in the notebook with the provided text

  Parameters

  • newText: string

    The replacement text

  Returns Promise<boolean>

  A promise that resolves with a boolean indicating whether a replace occurred.

replaceCurrentMatch

• replaceCurrentMatch(newText: string, loop?: boolean): Promise<boolean>

• Replace the currently selected match with the provided text

  Parameters

  • newText: string

    The replacement text
  • Optionalloop: boolean

    Whether to loop within the matches list.

  Returns Promise<boolean>

  A promise that resolves with a boolean indicating whether a replace occurred.

startQuery

• startQuery(query: null | RegExp, filters?: {}): Promise<void>

• Initialize the search using the provided options. Should update the UI to highlight all matches and "select" whatever the first match should be.

  Parameters

  • query: null | RegExp

    A RegExp to be use to perform the search
  • filters: {} = {}

    Filter parameters to pass to provider

  Returns Promise<void>

StaticcreateNew

• createNew(
      widget: Widget,
      registry: ISearchProviderRegistry,
      translator?: ITranslator,
  ): ISearchProvider

• Instantiate a generic search provider for the widget.

  Notes

  The widget provided is always checked using isApplicable before calling this factory.

  Parameters

  • widget: Widget

    The widget to search on
  • registry: ISearchProviderRegistry

    The search provider registry
  • Optionaltranslator: ITranslator

    [optional] The translator object

  Returns ISearchProvider

  The search provider on the widget

StaticisApplicable

• isApplicable(domain: Widget): boolean

• Report whether or not this provider has the ability to search on the given object

  Parameters

  • domain: Widget

  Returns boolean