EditorSearchProvider | @jupyterlab (original) (raw)

Type Parameters

• T extends CodeEditor.IModel = CodeEditor.IModel

Hierarchy (View Summary)

• EditorSearchProvider
  • CellSearchProvider
  • FileEditorSearchProvider

Implements

• IBaseSearchProvider

Index

Constructors

constructor

• new EditorSearchProvider<T extends CodeEditor.IModel = CodeEditor.IModel>(): EditorSearchProvider<
  T,
  >

• Type Parameters

  • T extends CodeEditor.IModel = CodeEditor.IModel

Returns EditorSearchProvider<T>

Properties

Protected_stateChanged

ProtectedcurrentIndex

currentIndex: null | number = null

Protectedfilters

Protectedquery

query: null | RegExp = null

Accessors

ProtectedcmHandler

• get cmHandler(): CodeMirrorSearchHighlighter

• Returns CodeMirrorSearchHighlighter

currentMatchIndex

• get currentMatchIndex(): null | number

• Returns null | number

Protected Abstracteditor

• get editor(): null | CodeEditor.IEditor

• Returns null | CodeEditor.IEditor

isActive

• get isActive(): boolean

• Returns boolean

isDisposed

• get isDisposed(): boolean

• Returns boolean

matchesCount

• get matchesCount(): number

• Returns number

Protected Abstractmodel

• get model(): T

• Returns T

stateChanged

• get stateChanged(): ISignal<IBaseSearchProvider, void>

• Returns ISignal<IBaseSearchProvider, void>

Methods

clearHighlight

• clearHighlight(): Promise<void>

• Returns Promise<void>

dispose

• dispose(): void

• Returns void

endQuery

• endQuery(): Promise<void>

• Returns Promise<void>

getCurrentMatch

• getCurrentMatch(): undefined | ISearchMatch

• Returns undefined | ISearchMatch

The current match

highlightNext

• highlightNext(
  loop?: boolean,
  options?: IHighlightAdjacentMatchOptions,
  ): Promise<undefined | ISearchMatch>

• Returns Promise<undefined | ISearchMatch>

The next match if there is one.

highlightPrevious

• highlightPrevious(
  loop?: boolean,
  options?: IHighlightAdjacentMatchOptions,
  ): Promise<undefined | ISearchMatch>

• Returns Promise<undefined | ISearchMatch>

The previous match if there is one.

ProtectedonSharedModelChanged

• onSharedModelChanged(emitter: ISharedText, changes: SourceChange): Promise<void>

• Returns Promise<void>

replaceAllMatches

• replaceAllMatches(newText: string, options?: IReplaceOptions): Promise<boolean>

• Returns Promise<boolean>

Whether a replace occurred.

replaceCurrentMatch

• replaceCurrentMatch(
  newText: string,
  loop?: boolean,
  options?: IReplaceOptions,
  ): Promise<boolean>

• Parameters

  • newText: string
  • Optionalloop: boolean
  • Optionaloptions: IReplaceOptions

Returns Promise<boolean>

Whether a replace occurred.

setIsActive

• setIsActive(v: boolean): Promise<void>

• Returns Promise<void>

setProtectSelection

• setProtectSelection(v: boolean): void

• Returns void

setSearchSelection

• setSearchSelection(selection: null | IRange): Promise<void>

• Parameters

  • selection: null | IRange

Returns Promise<void>

startQuery

• startQuery(query: null | RegExp, filters?: IFilters): Promise<void>

• Returns Promise<void>

ProtectedupdateCodeMirror

• updateCodeMirror(content: string): Promise<void>

• Parameters

  • content: string

Returns Promise<void>