Theia API Documentation v1.77.0
    Preparing search index...

    Base implementation of InputBox that uses QuickOpenExt. Missing functionality is going to be implemented in the scope of https://github.com/eclipse-theia/theia/issues/5109

    Hierarchy (View Summary)

    Implements

    Index
    _id: number = ...
    disposableCollection: DisposableCollection
    expectingHide: boolean = false
    plugin: Plugin
    quickOpen: QuickOpenExtImpl
    quickOpenMain: QuickOpenMain
    visible: boolean
    • get busy(): boolean

      Determines if the UI should show a progress indicator. Defaults to false.

      Change this to true, for example, while loading more data or validating user input.

      Returns boolean

    • set busy(busy: boolean): void

      Determines if the UI should show a progress indicator. Defaults to false.

      Change this to true, for example, while loading more data or validating user input.

      Parameters

      • busy: boolean

      Returns void

    • get enabled(): boolean

      Determines if the UI should allow for user input. Defaults to true.

      Change this to false, for example, while validating user input or loading data for the next step in user input.

      Returns boolean

    • set enabled(enabled: boolean): void

      Determines if the UI should allow for user input. Defaults to true.

      Change this to false, for example, while validating user input or loading data for the next step in user input.

      Parameters

      • enabled: boolean

      Returns void

    • get ignoreFocusOut(): boolean

      Determines if the UI should stay open even when losing UI focus. Defaults to false. This setting is ignored on iPad and is always false.

      Returns boolean

    • set ignoreFocusOut(ignoreFocusOut: boolean): void

      Determines if the UI should stay open even when losing UI focus. Defaults to false. This setting is ignored on iPad and is always false.

      Parameters

      • ignoreFocusOut: boolean

      Returns void

    • get onDidHide(): Event<void>

      An event signaling when this input UI is hidden.

      There are several reasons why this UI might have to be hidden and the extension will be notified through onDidHide. Examples include: an explicit call to hide, the user pressing Esc, some other input UI opening, etc.

      Returns Event<void>

    • get valueSelection(): readonly [number, number] | undefined

      Selection range in the input value.

      Defined as tuple of two numbers where the first is the inclusive start index and the second the exclusive end index. When undefined the whole pre-filled value will be selected, when empty (start equals end) only the cursor will be set, otherwise the defined range will be selected.

      This property does not get updated when the user types or makes a selection, but it can be updated by the extension.

      Returns readonly [number, number] | undefined

    • set valueSelection(valueSelection: readonly [number, number] | undefined): void

      Selection range in the input value.

      Defined as tuple of two numbers where the first is the inclusive start index and the second the exclusive end index. When undefined the whole pre-filled value will be selected, when empty (start equals end) only the cursor will be set, otherwise the defined range will be selected.

      This property does not get updated when the user types or makes a selection, but it can be updated by the extension.

      Parameters

      • valueSelection: readonly [number, number] | undefined

      Returns void

    • Dispose of this input UI and any associated resources.

      If it is still visible, it is first hidden. After this call the input UI is no longer functional and no additional methods or properties on it should be accessed. Instead a new input UI should be created.

      Returns void