Class IncrementalSearch

Implements immediate searching while the user is typing. When incremental search is activated, keystrokes into the editor will be used for composing a search term. Immediately after every keystroke the search is updated:

  • so-far-matching characters are highlighted
  • the cursor is moved to the next match

Hierarchy (view full)

Constructors

constructor

Properties

$currentPos $editor $keyboardHandler $mousedownHandler $options $originalEditorOnPaste $prevNeedle $startPos

Methods

$assembleMultilineRegExp $assembleRegExp $matchIterator activate addString cancelSearch convertNeedleToRegExp convertNeedleToString deactivate find findAll getOptions highlight highlightAndFindWithNeedle message next onMouseDown onPaste removeChar replace selectionFix set setOptions statusMessage

Constructors

constructor

Properties

$currentPos

$currentPos: any

$editor

$editor: any

$keyboardHandler

$keyboardHandler: IncrementalSearchKeyboardHandler

$mousedownHandler

$mousedownHandler: any

$options

$options: {
    skipCurrent: boolean;
    wrap: boolean;
}

Type declaration

  • skipCurrent: boolean
  • wrap: boolean

$originalEditorOnPaste

$originalEditorOnPaste: any

$prevNeedle

$prevNeedle: any

$startPos

$startPos: any

Methods

$assembleMultilineRegExp

$assembleRegExp

  • $assembleRegExp(options, $disableFakeMultiline?): any

  • Parameters

    • options: Partial<SearchOptions>
    • Optional $disableFakeMultiline: boolean

    Returns any

$matchIterator

  • $matchIterator(session, options): false | {
        forEach: ((callback) => void);
    }

  • Parameters

    • session: EditSession
    • options: any

    Returns false | {
        forEach: ((callback) => void);
    }

activate

addString

cancelSearch

convertNeedleToRegExp

convertNeedleToString

deactivate

find

  • find(session): false | Range

  • Searches for options.needle. If found, this method returns the [[Range Range]] where the text first occurs. If options.backwards is true, the search goes backwards in the session.

    Parameters

    • session: EditSession

      The session to search with

    Returns false | Range

findAll

  • findAll(session): Range[]

  • Searches for all occurrances options.needle. If found, this method returns an array of [[Range Ranges]] where the text first occurs. If options.backwards is true, the search goes backwards in the session.

    Parameters

    • session: EditSession

      The session to search with

    Returns Range[]

getOptions

  • getOptions(): Partial<SearchOptions>

  • [Returns an object containing all the search options.]{: #Search.getOptions}

    Returns Partial<SearchOptions>

highlight

highlightAndFindWithNeedle

  • highlightAndFindWithNeedle(moveToNext, needleUpdateFunc): false | Range

  • Parameters

    • moveToNext: boolean
    • needleUpdateFunc: Function

    Returns false | Range

message

next

onMouseDown

onPaste

removeChar

replace

  • replace(input, replacement): string

  • Searches for options.needle in input, and, if found, replaces it with replacement.

    Parameters

    • input: string

      The text to search in

    • replacement: any

      The replacing text

      • (String): If options.regExp is true, this function returns input with the replacement already made. Otherwise, this function just returns replacement.
        If options.needle was not found, this function returns null.

    Returns string

selectionFix

set

  • set(options): Search

  • Sets the search options via the options parameter.

    Parameters

    • options: Partial<SearchOptions>

      An object containing all the new search properties

    Returns Search

    Chainable

setOptions

  • setOptions(options): void

  • Sets the search options via the options parameter.

    Parameters

    • options: Partial<SearchOptions>

      object containing all the search propertie

    Returns void

    Related

    Search.set

statusMessage

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc