FileDialog | Theia TypeDoc

Type parameters

Hierarchy

AbstractDialog<T>
- FileDialog
  - OpenFileDialog
  - SaveFileDialog

Index

Constructors

constructor

Accessors

model
value

Constructors

constructor

new FileDialog<T>(props: FileDialogProps): FileDialog<T>

Overrides AbstractDialog<T>.constructor
- Defined in packages/filesystem/src/browser/file-dialog/file-dialog.ts:127
Type parameters
- T
Parameters
- props: FileDialogProps
Returns FileDialog<T>

Properties

Protected acceptButton

acceptButton: undefined | HTMLButtonElement

Protected acceptCancellationSource

acceptCancellationSource: CancellationTokenSource

Protected activeElement

activeElement: undefined | HTMLElement

Protected back

back: HTMLSpanElement

Protected closeButton

closeButton: undefined | HTMLButtonElement

Protected Readonly closeCrossNode

closeCrossNode: HTMLElement

Protected Readonly contentNode

contentNode: HTMLDivElement

Protected Readonly controlPanel

controlPanel: HTMLDivElement

Protected Readonly errorMessageNode

errorMessageNode: HTMLDivElement

Protected forward

forward: HTMLSpanElement

Protected home

home: HTMLSpanElement

Readonly locationListFactory

locationListFactory: LocationListRendererFactory

Protected locationListRenderer

locationListRenderer: LocationListRenderer

Readonly onDidChangeVisibility

onDidChangeVisibility: Event<boolean>

Protected Readonly onDidChangeVisibilityEmitter

onDidChangeVisibilityEmitter: Emitter<boolean>

Readonly onDidDispose

onDidDispose: Event<void>

Protected Readonly onDidDisposeEmitter

onDidDisposeEmitter: Emitter<void>

Readonly onScrollUp

onScrollUp: Event<void>

Protected Readonly onScrollUpEmitter

onScrollUpEmitter: Emitter<void>

Readonly onScrollYReachEnd

onScrollYReachEnd: Event<void>

Protected Readonly onScrollYReachEndEmitter

onScrollYReachEndEmitter: Emitter<void>

Readonly props

props: FileDialogProps

Protected reject

reject: undefined | ((reason: any) => void)

Protected resolve

resolve: undefined | ((value: undefined | T) => void)

Protected Optional scrollBar

scrollBar: PerfectScrollbar

Protected Optional scrollOptions

scrollOptions: Options

Protected Readonly titleNode

titleNode: HTMLDivElement

Protected Readonly toDispose

toDispose: DisposableCollection

Protected Readonly toDisposeOnDetach

toDisposeOnDetach: DisposableCollection

Readonly treeFiltersFactory

treeFiltersFactory: FileDialogTreeFiltersRendererFactory

Protected treeFiltersRenderer

treeFiltersRenderer: undefined | FileDialogTreeFiltersRenderer

Protected treePanel

treePanel: Panel

Protected up

up: HTMLSpanElement

Protected validateCancellationSource

validateCancellationSource: CancellationTokenSource

Readonly widget

widget: FileDialogWidget

Accessors

model

get model(): FileDialogModel

- Defined in packages/filesystem/src/browser/file-dialog/file-dialog.ts:176
Returns FileDialogModel

Abstract value

get value(): T

- Defined in packages/core/lib/browser/dialogs.d.ts:89
Returns T

Methods

Protected accept

accept(): Promise<void>

Inherited from AbstractDialog.accept
- Defined in packages/core/lib/browser/dialogs.d.ts:88
Returns Promise<void>

Protected addAcceptAction

addAcceptAction<K>(element: HTMLElement, ...additionalEventTypes: K[]): void

Inherited from AbstractDialog.addAcceptAction
- Defined in packages/core/lib/browser/dialogs.d.ts:96
Type parameters
- K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"
Parameters
- element: HTMLElement
- Rest ...additionalEventTypes: K[]
Returns void

Protected addClipboardListener

addClipboardListener<K>(element: HTMLElement, type: K, listener: EventListenerOrEventListenerObject<K>): void

Inherited from AbstractDialog.addClipboardListener
- Defined in packages/core/lib/browser/widgets/widget.d.ts:83
Type parameters
- K: "copy" | "cut" | "paste"
Parameters
- element: HTMLElement
- type: K
- listener: EventListenerOrEventListenerObject<K>
Returns void

Protected addCloseAction

addCloseAction<K>(element: HTMLElement, ...additionalEventTypes: K[]): void

Inherited from AbstractDialog.addCloseAction
- Defined in packages/core/lib/browser/dialogs.d.ts:95
Type parameters
- K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"
Parameters
- element: HTMLElement
- Rest ...additionalEventTypes: K[]
Returns void

Protected addEventListener

addEventListener<K>(element: HTMLElement, type: K, listener: EventListenerOrEventListenerObject<K>, useCapture?: boolean): void

Inherited from AbstractDialog.addEventListener
- Defined in packages/core/lib/browser/widgets/widget.d.ts:81
Type parameters
- K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"
Parameters
- element: HTMLElement
- type: K
- listener: EventListenerOrEventListenerObject<K>
- Optional useCapture: boolean
Returns void

Protected addKeyListener

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

Inherited from AbstractDialog.addKeyListener
- Defined in packages/core/lib/browser/widgets/widget.d.ts:82
Type parameters
- K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"
Parameters
- element: HTMLElement
- keysOrKeyCodes: Predicate | Key | KeyCode | (Key | KeyCode)[]
- action: (event: KeyboardEvent) => boolean | void | Object
  - - (event: KeyboardEvent): boolean | void | Object
    - Parameters
      - event: KeyboardEvent
      Returns boolean | void | Object
- Rest ...additionalEventTypes: K[]
Returns void

Protected addTransformEffectToIcon

addTransformEffectToIcon(element: HTMLSpanElement): void

- Defined in packages/filesystem/src/browser/file-dialog/file-dialog.ts:274
Parameters
- element: HTMLSpanElement
Returns void

Protected addUpdateListener

addUpdateListener<K>(element: HTMLElement, type: K, useCapture?: boolean): void

Inherited from AbstractDialog.addUpdateListener
- Defined in packages/core/lib/browser/widgets/widget.d.ts:80
Type parameters
- K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"
Parameters
- element: HTMLElement
- type: K
- Optional useCapture: boolean
Returns void

Protected appendAcceptButton

appendAcceptButton(text?: string): HTMLButtonElement

Inherited from AbstractDialog.appendAcceptButton
- Defined in packages/core/lib/browser/dialogs.d.ts:76
Parameters
- Optional text: string
Returns HTMLButtonElement

Protected appendCloseButton

appendCloseButton(text?: string): HTMLButtonElement

Inherited from AbstractDialog.appendCloseButton
- Defined in packages/core/lib/browser/dialogs.d.ts:75
Parameters
- Optional text: string
Returns HTMLButtonElement

Protected appendFiltersPanel

appendFiltersPanel(): void

- Defined in packages/filesystem/src/browser/file-dialog/file-dialog.ts:219
Returns void

clearFlag

clearFlag(flag: Flag): void

Inherited from AbstractDialog.clearFlag
- Defined in packages/core/lib/browser/widgets/widget.d.ts:85
Parameters
- flag: Flag
Returns void

close

close(): void

Inherited from AbstractDialog.close
- Defined in packages/core/lib/browser/dialogs.d.ts:83
Returns void

Protected createButton

createButton(text: string): HTMLButtonElement

Inherited from AbstractDialog.createButton
- Defined in packages/core/lib/browser/dialogs.d.ts:77
Parameters
- text: string
Returns HTMLButtonElement

Protected disableScrollBarFocus

disableScrollBarFocus(scrollContainer: HTMLElement): void

Inherited from AbstractDialog.disableScrollBarFocus
- Defined in packages/core/lib/browser/widgets/widget.d.ts:78
Parameters
- scrollContainer: HTMLElement
Returns void

dispose

dispose(): void

Inherited from AbstractDialog.dispose
- Defined in packages/core/lib/browser/widgets/widget.d.ts:71
Returns void

Protected Abstract getAcceptButtonLabel

getAcceptButtonLabel(): string

- Defined in packages/filesystem/src/browser/file-dialog/file-dialog.ts:280
Returns string

Protected getScrollContainer

getScrollContainer(): MaybePromise<HTMLElement>

Inherited from AbstractDialog.getScrollContainer
- Defined in packages/core/lib/browser/widgets/widget.d.ts:77
Returns MaybePromise<HTMLElement>

Protected handleEnter

handleEnter(event: KeyboardEvent): boolean | void

Overrides AbstractDialog.handleEnter
- Defined in packages/filesystem/src/browser/file-dialog/file-dialog.ts:197
Parameters
- event: KeyboardEvent
Returns boolean | void

Protected handleEscape

handleEscape(event: KeyboardEvent): boolean | void

Overrides AbstractDialog.handleEscape
- Defined in packages/filesystem/src/browser/file-dialog/file-dialog.ts:204
Parameters
- event: KeyboardEvent
Returns boolean | void

init

init(): void

- Defined in packages/filesystem/src/browser/file-dialog/file-dialog.ts:136
Returns void

Protected isValid

isValid(value: T, mode: DialogMode): MaybePromise<DialogError>

Inherited from AbstractDialog.isValid
- Defined in packages/core/lib/browser/dialogs.d.ts:93
Return a string of zero-length or true if valid.

Parameters
- value: T
- mode: DialogMode
Returns MaybePromise<DialogError>

Protected onActivateRequest

onActivateRequest(msg: Message): void

Overrides AbstractDialog.onActivateRequest
- Defined in packages/filesystem/src/browser/file-dialog/file-dialog.ts:282
Parameters
- msg: Message
Returns void

Protected onAfterAttach

onAfterAttach(msg: Message): void

Overrides AbstractDialog.onAfterAttach
- Defined in packages/filesystem/src/browser/file-dialog/file-dialog.ts:235
Parameters
- msg: Message
Returns void

Protected onAfterDetach

onAfterDetach(msg: Message): void

Inherited from AbstractDialog.onAfterDetach
- Defined in packages/core/lib/browser/widgets/widget.d.ts:74
Parameters
- msg: Message
Returns void

Protected onBeforeAttach

onBeforeAttach(msg: Message): void

Inherited from AbstractDialog.onBeforeAttach
- Defined in packages/core/lib/browser/widgets/widget.d.ts:73
Parameters
- msg: Message
Returns void

Protected onBeforeDetach

onBeforeDetach(msg: Message): void

Inherited from AbstractDialog.onBeforeDetach
- Defined in packages/core/lib/browser/widgets/widget.d.ts:75
Parameters
- msg: Message
Returns void

Protected onCloseRequest

onCloseRequest(msg: Message): void

Inherited from AbstractDialog.onCloseRequest
- Defined in packages/core/lib/browser/widgets/widget.d.ts:72
Parameters
- msg: Message
Returns void

Protected onUpdateRequest

onUpdateRequest(msg: Message): void

Overrides AbstractDialog.onUpdateRequest
- Defined in packages/filesystem/src/browser/file-dialog/file-dialog.ts:180
Parameters
- msg: Message
Returns void

open

open(): Promise<undefined | T>

Inherited from AbstractDialog.open
- Defined in packages/core/lib/browser/dialogs.d.ts:82
Returns Promise<undefined | T>

Protected setErrorMessage

setErrorMessage(error: DialogError): void

Inherited from AbstractDialog.setErrorMessage
- Defined in packages/core/lib/browser/dialogs.d.ts:94
Parameters
- error: DialogError
Returns void

setFlag

setFlag(flag: Flag): void

Inherited from AbstractDialog.setFlag
- Defined in packages/core/lib/browser/widgets/widget.d.ts:84
Parameters
- flag: Flag
Returns void

Protected targetIsDirectoryInput

targetIsDirectoryInput(target: null | EventTarget): boolean

- Defined in packages/filesystem/src/browser/file-dialog/file-dialog.ts:211
Parameters
- target: null | EventTarget
Returns boolean

Protected targetIsInputToggle

targetIsInputToggle(target: null | EventTarget): boolean

- Defined in packages/filesystem/src/browser/file-dialog/file-dialog.ts:215
Parameters
- target: null | EventTarget
Returns boolean

Protected validate

validate(): Promise<void>

Inherited from AbstractDialog.validate
- Defined in packages/core/lib/browser/dialogs.d.ts:86
Returns Promise<void>

Type parameters

T

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type parameters

T

Parameters

props: FileDialogProps

Returns FileDialog<T>

Properties

Protected acceptButton

Protected acceptCancellationSource

Protected activeElement

Protected back

Protected closeButton

Protected Readonly closeCrossNode

Protected Readonly contentNode

Protected Readonly controlPanel

Protected Readonly errorMessageNode

Protected forward

Protected home

Readonly locationListFactory

Protected locationListRenderer

Readonly onDidChangeVisibility

Protected Readonly onDidChangeVisibilityEmitter

Readonly onDidDispose

Protected Readonly onDidDisposeEmitter

Readonly onScrollUp

Protected Readonly onScrollUpEmitter

Readonly onScrollYReachEnd

Protected Readonly onScrollYReachEndEmitter

Readonly props

Protected reject

Protected resolve

Protected Optional scrollBar

Protected Optional scrollOptions

Protected Readonly titleNode

Protected Readonly toDispose

Protected Readonly toDisposeOnDetach

Readonly treeFiltersFactory

Protected treeFiltersRenderer

Protected treePanel

Protected up

Protected validateCancellationSource

Readonly widget

Accessors

model

Returns FileDialogModel

Abstract value

Returns T

Methods

Protected accept

Returns Promise<void>

Protected addAcceptAction

Type parameters

Parameters

element: HTMLElement

Rest ...additionalEventTypes: K[]

Returns void

Protected addClipboardListener

Type parameters

K: "copy" | "cut" | "paste"

Parameters

element: HTMLElement

type: K

listener: EventListenerOrEventListenerObject<K>

Returns void

Protected addCloseAction

Type parameters

Parameters

element: HTMLElement

Rest ...additionalEventTypes: K[]

Returns void

Protected addEventListener