Class SearchProvider<T>`Abstract`

Abstract class implementing the search provider interface.

Type Parameters

T extends Widget = Widget

Hierarchy (view full)

SearchProvider
- GenericSearchProvider

Implements

ISearchProvider

Index

Constructors

constructor

new SearchProvider<T>(widget): SearchProvider<T>
Constructor
Type Parameters
- T extends Widget = Widget
Parameters
- widget: T
  The widget to search in
Returns SearchProvider<T>
- Defined in packages/documentsearch/src/searchprovider.ts:25

Properties

`Private` _disposed

_disposed: boolean

`Protected` _filtersChanged

_filtersChanged: Signal<SearchProvider<T>, void>

`Protected` _stateChanged

_stateChanged: Signal<SearchProvider<T>, void>

`Protected` widget

widget: T

The widget to search in

Accessors

currentMatchIndex

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

Returns null | number
Implementation of ISearchProvider.currentMatchIndex
- Defined in packages/documentsearch/src/searchprovider.ts:48

filtersChanged

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

Returns ISignal<this, void>
Implementation of ISearchProvider.filtersChanged
- Defined in packages/documentsearch/src/searchprovider.ts:41

isDisposed

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

Returns boolean
Implementation of ISearchProvider.isDisposed
- Defined in packages/documentsearch/src/searchprovider.ts:55

`Abstract` 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
Implementation of ISearchProvider.isReadOnly
- Defined in packages/documentsearch/src/searchprovider.ts:71

matchesCount

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

Returns null | number
Implementation of ISearchProvider.matchesCount
- Defined in packages/documentsearch/src/searchprovider.ts:62

stateChanged

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

Returns ISignal<this, void>
Implementation of ISearchProvider.stateChanged
- Defined in packages/documentsearch/src/searchprovider.ts:34

Methods

`Abstract` clearHighlight

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

Returns Promise<void>
Implementation of ISearchProvider.clearHighlight
- Defined in packages/documentsearch/src/searchprovider.ts:131

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
Implementation of ISearchProvider.dispose
- Defined in packages/documentsearch/src/searchprovider.ts:84

`Abstract` endQuery

endQuery(): Promise<void>
Stop a search and clear any internal state of the search provider.

Returns Promise<void>
Implementation of ISearchProvider.endQuery
- Defined in packages/documentsearch/src/searchprovider.ts:126

getFilters

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

Returns {
[key: string]: IFilter;
}
The filters.

Notes
TODO For now it only supports boolean filters (represented with checkboxes)
- [key: string]: IFilter
Implementation of ISearchProvider.getFilters
- Defined in packages/documentsearch/src/searchprovider.ts:111

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.
Implementation of ISearchProvider.getInitialQuery
- Defined in packages/documentsearch/src/searchprovider.ts:99

`Abstract` highlightNext

highlightNext(): Promise<undefined | ISearchMatch>
Highlight the next match.

Returns Promise<undefined | ISearchMatch>
The next match if available
Implementation of ISearchProvider.highlightNext
- Defined in packages/documentsearch/src/searchprovider.ts:138

`Abstract` highlightPrevious

highlightPrevious(): Promise<undefined | ISearchMatch>
Highlight the previous match.

Returns Promise<undefined | ISearchMatch>
The previous match if available.
Implementation of ISearchProvider.highlightPrevious
- Defined in packages/documentsearch/src/searchprovider.ts:145

`Abstract` replaceAllMatches

replaceAllMatches(newText, options?): Promise<boolean>
Replace all matches in the widget 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.
Implementation of ISearchProvider.replaceAllMatches
- Defined in packages/documentsearch/src/searchprovider.ts:167

`Abstract` replaceCurrentMatch

replaceCurrentMatch(newText, loop?, options?): Promise<boolean>
Replace the currently selected match with the provided text
Parameters
- newText: string
  The replacement text
- Optional loop: boolean
- Optional options: IReplaceOptions
Returns Promise<boolean>
A promise that resolves with a boolean indicating whether a replace occurred.
Implementation of ISearchProvider.replaceCurrentMatch
- Defined in packages/documentsearch/src/searchprovider.ts:154

`Abstract` startQuery

startQuery(query, filters): Promise<void>
Start a search using the provided options.
Parameters
- query: RegExp
  A RegExp to be use to perform the search
- filters: IFilters
  Filter parameters to pass to provider
Returns Promise<void>
Implementation of ISearchProvider.startQuery
- Defined in packages/documentsearch/src/searchprovider.ts:121

`Static` preserveCase

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

Class SearchProvider<T>Abstract

Type Parameters

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns SearchProvider<T>

Properties

Private _disposed

Protected _filtersChanged

Protected _stateChanged

Protected widget

Accessors

currentMatchIndex

Returns null | number

filtersChanged

Returns ISignal<this, void>

isDisposed

Returns boolean

Abstract isReadOnly

Returns boolean

matchesCount

Returns null | number

stateChanged

Returns ISignal<this, void>

Methods

Abstract clearHighlight

Returns Promise<void>

dispose

Notes

Undefined Behavior

Returns void

Abstract endQuery

Returns Promise<void>

getFilters

Returns { [key: string]: IFilter; }

Notes

[key: string]: IFilter

getInitialQuery

Returns string

Abstract highlightNext

Returns Promise<undefined | ISearchMatch>

Abstract highlightPrevious

Returns Promise<undefined | ISearchMatch>

Abstract replaceAllMatches

Parameters

Returns Promise<boolean>

Abstract replaceCurrentMatch

Parameters

Returns Promise<boolean>

Abstract startQuery

Parameters

Returns Promise<void>

Static preserveCase

Parameters

Returns string

Settings

Member Visibility

Theme

On This Page

Class SearchProvider<T>`Abstract`

`Private` _disposed

`Protected` _filtersChanged

`Protected` _stateChanged

`Protected` widget

`Abstract` isReadOnly

`Abstract` clearHighlight

`Abstract` endQuery

Returns {
[key: string]: IFilter;
}

`Abstract` highlightNext

`Abstract` highlightPrevious

`Abstract` replaceAllMatches

`Abstract` replaceCurrentMatch

`Abstract` startQuery

`Static` preserveCase