[dialog] fix #5859: apply overlay keyboard events to the top most dialog

Signed-off-by: Anton Kosyakov <anton.kosyakov@typefox.io>
eclipse-theia · Aug 7, 2019 · 7e7428f · 7e7428f
1 parent 62fe752
commit 7e7428f
Show file tree

Hide file tree

Showing 2 changed files with 61 additions and 3 deletions.
diff --git a/packages/core/src/browser/dialogs.ts b/packages/core/src/browser/dialogs.ts
@@ -17,7 +17,8 @@
 import { injectable, inject } from 'inversify';
 import { Disposable, MaybePromise, CancellationTokenSource } from '../common';
 import { Key } from './keyboard/keys';
-import { Widget, BaseWidget, Message } from './widgets';
+import { Widget, BaseWidget, Message, addKeyListener } from './widgets';
+import { FrontendApplicationContribution } from './frontend-application';
 
 @injectable()
 export class DialogProps {
@@ -51,6 +52,59 @@ export namespace DialogError {
     }
 }
 
+@injectable()
+export class DialogOverlayService implements FrontendApplicationContribution {
+
+    protected static INSTANCE: DialogOverlayService;
+
+    static get(): DialogOverlayService {
+        return DialogOverlayService.INSTANCE;
+    }
+
+    // tslint:disable-next-line:no-any
+    protected readonly dialogs: AbstractDialog<any>[] = [];
+
+    constructor() {
+        addKeyListener(document.body, Key.ENTER, e => this.handleEnter(e));
+        addKeyListener(document.body, Key.ESCAPE, e => this.handleEscape(e));
+    }
+
+    initialize(): void {
+        DialogOverlayService.INSTANCE = this;
+    }
+
+    // tslint:disable-next-line:no-any
+    protected get currentDialog(): AbstractDialog<any> | undefined {
+        return this.dialogs[0];
+    }
+
+    // tslint:disable-next-line:no-any
+    push(dialog: AbstractDialog<any>): Disposable {
+        this.dialogs.unshift(dialog);
+        return Disposable.create(() => {
+            const index = this.dialogs.indexOf(dialog);
+            if (index > -1) {
+                this.dialogs.splice(index, 1);
+            }
+        });
+    }
+
+    protected handleEscape(event: KeyboardEvent): boolean | void {
+        const dialog = this.currentDialog;
+        if (dialog) {
+            dialog['handleEscape'](event);
+        }
+    }
+
+    protected handleEnter(event: KeyboardEvent): boolean | void {
+        const dialog = this.currentDialog;
+        if (dialog) {
+            dialog['handleEnter'](event);
+        }
+    }
+
+}
+
 @injectable()
 export abstract class AbstractDialog<T> extends BaseWidget {
 
@@ -144,8 +198,8 @@ export abstract class AbstractDialog<T> extends BaseWidget {
             this.addAcceptAction(this.acceptButton, 'click');
         }
         this.addCloseAction(this.closeCrossNode, 'click');
-        this.addKeyListener(document.body, Key.ESCAPE, e => this.handleEscape(e));
-        this.addKeyListener(document.body, Key.ENTER, e => this.handleEnter(e));
+        // TODO: use DI always to create dialog instances
+        this.toDisposeOnDetach.push(DialogOverlayService.get().push(this));
     }
 
     protected handleEscape(event: KeyboardEvent): boolean | void {

diff --git a/packages/core/src/browser/frontend-application-module.ts b/packages/core/src/browser/frontend-application-module.ts
@@ -77,6 +77,7 @@ import { ApplicationShellMouseTracker } from './shell/application-shell-mouse-tr
 import { ViewContainer, ViewContainerIdentifier } from './view-container';
 import { QuickViewService } from './quick-view-service';
 import { QuickTitleBar } from './quick-open/quick-title-bar';
+import { DialogOverlayService } from './dialogs';
 
 export const frontendApplicationModule = new ContainerModule((bind, unbind, isBound, rebind) => {
     const themeService = ThemeService.get();
@@ -253,6 +254,9 @@ export const frontendApplicationModule = new ContainerModule((bind, unbind, isBo
 
     bind(QuickViewService).toSelf().inSingletonScope();
     bind(QuickOpenContribution).toService(QuickViewService);
+
+    bind(DialogOverlayService).toSelf().inSingletonScope();
+    bind(FrontendApplicationContribution).toService(DialogOverlayService);
 });
 
 export function bindMessageService(bind: interfaces.Bind): interfaces.BindingWhenOnSyntax<MessageService> {