InputBoxExt | Theia TypeDoc

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

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:549
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

Private _valueSelection

_valueSelection: undefined | readonly [number, number]

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

Implementation of theia.InputBox.busy
Inherited from QuickInputExt.busy
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:366
Returns boolean
Implementation of theia.InputBox.busy
Inherited from QuickInputExt.busy
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:370
Parameters
- busy: boolean
Returns void

buttons

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

Implementation of theia.InputBox.buttons
Inherited from QuickInputExt.buttons
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:402
Returns QuickInputButton[]
Implementation of theia.InputBox.buttons
Inherited from QuickInputExt.buttons
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:406
Parameters
- buttons: QuickInputButton[]
Returns void

enabled

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

Implementation of theia.InputBox.enabled
Inherited from QuickInputExt.enabled
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:357
Returns boolean
Implementation of theia.InputBox.enabled
Inherited from QuickInputExt.enabled
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:361
Parameters
- enabled: boolean
Returns void

ignoreFocusOut

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

Implementation of theia.InputBox.ignoreFocusOut
Inherited from QuickInputExt.ignoreFocusOut
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:375
Returns boolean
Implementation of theia.InputBox.ignoreFocusOut
Inherited from QuickInputExt.ignoreFocusOut
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:379
Parameters
- ignoreFocusOut: boolean
Returns void

onDidAccept

get onDidAccept(): Event<void>

Implementation of theia.InputBox.onDidAccept
Inherited from QuickInputExt.onDidAccept
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:525
Returns Event<void>

onDidChangeValue

get onDidChangeValue(): Event<string>

Implementation of theia.InputBox.onDidChangeValue
Inherited from QuickInputExt.onDidChangeValue
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:529
Returns Event<string>

onDidHide

get onDidHide(): Event<void>

Implementation of theia.InputBox.onDidHide
Inherited from QuickInputExt.onDidHide
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:521
Returns Event<void>

onDidTriggerButton

get onDidTriggerButton(): Event<QuickInputButton>

Implementation of theia.InputBox.onDidTriggerButton
Inherited from QuickInputExt.onDidTriggerButton
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:533
Returns Event<QuickInputButton>

password

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

Implementation of theia.InputBox.password
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:562
Returns boolean
Implementation of theia.InputBox.password
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:566
Parameters
- password: boolean
Returns void

placeholder

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

Implementation of theia.InputBox.placeholder
Inherited from QuickInputExt.placeholder
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:393
Returns undefined | string
Implementation of theia.InputBox.placeholder
Inherited from QuickInputExt.placeholder
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:397
Parameters
- placeholder: undefined | string
Returns void

prompt

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

Implementation of theia.InputBox.prompt
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:571
Returns undefined | string
Implementation of theia.InputBox.prompt
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:575
Parameters
- prompt: undefined | string
Returns void

step

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

Implementation of theia.InputBox.step
Inherited from QuickInputExt.step
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:339
Returns undefined | number
Implementation of theia.InputBox.step
Inherited from QuickInputExt.step
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:343
Parameters
- step: undefined | number
Returns void

title

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

Implementation of theia.InputBox.title
Inherited from QuickInputExt.title
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:330
Returns undefined | string
Implementation of theia.InputBox.title
Inherited from QuickInputExt.title
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:334
Parameters
- title: undefined | string
Returns void

totalSteps

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

Implementation of theia.InputBox.totalSteps
Inherited from QuickInputExt.totalSteps
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:348
Returns undefined | number
Implementation of theia.InputBox.totalSteps
Inherited from QuickInputExt.totalSteps
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:352
Parameters
- totalSteps: undefined | number
Returns void

validationMessage

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

Implementation of theia.InputBox.validationMessage
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:589
Returns undefined | string
Implementation of theia.InputBox.validationMessage
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:593
Parameters
- validationMessage: undefined | string
Returns void

value

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

Implementation of theia.InputBox.value
Inherited from QuickInputExt.value
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:384
Returns string
Implementation of theia.InputBox.value
Inherited from QuickInputExt.value
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:388
Parameters
- value: string
Returns void

valueSelection

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

Implementation of theia.InputBox.valueSelection
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:580
Returns undefined | readonly [number, number]
Implementation of theia.InputBox.valueSelection
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:584
Parameters
- valueSelection: undefined | readonly [number, number]
Returns void

Methods

_fireAccept

_fireAccept(): void

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

_fireButtonTrigger

_fireButtonTrigger(btn: QuickInputButton): void

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

_fireChangedValue

_fireChangedValue(changedValue: string): void

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

_fireHide

_fireHide(): void

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

Protected convertURL

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

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

dispose

dispose(): void

Implementation of theia.InputBox.dispose
Inherited from QuickInputExt.dispose
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:429
Returns void

hide

hide(): void

Implementation of theia.InputBox.hide
Inherited from QuickInputExt.hide
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:470
Returns void

show

show(): void

Implementation of theia.InputBox.show
Inherited from QuickInputExt.show
- Defined in packages/plugin-ext/src/plugin/quick-open.ts:423
Returns void

Protected update

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

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

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

quickOpen: QuickOpenExtImpl

quickOpenMain: QuickOpenMain

plugin: Plugin

onDispose: (() => void)

Returns void

Returns InputBoxExt

Properties

_id

Private _password

Private _prompt

Private _validationMessage

Private _valueSelection

Protected disposableCollection

Protected expectingHide

Readonly plugin

Readonly quickOpen

Readonly quickOpenMain

Protected visible

Accessors

busy

Returns boolean

Parameters

busy: boolean

Returns void

buttons

Returns QuickInputButton[]

Parameters

buttons: QuickInputButton[]

Returns void

enabled

Returns boolean

Parameters

enabled: boolean

Returns void

ignoreFocusOut

Returns boolean

Parameters

ignoreFocusOut: boolean

Returns void

onDidAccept

Returns Event<void>

onDidChangeValue

Returns Event<string>

onDidHide

Returns Event<void>

onDidTriggerButton

Returns Event<QuickInputButton>

password

Returns boolean

Parameters

password: boolean

Returns void

placeholder

Returns undefined | string

Parameters

placeholder: undefined | string

Returns void

prompt

Returns undefined | string

Parameters

prompt: undefined | string

Returns void

step

Returns undefined | number

Parameters

step: undefined | number

Returns void

title

Returns undefined | string

Parameters