Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SearchBox

The search box widget.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected _isFiltering

_isFiltering: boolean = false

Protected Readonly closeEmitter

closeEmitter: Emitter<void> = ...

Protected Readonly debounce

debounce: SearchBoxDebounce

Protected Readonly filter

filter: undefined | HTMLElement

Protected Readonly filterToggleEmitter

filterToggleEmitter: Emitter<boolean> = ...

Protected Readonly input

input: HTMLSpanElement

Protected Readonly nextEmitter

nextEmitter: Emitter<void> = ...

Readonly onDidChangeVisibility

onDidChangeVisibility: Event<boolean> = ...

Protected Readonly onDidChangeVisibilityEmitter

onDidChangeVisibilityEmitter: Emitter<boolean> = ...

Readonly onDidDispose

onDidDispose: Event<void> = ...

Protected Readonly onDidDisposeEmitter

onDidDisposeEmitter: Emitter<void> = ...

Readonly onScrollUp

onScrollUp: Event<void> = ...

Protected Readonly onScrollUpEmitter

onScrollUpEmitter: Emitter<void> = ...

Readonly onScrollYReachEnd

onScrollYReachEnd: Event<void> = ...

Protected Readonly onScrollYReachEndEmitter

onScrollYReachEndEmitter: Emitter<void> = ...

Protected Readonly previousEmitter

previousEmitter: Emitter<void> = ...

Protected Readonly props

props: SearchBoxProps

Protected Optional scrollBar

scrollBar: PerfectScrollbar

Protected Optional scrollOptions

scrollOptions: Options

Protected Readonly textChangeEmitter

textChangeEmitter: Emitter<undefined | string> = ...

Protected Readonly toDispose

toDispose: DisposableCollection = ...

Protected Readonly toDisposeOnDetach

toDisposeOnDetach: DisposableCollection = ...

Static Protected MAX_CONTENT_LENGTH

MAX_CONTENT_LENGTH: number = 15

Static Protected SPECIAL_KEYS

SPECIAL_KEYS: Key[] = ...

Accessors

isFiltering

  • get isFiltering(): boolean

keyCodePredicate

onClose

  • get onClose(): Event<void>

onFilterToggled

  • get onFilterToggled(): Event<boolean>

onNext

  • get onNext(): Event<void>

onPrevious

  • get onPrevious(): Event<void>

onTextChange

  • get onTextChange(): Event<undefined | string>

Methods

Protected addClipboardListener

Protected addEventListener

  • Type parameters

    • K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"

    Parameters

    Returns void

Protected addKeyListener

  • addKeyListener<K>(element: HTMLElement, keysOrKeyCodes: Predicate | Key | KeyCode | (Key | KeyCode)[], action: (event: KeyboardEvent) => boolean | void | Object, ...additionalEventTypes: K[]): void

  • Type parameters

    • K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"

    Parameters

    • element: HTMLElement
    • keysOrKeyCodes: Predicate | Key | KeyCode | (Key | KeyCode)[]
    • action: (event: KeyboardEvent) => boolean | void | Object
        • (event: KeyboardEvent): boolean | void | Object

        • Parameters

          • event: KeyboardEvent

          Returns boolean | void | Object

    • Rest ...additionalEventTypes: K[]

    Returns void

Protected addUpdateListener

  • addUpdateListener<K>(element: HTMLElement, type: K, useCapture?: boolean): void

  • Type parameters

    • K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"

    Parameters

    • element: HTMLElement
    • type: K
    • Optional useCapture: boolean

    Returns void

Protected canHandle

  • canHandle(keyCode: undefined | KeyCode): boolean

clearFlag

  • clearFlag(flag: Flag): void

Protected createContent

  • createContent(): { close: undefined | HTMLElement; container: HTMLElement; filter: undefined | HTMLElement; input: HTMLSpanElement; next: undefined | HTMLElement; previous: undefined | HTMLElement }

  • Returns { close: undefined | HTMLElement; container: HTMLElement; filter: undefined | HTMLElement; input: HTMLSpanElement; next: undefined | HTMLElement; previous: undefined | HTMLElement }

    • close: undefined | HTMLElement
    • container: HTMLElement
    • filter: undefined | HTMLElement
    • input: HTMLSpanElement
    • next: undefined | HTMLElement
    • previous: undefined | HTMLElement

Protected disableScrollBarFocus

  • disableScrollBarFocus(scrollContainer: HTMLElement): void

dispose

  • dispose(): void

Protected doFireFilterToggle

  • doFireFilterToggle(toggleTo?: boolean): void

Protected fireClose

  • fireClose(): void

Protected fireFilterToggle

  • fireFilterToggle(): void

Protected fireNext

  • fireNext(): void

Protected firePrevious

  • firePrevious(): void

Protected fireTextChange

  • fireTextChange(input: undefined | string): void

Protected getScrollContainer

Protected getTrimmedContent

  • getTrimmedContent(data: string): string

handle

  • handle(event: KeyboardEvent): void

Protected handleArrowDown

  • handleArrowDown(): void

Protected handleArrowUp

  • handleArrowUp(): void

Protected handleKey

  • handleKey(keyCode: KeyCode): void

Protected isCtrlBackspace

  • isCtrlBackspace(keyCode: KeyCode): boolean

Protected onAfterAttach

  • onAfterAttach(msg: Message): void

Protected onAfterDetach

  • onAfterDetach(msg: Message): void

Protected onBeforeAttach

  • onBeforeAttach(msg: Message): void

Protected onBeforeDetach

  • onBeforeDetach(msg: Message): void

onBeforeHide

  • onBeforeHide(): void

Protected onCloseRequest

  • onCloseRequest(msg: Message): void

Protected onUpdateRequest

  • onUpdateRequest(msg: Message): void

setFlag

  • setFlag(flag: Flag): void

updateHighlightInfo