Class SearchDocumentModel

Search in a document model.

Hierarchy (view full)

VDomModel
- SearchDocumentModel

Implements

IObservableDisposable

Constructors

constructor

new SearchDocumentModel(searchProvider, searchDebounceTime): SearchDocumentModel
Search document model
Parameters
- searchProvider: ISearchProvider
  Provider for the current document
- searchDebounceTime: number
  Debounce search time
Returns SearchDocumentModel
Overrides VDomModel.constructor
- Defined in packages/documentsearch/src/searchmodel.ts:28

Properties

`Private` _caseSensitive

_caseSensitive: boolean = false

`Private` _disposed

_disposed: Signal<SearchDocumentModel, void> = ...

`Private` _filters

_filters: IFilters = {}

`Private` _initialQuery

_initialQuery: string = ''

`Private` _parsingError

_parsingError: string = ''

`Private` _preserveCase

_preserveCase: boolean = false

`Private` _replaceText

_replaceText: string = ''

`Private` _searchActive

_searchActive: boolean = false

`Private` _searchDebouncer

_searchDebouncer: Debouncer<any, any, any[]>

`Private` _searchExpression

_searchExpression: string = ''

`Private` _useRegex

_useRegex: boolean = false

`Private` _wholeWords

_wholeWords: boolean = false

`Protected` searchProvider

searchProvider: ISearchProvider

Provider for the current document

`Readonly` stateChanged

stateChanged: Signal<SearchDocumentModel, void>

A signal emitted when any model state changes.

Accessors

caseSensitive

get caseSensitive(): boolean
Whether the search is case sensitive or not.

Returns boolean
- Defined in packages/documentsearch/src/searchmodel.ts:54
set caseSensitive(v): void
Parameters
- v: boolean
Returns void
- Defined in packages/documentsearch/src/searchmodel.ts:57

currentIndex

get currentIndex(): null | number
Current highlighted match index.

Returns null | number
- Defined in packages/documentsearch/src/searchmodel.ts:68

disposed

get disposed(): ISignal<this, void>
A signal emitted when the object is disposed.

Returns ISignal<this, void>
Implementation of IObservableDisposable.disposed
- Defined in packages/documentsearch/src/searchmodel.ts:75

filters

get filters(): IFilters
Filter values.

Returns IFilters
- Defined in packages/documentsearch/src/searchmodel.ts:82

filtersDefinition

get filtersDefinition(): {
[n: string]: IFilter;
}
Filter definitions for the current provider.

Returns {
[n: string]: IFilter;
}
- [n: string]: IFilter
- Defined in packages/documentsearch/src/searchmodel.ts:89

filtersDefinitionChanged

get filtersDefinitionChanged(): null | ISignal<ISearchProvider, void>
Filter definitions changed.

Returns null | ISignal<ISearchProvider, void>
- Defined in packages/documentsearch/src/searchmodel.ts:96

initialQuery

get initialQuery(): string
The initial query string.

Returns string
- Defined in packages/documentsearch/src/searchmodel.ts:103
set initialQuery(v): void
Parameters
- v: string
Returns void
- Defined in packages/documentsearch/src/searchmodel.ts:106

isDisposed

get isDisposed(): boolean
Test whether the model is disposed.

Returns boolean
Implementation of IObservableDisposable.isDisposed
Inherited from VDomModel.isDisposed
- Defined in packages/ui-components/lib/components/vdom.d.ts:184

isReadOnly

get isReadOnly(): boolean
Whether the document is read-only or not.

Returns boolean
- Defined in packages/documentsearch/src/searchmodel.ts:135

parsingError

get parsingError(): string
Parsing regular expression error message.

Returns string
- Defined in packages/documentsearch/src/searchmodel.ts:149

preserveCase

get preserveCase(): boolean
Whether to preserve case when replacing.

Returns boolean
- Defined in packages/documentsearch/src/searchmodel.ts:156
set preserveCase(v): void
Parameters
- v: boolean
Returns void
- Defined in packages/documentsearch/src/searchmodel.ts:159

replaceOptionsSupport

get replaceOptionsSupport(): undefined | IReplaceOptionsSupport
Replace options support.

Returns undefined | IReplaceOptionsSupport
- Defined in packages/documentsearch/src/searchmodel.ts:142

replaceText

get replaceText(): string
Replacement expression

Returns string
- Defined in packages/documentsearch/src/searchmodel.ts:170
set replaceText(v): void
Parameters
- v: string
Returns void
- Defined in packages/documentsearch/src/searchmodel.ts:173

searchExpression

get searchExpression(): string
Search expression

Returns string
- Defined in packages/documentsearch/src/searchmodel.ts:183
set searchExpression(v): void
Parameters
- v: string
Returns void
- Defined in packages/documentsearch/src/searchmodel.ts:186

selectionState

get selectionState(): undefined | SelectionState
Whether the selection includes a single item or multiple items; this is used by the heuristic auto-enabling "search in selection" mode.

Returns undefined if the provider does not expose this information.

Returns undefined | SelectionState
- Defined in packages/documentsearch/src/searchmodel.ts:126

suggestedInitialQuery

get suggestedInitialQuery(): string
Initial query as suggested by provider.

A common choice is the text currently selected by the user.

Returns string
- Defined in packages/documentsearch/src/searchmodel.ts:116

totalMatches

get totalMatches(): null | number
Total number of matches.

Returns null | number
- Defined in packages/documentsearch/src/searchmodel.ts:197

useRegex

get useRegex(): boolean
Whether to use regular expression or not.

Returns boolean
- Defined in packages/documentsearch/src/searchmodel.ts:204
set useRegex(v): void
Parameters
- v: boolean
Returns void
- Defined in packages/documentsearch/src/searchmodel.ts:207

wholeWords

get wholeWords(): boolean
Whether to match whole words or not.

Returns boolean
- Defined in packages/documentsearch/src/searchmodel.ts:218
set wholeWords(v): void
Parameters
- v: boolean
Returns void
- Defined in packages/documentsearch/src/searchmodel.ts:221

Methods

`Private` _onProviderStateChanged

_onProviderStateChanged(): void
Returns void
- Defined in packages/documentsearch/src/searchmodel.ts:371

`Private` _updateSearch

_updateSearch(): Promise<void>
Returns Promise<void>
- Defined in packages/documentsearch/src/searchmodel.ts:338

dispose

dispose(): void
Dispose the model.

Returns void
Implementation of IObservableDisposable.dispose
Overrides VDomModel.dispose
- Defined in packages/documentsearch/src/searchmodel.ts:232

endQuery

endQuery(): Promise<void>
End the query.

Returns Promise<void>
- Defined in packages/documentsearch/src/searchmodel.ts:258

highlightNext

highlightNext(): Promise<void>
Highlight the next match.

Returns Promise<void>
- Defined in packages/documentsearch/src/searchmodel.ts:267

highlightPrevious

highlightPrevious(): Promise<void>
Highlight the previous match

Returns Promise<void>
- Defined in packages/documentsearch/src/searchmodel.ts:276

refresh

refresh(): void
Refresh search

Returns void
- Defined in packages/documentsearch/src/searchmodel.ts:285

replaceAllMatches

replaceAllMatches(): Promise<void>
Replace all matches.

Returns Promise<void>
- Defined in packages/documentsearch/src/searchmodel.ts:294

replaceCurrentMatch

replaceCurrentMatch(): Promise<void>
Replace the current match.

Returns Promise<void>
- Defined in packages/documentsearch/src/searchmodel.ts:306

setFilter

setFilter(name, v): Promise<void>
Set the value of a given filter.
Parameters
- name: string
  Filter name
- v: boolean
  Filter value
Returns Promise<void>
- Defined in packages/documentsearch/src/searchmodel.ts:321

Class SearchDocumentModel

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns SearchDocumentModel

Properties

Private _caseSensitive

Private _disposed

Private _filters

Private _initialQuery

Private _parsingError

Private _preserveCase

Private _replaceText

Private _searchActive

Private _searchDebouncer

Private _searchExpression

Private _useRegex

Private _wholeWords

Protected searchProvider

Readonly stateChanged

Accessors

caseSensitive

Returns boolean

Parameters

Returns void

currentIndex

Returns null | number

disposed

Returns ISignal<this, void>

filters

Returns IFilters

filtersDefinition

Returns { [n: string]: IFilter; }

[n: string]: IFilter

filtersDefinitionChanged

Returns null | ISignal<ISearchProvider, void>

initialQuery

Returns string

Parameters

Returns void

isDisposed

Returns boolean

isReadOnly

Returns boolean

parsingError

Returns string

preserveCase

Returns boolean

Parameters

Returns void

replaceOptionsSupport

Returns undefined | IReplaceOptionsSupport

replaceText

Returns string

Parameters

Returns void

searchExpression

Returns string

Parameters

Returns void

selectionState

Returns undefined | SelectionState

suggestedInitialQuery

Returns string

totalMatches

Returns null | number

useRegex

Returns boolean

Parameters

Returns void

wholeWords

Returns boolean

Parameters

`Private` _caseSensitive

`Private` _disposed

`Private` _filters

`Private` _initialQuery

`Private` _parsingError

`Private` _preserveCase

`Private` _replaceText

`Private` _searchActive

`Private` _searchDebouncer

`Private` _searchExpression

`Private` _useRegex

`Private` _wholeWords

`Protected` searchProvider

`Readonly` stateChanged

Returns {
[n: string]: IFilter;
}

`Private` _onProviderStateChanged

`Private` _updateSearch