Class InputBoxExt

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

QuickInputExt
- InputBoxExt

Implements

InputBox

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new InputBoxExt(quickOpen: QuickOpenExtImpl, quickOpenMain: QuickOpenMain, plugin: Plugin, onDispose: () => void): InputBoxExt

Overrides QuickInputExt.constructor
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:496
Parameters
- quickOpen: QuickOpenExtImpl
- quickOpenMain: QuickOpenMain
- plugin: Plugin
- onDispose: () => void
  - - (): void
    - Returns void
Returns InputBoxExt

Properties

_id

_id: number = ...

Private _password

_password: boolean

Private _prompt

_prompt: undefined | string

Private _validationMessage

_validationMessage: undefined | string

Protected disposableCollection

disposableCollection: DisposableCollection

Protected expectingHide

expectingHide: boolean = false

Readonly plugin

plugin: Plugin

Readonly quickOpen

quickOpen: QuickOpenExtImpl

Readonly quickOpenMain

quickOpenMain: QuickOpenMain

Protected visible

visible: boolean

Accessors

busy

get busy(): boolean
set busy(busy: boolean): void

- Defined in packages/plugin-ext/src/plugin/quick-open.ts:318
Returns boolean
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:322
Parameters
- busy: boolean
Returns void

buttons

get buttons(): QuickInputButton[]
set buttons(buttons: QuickInputButton[]): void

- Defined in packages/plugin-ext/src/plugin/quick-open.ts:354
Returns QuickInputButton[]
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:358
Parameters
- buttons: QuickInputButton[]
Returns void

enabled

get enabled(): boolean
set enabled(enabled: boolean): void

- Defined in packages/plugin-ext/src/plugin/quick-open.ts:309
Returns boolean
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:313
Parameters
- enabled: boolean
Returns void

ignoreFocusOut

get ignoreFocusOut(): boolean
set ignoreFocusOut(ignoreFocusOut: boolean): void

- Defined in packages/plugin-ext/src/plugin/quick-open.ts:327
Returns boolean
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:331
Parameters
- ignoreFocusOut: boolean
Returns void

onDidAccept

get onDidAccept(): Event<void>

- Defined in packages/plugin-ext/src/plugin/quick-open.ts:475
Returns Event<void>

onDidChangeValue

get onDidChangeValue(): Event<string>

- Defined in packages/plugin-ext/src/plugin/quick-open.ts:479
Returns Event<string>

onDidHide

get onDidHide(): Event<void>

- Defined in packages/plugin-ext/src/plugin/quick-open.ts:471
Returns Event<void>

onDidTriggerButton

get onDidTriggerButton(): Event<QuickInputButton>

- Defined in packages/plugin-ext/src/plugin/quick-open.ts:483
Returns Event<QuickInputButton>

password

get password(): boolean
set password(password: boolean): void

- Defined in packages/plugin-ext/src/plugin/quick-open.ts:510
Returns boolean
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:514
Parameters
- password: boolean
Returns void

placeholder

get placeholder(): undefined | string
set placeholder(placeholder: undefined | string): void

- Defined in packages/plugin-ext/src/plugin/quick-open.ts:345
Returns undefined | string
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:349
Parameters
- placeholder: undefined | string
Returns void

prompt

get prompt(): undefined | string
set prompt(prompt: undefined | string): void

- Defined in packages/plugin-ext/src/plugin/quick-open.ts:519
Returns undefined | string
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:523
Parameters
- prompt: undefined | string
Returns void

step

get step(): undefined | number
set step(step: undefined | number): void

- Defined in packages/plugin-ext/src/plugin/quick-open.ts:291
Returns undefined | number
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:295
Parameters
- step: undefined | number
Returns void

title

get title(): undefined | string
set title(title: undefined | string): void

- Defined in packages/plugin-ext/src/plugin/quick-open.ts:282
Returns undefined | string
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:286
Parameters
- title: undefined | string
Returns void

totalSteps

get totalSteps(): undefined | number
set totalSteps(totalSteps: undefined | number): void

- Defined in packages/plugin-ext/src/plugin/quick-open.ts:300
Returns undefined | number
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:304
Parameters
- totalSteps: undefined | number
Returns void

validationMessage

get validationMessage(): undefined | string
set validationMessage(validationMessage: undefined | string): void

- Defined in packages/plugin-ext/src/plugin/quick-open.ts:528
Returns undefined | string
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:532
Parameters
- validationMessage: undefined | string
Returns void

value

get value(): string
set value(value: string): void

- Defined in packages/plugin-ext/src/plugin/quick-open.ts:336
Returns string
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:340
Parameters
- value: string
Returns void

Methods

_fireAccept

_fireAccept(): void

Inherited from QuickInputExt._fireAccept
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:452
Returns void

_fireButtonTrigger

_fireButtonTrigger(btn: QuickInputButton): void

Inherited from QuickInputExt._fireButtonTrigger
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:467
Parameters
- btn: QuickInputButton
Returns void

_fireChangedValue

_fireChangedValue(changedValue: string): void

Inherited from QuickInputExt._fireChangedValue
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:456
Parameters
- changedValue: string
Returns void

_fireHide

_fireHide(): void

Inherited from QuickInputExt._fireHide
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:460
Returns void

Protected convertURL

convertURL(iconPath: ThemeIcon | Uri | { dark: string | Uri; light: string | Uri }): URI | { dark: string | URI; light: string | URI } | ThemeIcon

Inherited from QuickInputExt.convertURL
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:426
Parameters
- iconPath: ThemeIcon | Uri | { dark: string | Uri; light: string | Uri }
Returns URI | { dark: string | URI; light: string | URI } | ThemeIcon

dispose

dispose(): void

Implementation of InputBox.dispose

Inherited from QuickInputExt.dispose
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:380
Returns void

hide

hide(): void

Implementation of InputBox.hide

Inherited from QuickInputExt.hide
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:421
Returns void

show

show(): Promise<void>

Implementation of InputBox.show

Overrides QuickInputExt.show
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:539
Returns Promise<void>

Protected update

update(properties: Record<string, any>): void

Inherited from QuickInputExt.update
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:392
Parameters
- properties: Record<string, any>
Returns void