Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SearchBox

The search box widget.

Hierarchy

Implements

  • IMessageHandler
  • IObservableDisposable

Index

Constructors

constructor

Properties

Protected _isFiltering

_isFiltering: boolean = false

Protected Readonly closeEmitter

closeEmitter: Emitter<void> = new Emitter<void>()

Readonly dataset

dataset: DOMStringMap

The dataset for the widget's DOM node.

Protected Readonly debounce

Readonly disposed

disposed: ISignal<this, void>

A signal emitted when the widget is disposed.

Protected Readonly filter

filter: HTMLElement | undefined

Protected Readonly filterToggleEmitter

filterToggleEmitter: Emitter<boolean> = new Emitter<boolean>()

id

id: string

Set the id of the widget's DOM node.

Protected Readonly input

input: HTMLSpanElement

Readonly isAttached

isAttached: boolean

Test whether the widget's node is attached to the DOM.

Readonly isDisposed

isDisposed: boolean

Test whether the widget has been disposed.

Readonly isHidden

isHidden: boolean

Test whether the widget is explicitly hidden.

Readonly isVisible

isVisible: boolean

Test whether the widget is visible.

Notes

A widget is visible when it is attached to the DOM, is not explicitly hidden, and has no explicitly hidden ancestors.

layout

layout: Layout | null

Set the layout for the widget.

Notes

The layout is single-use only. It cannot be changed after the first assignment.

The layout is disposed automatically when the widget is disposed.

Protected Readonly nextEmitter

nextEmitter: Emitter<void> = new Emitter<void>()

Readonly node

node: HTMLElement

Get the DOM node owned by the widget.

Readonly onDidChangeVisibility

onDidChangeVisibility: Event<boolean> = this.onDidChangeVisibilityEmitter.event

Protected Readonly onDidChangeVisibilityEmitter

onDidChangeVisibilityEmitter: Emitter<boolean> = new Emitter<boolean>()

Readonly onDidDispose

onDidDispose: Event<void> = this.onDidDisposeEmitter.event

Protected Readonly onDidDisposeEmitter

onDidDisposeEmitter: Emitter<void> = new Emitter<void>()

Readonly onScrollUp

onScrollUp: Event<void> = this.onScrollUpEmitter.event

Protected Readonly onScrollUpEmitter

onScrollUpEmitter: Emitter<void> = new Emitter<void>()

Readonly onScrollYReachEnd

onScrollYReachEnd: Event<void> = this.onScrollYReachEndEmitter.event

Protected Readonly onScrollYReachEndEmitter

onScrollYReachEndEmitter: Emitter<void> = new Emitter<void>()

parent

parent: Widget | null

Set the parent of the widget.

Notes

Children are typically added to a widget by using a layout, which means user code will not normally set the parent widget directly.

The widget will be automatically removed from its old parent.

This is a no-op if there is no effective parent change.

Protected Readonly previousEmitter

previousEmitter: Emitter<void> = new Emitter<void>()

Protected Readonly props

Protected Optional scrollBar

scrollBar: PerfectScrollbar

Protected Optional scrollOptions

scrollOptions: PerfectScrollbar.Options

Protected Readonly textChangeEmitter

textChangeEmitter: Emitter<undefined | string> = new Emitter<string | undefined>()

Readonly title

title: Title<Widget>

The title object for the widget.

Notes

The title object is used by some container widgets when displaying the widget alongside some title, such as a tab panel or side bar.

Since not all widgets will use the title, it is created on demand.

The owner property of the title is set to this widget.

Protected Readonly toDispose

toDispose: DisposableCollection = new DisposableCollection(this.onDidDisposeEmitter,Disposable.create(() => this.onDidDisposeEmitter.fire()),this.onScrollYReachEndEmitter,this.onScrollUpEmitter,this.onDidChangeVisibilityEmitter)

Protected Readonly toDisposeOnDetach

toDisposeOnDetach: DisposableCollection = new DisposableCollection()

Static Protected MAX_CONTENT_LENGTH

MAX_CONTENT_LENGTH: number = 15

Static Protected SPECIAL_KEYS

SPECIAL_KEYS: Key[] = [Key.ESCAPE,Key.BACKSPACE]

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<string | undefined>

Methods

activate

  • activate(): void
  • Post an 'activate-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

addClass

  • addClass(name: string): void
  • Add a class name to the widget's DOM node.

    Parameters

    • name: string

      The class name to add to the node.

      Notes

      If the class name is already added to the node, this is a no-op.

      The class name must not contain whitespace.

    Returns void

Protected addClipboardListener

Protected addEventListener

Protected addKeyListener

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

Protected addUpdateListener

  • addUpdateListener<K>(element: HTMLElement, type: K, useCapture?: undefined | false | true): void

Protected canHandle

  • canHandle(keyCode: KeyCode | undefined): boolean

children

  • children(): IIterator<Widget>
  • Create an iterator over the widget's children.

    Returns IIterator<Widget>

    A new iterator over the children of the widget.

    Notes

    The widget must have a populated layout in order to have children.

    If a layout is not installed, the returned iterator will be empty.

clearFlag

  • clearFlag(flag: Flag): void

close

  • close(): void
  • Send a 'close-request' message to the widget.

    Notes

    This is a simple convenience method for sending the message.

    Returns void

contains

  • contains(widget: Widget): boolean
  • Test whether a widget is a descendant of this widget.

    Parameters

    • widget: Widget

      The descendant widget of interest.

    Returns boolean

    true if the widget is a descendant, false otherwise.

Protected createContent

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

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

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: string | undefined): void

fit

  • fit(): void
  • Post a 'fit-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns 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

hasClass

  • hasClass(name: string): boolean
  • Test whether the widget's DOM node has the given class name.

    Parameters

    • name: string

      The class name of interest.

    Returns boolean

    true if the node has the class, false otherwise.

hide

  • hide(): void
  • Hide the widget and make it hidden to its parent widget.

    Notes

    This causes the isHidden property to be true.

    If the widget is explicitly hidden, this is a no-op.

    Returns void

Protected isCtrlBackspace

  • isCtrlBackspace(keyCode: KeyCode): boolean

Protected notifyLayout

  • notifyLayout(msg: Message): void
  • Invoke the message processing routine of the widget's layout.

    Parameters

    • msg: Message

      The message to dispatch to the layout.

      Notes

      This is a no-op if the widget does not have a layout.

      This will not typically be called directly by user code.

    Returns void

Protected onActivateRequest

  • onActivateRequest(msg: Message): void
  • A message handler invoked on an 'activate-request' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onAfterAttach

  • onAfterAttach(msg: Message): void

Protected onAfterDetach

  • onAfterDetach(msg: Message): void

Protected onAfterHide

  • onAfterHide(msg: Message): void
  • A message handler invoked on an 'after-hide' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onAfterShow

  • onAfterShow(msg: Message): void
  • A message handler invoked on an 'after-show' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onBeforeAttach

  • onBeforeAttach(msg: Message): void

Protected onBeforeDetach

  • onBeforeDetach(msg: Message): void

onBeforeHide

  • onBeforeHide(): void

Protected onBeforeShow

  • onBeforeShow(msg: Message): void
  • A message handler invoked on a 'before-show' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onChildAdded

  • A message handler invoked on a 'child-added' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    Returns void

Protected onChildRemoved

  • A message handler invoked on a 'child-removed' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    Returns void

Protected onCloseRequest

  • onCloseRequest(msg: Message): void

Protected onFitRequest

  • onFitRequest(msg: Message): void
  • A message handler invoked on a 'fit-request' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    • msg: Message

    Returns void

Protected onResize

  • A message handler invoked on a 'resize' message.

    Notes

    The default implementation of this handler is a no-op.

    Parameters

    Returns void

Protected onUpdateRequest

  • onUpdateRequest(msg: Message): void

processMessage

  • processMessage(msg: Message): void
  • Process a message sent to the widget.

    Parameters

    • msg: Message

      The message sent to the widget.

      Notes

      Subclasses may reimplement this method as needed.

    Returns void

removeClass

  • removeClass(name: string): void
  • Remove a class name from the widget's DOM node.

    Parameters

    • name: string

      The class name to remove from the node.

      Notes

      If the class name is not yet added to the node, this is a no-op.

      The class name must not contain whitespace.

    Returns void

setFlag

  • setFlag(flag: Flag): void

setHidden

  • setHidden(hidden: boolean): void
  • Show or hide the widget according to a boolean value.

    Parameters

    • hidden: boolean

      true to hide the widget, or false to show it.

      Notes

      This is a convenience method for hide() and show().

    Returns void

show

  • show(): void
  • Show the widget and make it visible to its parent widget.

    Notes

    This causes the isHidden property to be false.

    If the widget is not explicitly hidden, this is a no-op.

    Returns void

testFlag

  • testFlag(flag: Flag): boolean
  • Test whether the given widget flag is set.

    Notes

    This will not typically be called directly by user code.

    Parameters

    Returns boolean

toggleClass

  • toggleClass(name: string, force?: undefined | false | true): boolean
  • Toggle a class name on the widget's DOM node.

    Parameters

    • name: string

      The class name to toggle on the node.

    • Optional force: undefined | false | true

      Whether to force add the class (true) or force remove the class (false). If not provided, the presence of the class will be toggled from its current state.

    Returns boolean

    true if the class is now present, false otherwise.

    Notes

    The class name must not contain whitespace.

update

  • update(): void
  • Post an 'update-request' message to the widget.

    Notes

    This is a simple convenience method for posting the message.

    Returns void

updateHighlightInfo