Class NotebookSearchProvider

Notebook document search provider

Hierarchy (View Summary)

SearchProvider<NotebookPanel>
- NotebookSearchProvider

Constructors

constructor

new NotebookSearchProvider(
widget: NotebookPanel,
translator?: ITranslator,
): 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

`Protected`_filtersChanged

_filtersChanged: Signal<NotebookSearchProvider, void>

`Protected`_stateChanged

_stateChanged: Signal<NotebookSearchProvider, void>

`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

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

highlightPrevious

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

replaceAllMatches

replaceAllMatches(newText: string, options?: IReplaceOptions): Promise<boolean>
Replace all matches in the notebook with the provided text
Parameters
- newText: string
  The replacement text.
- Optionaloptions: 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: string,
    loop?: boolean,
    options?: IReplaceOptions,
): 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.
- Optionaloptions: 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: RegExp, filters: undefined | IFilters): 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: string, value: boolean): Promise<boolean>
Parameters
- name: string
- value: boolean
Returns Promise<boolean>
- Defined in packages/notebook/src/searchprovider.ts:498

`Static`createNew

createNew(widget: NotebookPanel, translator?: ITranslator): 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
- Optionaltranslator: 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: Widget): 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: string, newText: string): 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 Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns NotebookSearchProvider

Properties

Protected_filtersChanged

Protected_stateChanged

ProtecteddelayedActiveCellChangeHandlerReady

Protectedtranslator

Protectedwidget

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

clearHighlight

Returns Promise<void>

dispose

Notes

Undefined Behavior

Returns void

endQuery

Returns Promise<void>

getFilters

Returns { [key: string]: IFilter }

getInitialQuery

Returns string

getSelectionState

Returns SelectionState

highlightNext

Parameters

Returns Promise<undefined | ISearchMatch>

highlightPrevious

Parameters

Returns Promise<undefined | ISearchMatch>

replaceAllMatches

Parameters

Returns Promise<boolean>

replaceCurrentMatch

Parameters

Returns Promise<boolean>

startQuery

Parameters

Returns Promise<void>

validateFilter

Parameters

Returns Promise<boolean>

StaticcreateNew

Notes

Parameters

Returns ISearchProvider

StaticisApplicable

Parameters

Returns domain is NotebookPanel

StaticpreserveCase

Parameters

Returns string

Settings

On This Page

`Protected`_filtersChanged

`Protected`_stateChanged

`Protected`delayedActiveCellChangeHandlerReady

`Protected`translator

`Protected`widget

`Static`createNew

`Static`isApplicable

`Static`preserveCase