Theia API Documentation v1.65.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

    Constructors

    Properties

    _id: number = ...
    disposableCollection: DisposableCollection
    expectingHide: boolean = false
    plugin: Plugin
    quickOpen: QuickOpenExtImpl
    quickOpenMain: QuickOpenMain
    visible: boolean

    Accessors

    • get busy(): boolean

      If the UI should show a progress indicator. Defaults to false.

      Change this to true, e.g., while loading more data or validating user input.

      Returns boolean

    • set busy(busy: boolean): void

      If the UI should show a progress indicator. Defaults to false.

      Change this to true, e.g., while loading more data or validating user input.

      Parameters

      • busy: boolean

      Returns void

    • get enabled(): boolean

      If the UI should allow for user input. Defaults to true.

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

      Returns boolean

    • set enabled(enabled: boolean): void

      If the UI should allow for user input. Defaults to true.

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

      Parameters

      • enabled: boolean

      Returns void

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

      Selection range in the input value. Defined as tuple of two number 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 undefined | readonly [number, number]

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

      Selection range in the input value. Defined as tuple of two number 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: undefined | readonly [number, number]

      Returns void

    Methods

    • 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