Class FileEditorSearchProvider

File editor search provider





_searchActive: any
_stateChanged: Signal<IBaseSearchProvider, void>
currentIndex: number

Current match index

filters: IFilters

Current search filters

query: RegExp

Current search query


  • get currentMatchIndex(): number
  • Current match index

    Returns number

  • get editor(): CodeMirrorEditor
  • Text editor

    Returns CodeMirrorEditor

  • get isActive(): boolean
  • Whether the cell search is active.

    This is used when applying search only on selected cells.

    Returns boolean

  • get isDisposed(): boolean
  • Whether the search provider is disposed or not.

    Returns boolean

  • get isReadOnly(): boolean
  • Set to true if the widget under search is read-only, false if it is editable. Will be used to determine whether to show the replace option.

    Returns boolean

  • get matchesCount(): number
  • Number of matches in the cell.

    Returns number

  • get model(): IModel
  • Editor content model

    Returns IModel


  • Get an initial query value if applicable so that it can be entered into the search box as an initial query

    Returns string

    Initial value used to populate the search box.

  • Replace the currently selected match with the provided text.

    If no match is selected, it won't do anything.

    The caller of this method is expected to call highlightNext if after calling replaceCurrentMatch() attribute this.currentIndex is null. It is necessary to let the caller handle highlighting because this method is used in composition pattern (search engine of notebook cells) and highlighting on the composer (notebook) level needs to switch to next engine (cell) with matches.


    • newText: string

      The replacement text.

    • Optional loop: boolean
    • Optional options: IReplaceOptions

    Returns Promise<boolean>

    Whether a replace occurred.

  • Set whether user selection should be protected from modifications.

    If disabled, the selection will be updated on search and on editor focus to cover the current match. We need to protect selection from modifications for both: search in text and search in cells; since setSearchSelection is only telling us about search in text, we need to have an additional way to signal that either search in text or in cells is active, or for any other reason selection range should be protected.


    • v: boolean

    Returns void

  • Set whether search should be limitted to specified text selection.


    • selection: IRange

    Returns Promise<void>

  • Instantiate a search provider for the widget.


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


    Returns ISearchProvider

    The search provider on the widget

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


    Returns domain is FileEditorPanel

Generated using TypeDoc