Constructor
The widget to search in
Application translator
Private
_currentPrivate
_delayedPrivate
_editorPrivate
_filtersProtected
_filtersPrivate
_onPrivate
_queryPrivate
_searchPrivate
_searchPrivate
_selectedPrivate
_selectedPrivate
_selectionPrivate
_selectionProtected
_statePrivate
_textProtected
delayedProtected
translatorApplication translator
Protected
widgetThe widget to search in
The current index of the selected match.
Whether the search provider is disposed or not.
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.
The number of matches.
Support for options adjusting replacement behavior.
Private
_addPrivate
_ensurePrivate
_handlePrivate
_observePrivate
_onPrivate
_onPrivate
_onPrivate
_onPrivate
_removePrivate
_setPrivate
_setPrivate
_stepOptional
options: IHighlightAdjacentMatchOptionsPrivate
_stopPrivate
_updatePrivate
_updateUpdate the search in selection mode; it should only be called when user navigates the notebook (enters editing/command mode, changes selection) but not when the searchbox gets focused (switching the notebook to command mode) nor when search highlights a match (switching notebook to edit mode).
Dispose of the resources held by the search provider.
If the object's dispose
method is called more than once, all
calls made after the first will be a no-op.
It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.
Highlight the next match.
Whether to loop within the matches list.
Optional
options: IHighlightAdjacentMatchOptionsThe next match if available.
Highlight the previous match.
Whether to loop within the matches list.
Optional
options: IHighlightAdjacentMatchOptionsThe previous match if available.
Replace all matches in the notebook with the provided text
The replacement text.
Optional
options: IReplaceOptionsA promise that resolves with a boolean indicating whether a replace occurred.
Replace the currently selected match with the provided text
The replacement text.
Whether to loop within the matches list.
Optional
options: IReplaceOptionsA promise that resolves with a boolean indicating whether a replace occurred.
Static
createInstantiate a search provider for the notebook panel.
The widget provided is always checked using isApplicable
before calling
this factory.
The widget to search on
Optional
translator: ITranslator[optional] The translator object
The search provider on the notebook panel
Static
isReport whether or not this provider has the ability to search on the given object
Widget to test
Search ability
Static
preserve
Notebook document search provider