Class NotebookSearchProvider

Notebook document search provider

Hierarchy (view full)

SearchProvider<NotebookPanel>
- NotebookSearchProvider

Index

Constructors

Properties

_currentProviderIndex _delayedActiveCellChangeHandler _editorSelectionsObservable _filters _filtersChanged _onSelection _query _searchActive _searchProviders _selectedCells _selectedLines _selectionLock _selectionSearchMode _stateChanged _textSelection delayedActiveCellChangeHandlerReady translator widget

Accessors

currentMatchIndex filtersChanged isDisposed isReadOnly matchesCount replaceOptionsSupport stateChanged

Constructors

constructor

new NotebookSearchProvider(widget, translator?): NotebookSearchProvider
Constructor
Parameters
- widget: NotebookPanel
  The widget to search in
- translator: ITranslator = nullTranslator
  Application translator
Returns NotebookSearchProvider
Overrides SearchProvider.constructor
- Defined in packages/notebook/src/searchprovider.ts:43

Properties

`Private` _currentProviderIndex

_currentProviderIndex: null | number = null

`Private` _delayedActiveCellChangeHandler

_delayedActiveCellChangeHandler: null | number = null

`Private` _editorSelectionsObservable

_editorSelectionsObservable: null | IObservableMap<ITextSelection[]> = null

`Private` _filters

_filters: undefined | IFilters

`Protected` _filtersChanged

_filtersChanged: Signal<NotebookSearchProvider, void>

`Private` _onSelection

_onSelection: boolean = false

`Private` _query

_query: null | RegExp = null

`Private` _searchActive

_searchActive: boolean = false

`Private` _searchProviders

_searchProviders: CellSearchProvider[] = []

`Private` _selectedCells

_selectedCells: number = 1

`Private` _selectedLines

_selectedLines: number = 0

`Private` _selectionLock

_selectionLock: boolean = false

`Private` _selectionSearchMode

_selectionSearchMode: "text" | "cells" = 'cells'

`Protected` _stateChanged

_stateChanged: Signal<NotebookSearchProvider, void>

`Private` _textSelection

_textSelection: null | IRange = null

`Protected` delayedActiveCellChangeHandlerReady

delayedActiveCellChangeHandlerReady: Promise<void>

`Protected` translator

translator: ITranslator = nullTranslator

Application translator

`Protected` widget

widget: NotebookPanel

The widget to search in

Accessors

currentMatchIndex

get currentMatchIndex(): null | number
The current index of the selected match.

Returns null | number
Overrides SearchProvider.currentMatchIndex
- Defined in packages/notebook/src/searchprovider.ts:119

filtersChanged

get filtersChanged(): ISignal<this, void>
Signal indicating that filter definition changed.

Returns ISignal<this, void>
Inherited from SearchProvider.filtersChanged
- Defined in packages/documentsearch/lib/searchprovider.d.ts:22

isDisposed

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

Returns boolean
Inherited from SearchProvider.isDisposed
- Defined in packages/documentsearch/lib/searchprovider.d.ts:30

isReadOnly

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
Overrides SearchProvider.isReadOnly
- Defined in packages/notebook/src/searchprovider.ts:154

matchesCount

get matchesCount(): null | number
The number of matches.

Returns null | number
Overrides SearchProvider.matchesCount
- Defined in packages/notebook/src/searchprovider.ts:142

replaceOptionsSupport

get replaceOptionsSupport(): IReplaceOptionsSupport
Support for options adjusting replacement behavior.

Returns IReplaceOptionsSupport
- Defined in packages/notebook/src/searchprovider.ts:161

stateChanged

get stateChanged(): ISignal<this, void>
Signal indicating that something in the search has changed, so the UI should update

Returns ISignal<this, void>
Inherited from SearchProvider.stateChanged
- Defined in packages/documentsearch/lib/searchprovider.d.ts:18

Methods

`Private` _addCellProvider

_addCellProvider(index): void
Parameters
- index: number
Returns void
- Defined in packages/notebook/src/searchprovider.ts:537

`Private` _ensureCurrentMatch

_ensureCurrentMatch(): Promise<void>
If there are results but no match is designated as current, mark a result as current and highlight it.

Returns Promise<void>
- Defined in packages/notebook/src/searchprovider.ts:781

`Private` _handleHighlightsAfterActiveCellChange

_handleHighlightsAfterActiveCellChange(): Promise<void>
Returns Promise<void>
- Defined in packages/notebook/src/searchprovider.ts:751

`Private` _observeActiveCell

_observeActiveCell(): void
Returns void
- Defined in packages/notebook/src/searchprovider.ts:801

`Private` _onActiveCellChanged

_onActiveCellChanged(): Promise<void>
Returns Promise<void>
- Defined in packages/notebook/src/searchprovider.ts:729

`Private` _onCellSelectionChanged

_onCellSelectionChanged(): Promise<void>
Returns Promise<void>
- Defined in packages/notebook/src/searchprovider.ts:878

`Private` _onCellsChanged

_onCellsChanged(cells, changes): Promise<void>
Parameters
- cells: CellList
- changes: IObservableList.IChangedArgs<ICellModel>
Returns Promise<void>
- Defined in packages/notebook/src/searchprovider.ts:560

`Private` _onNotebookStateChanged

_onNotebookStateChanged(_, args): void
Parameters
- _: Notebook
- args: IChangedArgs<any, any, string>
Returns void
- Defined in packages/notebook/src/searchprovider.ts:68

`Private` _removeCellProvider

_removeCellProvider(index): void
Parameters
- index: number
Returns void
- Defined in packages/notebook/src/searchprovider.ts:555

`Private` _setEnginesSelectionSearchMode

_setEnginesSelectionSearchMode(): Promise<void>
Set whether the engines should search within selection only or full text.

Returns Promise<void>
- Defined in packages/notebook/src/searchprovider.ts:849

`Private` _setSelectedLines

_setSelectedLines(): void
Returns void
- Defined in packages/notebook/src/searchprovider.ts:821

`Private` _stepNext

_stepNext(reverse?, loop?, options?): Promise<null | ISearchMatch>
Parameters
- reverse: boolean = false
- loop: boolean = false
- Optional options: IHighlightAdjacentMatchOptions
Returns Promise<null | ISearchMatch>
- Defined in packages/notebook/src/searchprovider.ts:593

`Private` _stopObservingLastCell

_stopObservingLastCell(): void
Returns void
- Defined in packages/notebook/src/searchprovider.ts:812

`Private` _updateCellSelection

_updateCellSelection(): Promise<void>
Returns Promise<void>
- Defined in packages/notebook/src/searchprovider.ts:897

`Private` _updateSelectionMode

_updateSelectionMode(): void
Update 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).

Returns void
- Defined in packages/notebook/src/searchprovider.ts:270

clearHighlight

clearHighlight(): Promise<void>
Clear currently highlighted match.

Returns Promise<void>
Overrides SearchProvider.clearHighlight
- Defined in packages/notebook/src/searchprovider.ts:296

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
Overrides SearchProvider.dispose
- Defined in packages/notebook/src/searchprovider.ts:188

endQuery

endQuery(): Promise<void>
Stop the search and clear all internal state.

Returns Promise<void>
Overrides SearchProvider.endQuery
- Defined in packages/notebook/src/searchprovider.ts:413

getFilters

getFilters(): {
[key: string]: IFilter;
}
Get the filters for the given provider.

Returns {
[key: string]: IFilter;
}
The filters.
- [key: string]: IFilter
Overrides SearchProvider.getFilters
- Defined in packages/notebook/src/searchprovider.ts:229

getInitialQuery

getInitialQuery(): string
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.
Overrides SearchProvider.getInitialQuery
- Defined in packages/notebook/src/searchprovider.ts:288

getSelectionState

getSelectionState(): SelectionState
Returns SelectionState
- Defined in packages/notebook/src/searchprovider.ts:167

highlightNext

highlightNext(loop?, options?): Promise<undefined | ISearchMatch>
Highlight the next match.
Parameters
- loop: boolean = true
  Whether to loop within the matches list.
- Optional options: IHighlightAdjacentMatchOptions
Returns Promise<undefined | ISearchMatch>
The next match if available.
Overrides SearchProvider.highlightNext
- Defined in packages/notebook/src/searchprovider.ts:315

highlightPrevious

highlightPrevious(loop?, options?): Promise<undefined | ISearchMatch>
Highlight the previous match.
Parameters
- loop: boolean = true
  Whether to loop within the matches list.
- Optional options: IHighlightAdjacentMatchOptions
Returns Promise<undefined | ISearchMatch>
The previous match if available.
Overrides SearchProvider.highlightPrevious
- Defined in packages/notebook/src/searchprovider.ts:330

replaceAllMatches

replaceAllMatches(newText, options?): Promise<boolean>
Replace all matches in the notebook with the provided text
Parameters
- newText: string
  The replacement text.
- Optional options: IReplaceOptions
Returns Promise<boolean>
A promise that resolves with a boolean indicating whether a replace occurred.
Overrides SearchProvider.replaceAllMatches
- Defined in packages/notebook/src/searchprovider.ts:486

replaceCurrentMatch

replaceCurrentMatch(newText, loop?, options?): Promise<boolean>
Replace the currently selected match with the provided text
Parameters
- newText: string
  The replacement text.
- loop: boolean = true
  Whether to loop within the matches list.
- Optional options: IReplaceOptions
Returns Promise<boolean>
A promise that resolves with a boolean indicating whether a replace occurred.
Overrides SearchProvider.replaceCurrentMatch
- Defined in packages/notebook/src/searchprovider.ts:435

startQuery

startQuery(query, filters): Promise<void>
Search for a regular expression with optional filters.
Parameters
- query: RegExp
  A regular expression to test for
- filters: undefined | IFilters
  Filter parameters to pass to provider
Returns Promise<void>
Overrides SearchProvider.startQuery
- Defined in packages/notebook/src/searchprovider.ts:345

validateFilter

validateFilter(name, value): Promise<boolean>
Parameters
- name: string
- value: boolean
Returns Promise<boolean>
- Defined in packages/notebook/src/searchprovider.ts:498

`Static` createNew

createNew(widget, translator?): ISearchProvider
Instantiate a search provider for the notebook panel.

Notes
The widget provided is always checked using isApplicable before calling this factory.
Parameters
- widget: NotebookPanel
  The widget to search on
- Optional translator: ITranslator
  [optional] The translator object
Returns ISearchProvider
The search provider on the notebook panel
- Defined in packages/notebook/src/searchprovider.ts:109

`Static` isApplicable

isApplicable(domain): domain is NotebookPanel
Report whether or not this provider has the ability to search on the given object
Parameters
- domain: Widget
  Widget to test
Returns domain is NotebookPanel
Search ability
- Defined in packages/notebook/src/searchprovider.ts:91

`Static` preserveCase

preserveCase(oldText, newText): string
Utility for copying the letter case from old to new text.
Parameters
- oldText: string
- newText: string
Returns string
Inherited from SearchProvider.preserveCase
- Defined in packages/documentsearch/lib/searchprovider.d.ts:117

Class NotebookSearchProvider

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns NotebookSearchProvider

Properties

Private _currentProviderIndex

Private _delayedActiveCellChangeHandler

Private _editorSelectionsObservable

Private _filters

Protected _filtersChanged

Private _onSelection

Private _query

Private _searchActive

Private _searchProviders

Private _selectedCells

Private _selectedLines

Private _selectionLock

Private _selectionSearchMode

Protected _stateChanged

Private _textSelection

Protected delayedActiveCellChangeHandlerReady

Protected translator

Protected widget

Accessors

currentMatchIndex

Returns null | number

filtersChanged

Returns ISignal<this, void>

isDisposed

Returns boolean

isReadOnly

Returns boolean

matchesCount

Returns null | number

replaceOptionsSupport

Returns IReplaceOptionsSupport

stateChanged

Returns ISignal<this, void>

Methods

Private _addCellProvider

Parameters

Returns void

Private _ensureCurrentMatch

Returns Promise<void>

Private _handleHighlightsAfterActiveCellChange

Returns Promise<void>

Private _observeActiveCell

Returns void

Private _onActiveCellChanged

Returns Promise<void>

Private _onCellSelectionChanged

Returns Promise<void>

Private _onCellsChanged

Parameters

Returns Promise<void>

Private _onNotebookStateChanged

Parameters

Returns void

Private _removeCellProvider

Parameters

Returns void

Private _setEnginesSelectionSearchMode

Returns Promise<void>

Private _setSelectedLines

Returns void

Private _stepNext

Parameters

Returns Promise<null | ISearchMatch>

Private _stopObservingLastCell

Returns void

Private _updateCellSelection

Returns Promise<void>

Private _updateSelectionMode

`Private` _currentProviderIndex

`Private` _delayedActiveCellChangeHandler

`Private` _editorSelectionsObservable

`Private` _filters

`Protected` _filtersChanged

`Private` _onSelection

`Private` _query

`Private` _searchActive

`Private` _searchProviders

`Private` _selectedCells

`Private` _selectedLines

`Private` _selectionLock

`Private` _selectionSearchMode

`Protected` _stateChanged

`Private` _textSelection

`Protected` delayedActiveCellChangeHandlerReady

`Protected` translator

`Protected` widget

`Private` _addCellProvider

`Private` _ensureCurrentMatch

`Private` _handleHighlightsAfterActiveCellChange

`Private` _observeActiveCell

`Private` _onActiveCellChanged

`Private` _onCellSelectionChanged

`Private` _onCellsChanged

`Private` _onNotebookStateChanged

`Private` _removeCellProvider

`Private` _setEnginesSelectionSearchMode

`Private` _setSelectedLines

`Private` _stepNext

`Private` _stopObservingLastCell

`Private` _updateCellSelection

`Private` _updateSelectionMode

Returns {
[key: string]: IFilter;
}

`Static` createNew

`Static` isApplicable

`Static` preserveCase