@eclipse-glsp/client 1.1.0-next.4e10035.245 → 1.1.0-next.5435240.281

package/src/features/accessibility/resize-key-tool/resize-key-tool.ts

@@ -0,0 +1,141 @@
+/********************************************************************************
+ * Copyright (c) 2023 Business Informatics Group (TU Wien) and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the Eclipse
+ * Public License v. 2.0 are satisfied: GNU General Public License, version 2
+ * with the GNU Classpath Exception which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ ********************************************************************************/
+
+import { inject, injectable, optional } from 'inversify';
+import { matchesKeystroke } from 'sprotty/lib/utils/keyboard';
+import { Action, ISnapper, KeyListener, KeyTool, SModelElement, TYPES } from '~glsp-sprotty';
+import { GLSPActionDispatcher } from '../../../base/action-dispatcher';
+import { SelectionService } from '../../../base/selection-service';
+import { EnableDefaultToolsAction, EnableToolsAction, Tool } from '../../../base/tool-manager/tool';
+import { IMovementRestrictor } from '../../change-bounds/movement-restrictor';
+import { AccessibleKeyShortcutProvider, SetAccessibleKeyShortcutAction } from '../key-shortcut/accessible-key-shortcut';
+import * as messages from '../toast/messages.json';
+import { ShowToastMessageAction } from '../toast/toast-handler';
+import { ResizeElementAction, ResizeType } from './resize-key-handler';
+
+@injectable()
+export class ResizeKeyTool implements Tool {
+    static ID = 'glsp.resize-key-tool';
+
+    isEditTool = true;
+
+    @inject(KeyTool) protected readonly keytool: KeyTool;
+    @inject(TYPES.IMovementRestrictor) @optional() readonly movementRestrictor?: IMovementRestrictor;
+    @inject(TYPES.ISnapper) @optional() readonly snapper?: ISnapper;
+    @inject(TYPES.IActionDispatcher) readonly actionDispatcher: GLSPActionDispatcher;
+    @inject(SelectionService) readonly selectionService: SelectionService;
+
+    protected resizeKeyListener: ResizeKeyListener = new ResizeKeyListener(this);
+
+    get id(): string {
+        return ResizeKeyTool.ID;
+    }
+
+    enable(): void {
+        this.keytool.register(this.resizeKeyListener);
+        this.resizeKeyListener.registerShortcutKey();
+    }
+
+    disable(): void {
+        this.keytool.deregister(this.resizeKeyListener);
+    }
+}
+@injectable()
+export class ResizeKeyListener extends KeyListener implements AccessibleKeyShortcutProvider {
+    protected isEditMode = false;
+    protected readonly token = ResizeKeyListener.name;
+
+    constructor(protected readonly tool: ResizeKeyTool) {
+        super();
+    }
+
+    registerShortcutKey(): void {
+        this.tool.actionDispatcher.dispatchOnceModelInitialized(
+            SetAccessibleKeyShortcutAction.create({
+                token: this.token,
+                keys: [
+                    { shortcuts: ['ALT', 'A'], description: 'Activate resize mode for selected element', group: 'Resize', position: 0 },
+                    { shortcuts: ['+'], description: 'Increase size of element', group: 'Resize', position: 1 },
+                    { shortcuts: ['-'], description: 'Increase size of element', group: 'Resize', position: 2 },
+                    { shortcuts: ['CTRL', '0'], description: 'Set element size to default', group: 'Resize', position: 3 }
+                ]
+            })
+        );
+    }
+
+    override keyDown(element: SModelElement, event: KeyboardEvent): Action[] {
+        const actions = [];
+        const selectedElementsIds = this.tool.selectionService.getSelectedElementIDs();
+
+        if (this.isEditMode && this.matchesDeactivateResizeModeKeystroke(event)) {
+            this.isEditMode = false;
+
+            this.tool.actionDispatcher.dispatch(
+                ShowToastMessageAction.createWithTimeout({
+                    id: Symbol.for(ResizeKeyListener.name),
+                    message: messages.resize.resize_mode_deactivated
+                })
+            );
+
+            actions.push(EnableDefaultToolsAction.create());
+        }
+
+        if (selectedElementsIds.length > 0) {
+            if (!this.isEditMode && this.matchesActivateResizeModeKeystroke(event)) {
+                this.isEditMode = true;
+                this.tool.actionDispatcher.dispatch(
+                    ShowToastMessageAction.create({
+                        id: Symbol.for(ResizeKeyListener.name),
+                        message: messages.resize.resize_mode_activated
+                    })
+                );
+                actions.push(EnableToolsAction.create([ResizeKeyTool.ID]));
+            }
+
+            if (this.isEditMode) {
+                if (this.matchesIncreaseSizeKeystroke(event)) {
+                    actions.push(ResizeElementAction.create(selectedElementsIds, ResizeType.Increase));
+                } else if (this.matchesDecreaseSizeKeystroke(event)) {
+                    actions.push(ResizeElementAction.create(selectedElementsIds, ResizeType.Decrease));
+                } else if (this.matchesMinSizeKeystroke(event)) {
+                    actions.push(ResizeElementAction.create(selectedElementsIds, ResizeType.MinSize));
+                }
+            }
+        }
+        return actions;
+    }
+
+    protected matchesIncreaseSizeKeystroke(event: KeyboardEvent): boolean {
+        /** here event.key is used for '+', as keycode 187 is already declared for 'Equals' in {@link matchesKeystroke}.*/
+        return event.key === '+' || matchesKeystroke(event, 'NumpadAdd');
+    }
+
+    protected matchesActivateResizeModeKeystroke(event: KeyboardEvent): boolean {
+        return matchesKeystroke(event, 'KeyA', 'alt');
+    }
+
+    protected matchesDeactivateResizeModeKeystroke(event: KeyboardEvent): boolean {
+        return matchesKeystroke(event, 'Escape');
+    }
+
+    protected matchesMinSizeKeystroke(event: KeyboardEvent): boolean {
+        return matchesKeystroke(event, 'Digit0', 'ctrl') || matchesKeystroke(event, 'Numpad0', 'ctrl');
+    }
+
+    protected matchesDecreaseSizeKeystroke(event: KeyboardEvent): boolean {
+        return matchesKeystroke(event, 'Minus') || matchesKeystroke(event, 'NumpadSubtract');
+    }
+}

package/src/features/accessibility/search/search-palette-module.ts

@@ -0,0 +1,29 @@
+/********************************************************************************
+ * Copyright (c) 2023 Business Informatics Group (TU Wien) and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the Eclipse
+ * Public License v. 2.0 are satisfied: GNU General Public License, version 2
+ * with the GNU Classpath Exception which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ ********************************************************************************/
+
+import { bindAsService, BindingContext, FeatureModule, TYPES } from '~glsp-sprotty';
+import { SearchAutocompletePalette } from './search-palette';
+import { SearchAutocompletePaletteTool } from './search-tool';
+
+export const searchPaletteModule = new FeatureModule((bind, _unbind, isBound, rebind) => {
+    const context = { bind, isBound, rebind };
+    configureSearchPaletteModule(context);
+});
+
+export function configureSearchPaletteModule(context: Pick<BindingContext, 'bind'>): void {
+    bindAsService(context, TYPES.IUIExtension, SearchAutocompletePalette);
+    bindAsService(context, TYPES.IDefaultTool, SearchAutocompletePaletteTool);
+}

package/src/features/accessibility/search/search-palette.ts

@@ -14,15 +14,28 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 
-import { Action, CenterAction, SelectAction, SelectAllAction } from '@eclipse-glsp/protocol';
 import { injectable } from 'inversify';
 import { isEqual } from 'lodash';
-import { codiconCSSString, isNameable, LabeledAction, name, SEdge, SModelElement, SModelRoot, SNode } from 'sprotty';
 import { toArray } from 'sprotty/lib/utils/iterable';
+import {
+    Action,
+    CenterAction,
+    LabeledAction,
+    SEdge,
+    SModelElement,
+    SModelRoot,
+    SNode,
+    SelectAction,
+    SelectAllAction,
+    codiconCSSString,
+    isNameable,
+    name
+} from '~glsp-sprotty';
 import { AutocompleteSuggestion, IAutocompleteSuggestionProvider } from '../../autocomplete-palette/autocomplete-suggestion-providers';
 import { BaseAutocompletePalette } from '../../autocomplete-palette/base-autocomplete-palette';
 
-import { applyCssClasses, deleteCssClasses } from '../../tool-feedback/css-feedback';
+import { applyCssClasses, deleteCssClasses } from '../../../base/feedback/css-feedback';
+import { RepositionAction } from '../../../features/viewport/reposition';
 
 const CSS_SEARCH_HIDDEN = 'search-hidden';
 const CSS_SEARCH_HIGHLIGHTED = 'search-highlighted';
@@ -32,11 +45,11 @@ export class RevealNamedElementAutocompleteSuggestionProvider implements IAutoco
         const nameables = toArray(root.index.all().filter(element => isNameable(element)));
         return nameables.map(nameable => ({
             element: nameable,
-            action: new LabeledAction(
-                `[${nameable.type}] ${name(nameable) ?? '<no-name>'}`,
-                this.getActions(nameable),
-                codiconCSSString('eye')
-            )
+            action: {
+                label: `[${nameable.type}] ${name(nameable) ?? '<no-name>'}`,
+                actions: this.getActions(nameable),
+                icon: codiconCSSString('eye')
+            }
         }));
     }
 
@@ -50,11 +63,11 @@ export class RevealEdgeElementAutocompleteSuggestionProvider implements IAutocom
         const edges = toArray(root.index.all().filter(element => element instanceof SEdge)) as SEdge[];
         return edges.map(edge => ({
             element: edge,
-            action: new LabeledAction(
-                `[${edge.type}] ` + this.getEdgeLabel(root, edge),
-                this.getActions(edge),
-                codiconCSSString('arrow-both')
-            )
+            action: {
+                label: `[${edge.type}]  ${this.getEdgeLabel(root, edge)}`,
+                actions: this.getActions(edge),
+                icon: codiconCSSString('arrow-both')
+            }
         }));
     }
     protected getActions(edge: SEdge): Action[] {
@@ -91,6 +104,7 @@ export class SearchAutocompletePalette extends BaseAutocompletePalette {
         super.initializeContents(containerElement);
 
         this.autocompleteWidget.inputField.placeholder = 'Search for elements';
+        containerElement.setAttribute('aria-label', 'Search Field');
     }
     protected getSuggestionProviders(root: Readonly<SModelRoot>, input: string): IAutocompleteSuggestionProvider[] {
         return [new RevealNamedElementAutocompleteSuggestionProvider(), new RevealEdgeElementAutocompleteSuggestionProvider()];
@@ -120,8 +134,8 @@ export class SearchAutocompletePalette extends BaseAutocompletePalette {
         if (labeledAction !== undefined) {
             const suggestions = this.getSuggestionsFromLabeledActions([labeledAction]);
 
-            const actions: CenterAction[] = [];
-            suggestions.map(currElem => actions.push(CenterAction.create([currElem.element.id], { animate: true, retainZoom: true })));
+            const actions: RepositionAction[] = [];
+            suggestions.map(currElem => actions.push(RepositionAction.create([currElem.element.id])));
 
             this.actionDispatcher.dispatchAll(actions);
             await this.applyCSS(

package/src/features/accessibility/search/search-tool.ts

@@ -14,18 +14,19 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 
-import { Action } from '@eclipse-glsp/protocol';
 import { inject, injectable } from 'inversify';
-import { KeyListener, KeyTool, SetUIExtensionVisibilityAction, SModelElement, Tool } from 'sprotty';
 import { matchesKeystroke } from 'sprotty/lib/utils/keyboard';
+import { Action, KeyListener, KeyTool, SModelElement, SetUIExtensionVisibilityAction, TYPES } from '~glsp-sprotty';
+import { GLSPActionDispatcher } from '../../../base/action-dispatcher';
+import { Tool } from '../../../base/tool-manager/tool';
+import { AccessibleKeyShortcutProvider, SetAccessibleKeyShortcutAction } from '../key-shortcut/accessible-key-shortcut';
 import { SearchAutocompletePalette } from './search-palette';
-
 @injectable()
 export class SearchAutocompletePaletteTool implements Tool {
     static readonly ID = 'glsp.search-autocomplete-palette-tool';
 
-    protected readonly keyListener = new SearchAutocompletePaletteKeyListener();
-
+    protected readonly keyListener = new SearchAutocompletePaletteKeyListener(this);
+    @inject(TYPES.IActionDispatcher) readonly actionDispatcher: GLSPActionDispatcher;
     @inject(KeyTool) protected keyTool: KeyTool;
 
     get id(): string {
@@ -34,6 +35,7 @@ export class SearchAutocompletePaletteTool implements Tool {
 
     enable(): void {
         this.keyTool.register(this.keyListener);
+        this.keyListener.registerShortcutKey();
     }
 
     disable(): void {
@@ -41,7 +43,22 @@ export class SearchAutocompletePaletteTool implements Tool {
     }
 }
 
-export class SearchAutocompletePaletteKeyListener extends KeyListener {
+export class SearchAutocompletePaletteKeyListener extends KeyListener implements AccessibleKeyShortcutProvider {
+    protected readonly token = SearchAutocompletePalette.name;
+
+    constructor(protected tool: SearchAutocompletePaletteTool) {
+        super();
+    }
+
+    registerShortcutKey(): void {
+        this.tool.actionDispatcher.dispatchOnceModelInitialized(
+            SetAccessibleKeyShortcutAction.create({
+                token: this.token,
+                keys: [{ shortcuts: ['CTRL', 'F'], description: 'Activate search for elements', group: 'Search', position: 0 }]
+            })
+        );
+    }
+
     override keyDown(element: SModelElement, event: KeyboardEvent): Action[] {
         if (this.matchesSearchActivateKeystroke(event)) {
             return [

package/src/features/accessibility/toast/messages.json

@@ -0,0 +1,16 @@
+{
+  "navigation": {
+    "default_navigation_mode_activated": "Navigation On: Use arrow keys to select preceding (←) or succeding (→) elements. Use the up (↑) and down (↓) arrows to navigate paths. Press 'N' to exit.",
+    "default_navigation_mode_deactivated": "Navigation Off: Press 'N' for default navigation, 'ALT+N' for position based navigation.",
+    "local_navigation_mode_activated": "Position based Nav On: Navigate nearest elements using arrow keys: (↑) for above, (↓) for below, (←) for previous, (→) for next element. Press 'ALT+N' to exit.",
+    "local_navigation_mode_deactivated": "Position based Nav Off: Press 'N' for default navigation, 'ALT+N' for position based navigation."
+  },
+  "focus": {
+    "focus_on": "Currently focused: ",
+    "focus_off": "Currently no element is focused."
+  },
+  "resize": {
+    "resize_mode_activated": "Resize On: Use plus(+) and minus(-) to resize, 'CTRL'+'0' for default size. Press 'ESC' to exit.",
+    "resize_mode_deactivated": "Resize Off: Press 'ALT'+'A' for resize mode."
+  }
+}

package/src/features/accessibility/toast/toast-handler.ts

@@ -0,0 +1,69 @@
+/********************************************************************************
+ * Copyright (c) 2023 Business Informatics Group (TU Wien) and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the Eclipse
+ * Public License v. 2.0 are satisfied: GNU General Public License, version 2
+ * with the GNU Classpath Exception which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ ********************************************************************************/
+
+import { Action } from '~glsp-sprotty';
+
+export interface HideToastAction extends Action {
+    kind: typeof HideToastAction.KIND;
+    options: HideToastAction.Options;
+}
+
+export namespace HideToastAction {
+    export const KIND = 'hideToastMessageAction';
+
+    export type Options = Pick<ToastOptions, 'id' | 'timeout'>;
+
+    export function is(object: any): object is HideToastAction {
+        return Action.hasKind(object, KIND);
+    }
+
+    export function create(options: Options): HideToastAction {
+        return { kind: KIND, options };
+    }
+}
+
+export interface ShowToastMessageAction extends Action {
+    kind: typeof ShowToastMessageAction.KIND;
+    options: ToastOptions;
+}
+
+export namespace ShowToastMessageAction {
+    export const KIND = 'showToastMessageAction';
+    export const TIMEOUT = 2000;
+
+    export type CreateOptions = Partial<ToastOptions> & Required<Pick<ToastOptions, 'message'>>;
+
+    export function is(object: any): object is ShowToastMessageAction {
+        return Action.hasKind(object, KIND);
+    }
+
+    export function create(options: CreateOptions): ShowToastMessageAction {
+        return { kind: KIND, options: { ...options, position: options.position ?? 'center', id: options.id ?? Symbol('toast id') } };
+    }
+    export function createWithTimeout(options: CreateOptions): ShowToastMessageAction {
+        return {
+            kind: KIND,
+            options: { timeout: TIMEOUT, ...options, position: options.position ?? 'center', id: options.id ?? Symbol('toast id') }
+        };
+    }
+}
+
+export interface ToastOptions {
+    id: symbol;
+    timeout?: number;
+    position: 'left' | 'center' | 'right';
+    message: string;
+}

package/src/features/accessibility/toast/toast-module.ts

@@ -0,0 +1,36 @@
+/********************************************************************************
+ * Copyright (c) 2023 Business Informatics Group (TU Wien) and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the Eclipse
+ * Public License v. 2.0 are satisfied: GNU General Public License, version 2
+ * with the GNU Classpath Exception which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ ********************************************************************************/
+import { ContainerModule } from 'inversify';
+import { bindAsService, BindingContext, configureActionHandler, TYPES } from '~glsp-sprotty';
+import '../../../../css/toast.css';
+import { HideToastAction, ShowToastMessageAction } from './toast-handler';
+import { Toast } from './toast-tool';
+
+/**
+ * Handles toast/user notification actions.
+ */
+
+export const glspToastModule = new ContainerModule((bind, unbind, isBound, rebind) => {
+    const context = { bind, unbind, isBound, rebind };
+    configureToastTool(context);
+});
+
+export function configureToastTool(context: BindingContext): void {
+    bindAsService(context, TYPES.IUIExtension, Toast);
+    context.bind(TYPES.IDiagramStartup).toService(Toast);
+    configureActionHandler(context, ShowToastMessageAction.KIND, Toast);
+    configureActionHandler(context, HideToastAction.KIND, Toast);
+}

package/src/features/accessibility/toast/toast-tool.ts

@@ -0,0 +1,108 @@
+/********************************************************************************
+ * Copyright (c) 2023 Business Informatics Group (TU Wien) and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the Eclipse
+ * Public License v. 2.0 are satisfied: GNU General Public License, version 2
+ * with the GNU Classpath Exception which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ ********************************************************************************/
+
+import { injectable, inject } from 'inversify';
+import { Action, AbstractUIExtension, IActionHandler, ICommand, TYPES } from '~glsp-sprotty';
+import { IDiagramStartup } from '../../../base/model/diagram-loader';
+import { GLSPActionDispatcher } from '../../../base/action-dispatcher';
+import { EditorContextService } from '../../../base/editor-context-service';
+import { HideToastAction, ShowToastMessageAction, ToastOptions } from './toast-handler';
+
+/**
+ * This extension is used to create customized user notifications as toast messages.
+ */
+@injectable()
+export class Toast extends AbstractUIExtension implements IActionHandler, IDiagramStartup {
+    static readonly ID = 'toast';
+    protected messages: { [key: symbol]: ToastOptions } = {};
+
+    @inject(TYPES.IActionDispatcher) protected readonly actionDispatcher: GLSPActionDispatcher;
+    @inject(EditorContextService)
+    protected editorContext: EditorContextService;
+
+    id(): string {
+        return Toast.ID;
+    }
+    containerClass(): string {
+        return Toast.ID;
+    }
+
+    protected initializeContents(_containerElement: HTMLElement): void {
+        this.render();
+    }
+
+    handle(action: Action): ICommand | Action | void {
+        if (ShowToastMessageAction.is(action)) {
+            this.messages[action.options.id] = action.options;
+            this.render();
+
+            if (action.options.timeout) {
+                setTimeout(() => {
+                    this.delete(action.options.id);
+                }, action.options.timeout);
+            }
+        } else if (HideToastAction.is(action)) {
+            if (action.options.timeout) {
+                setTimeout(() => {
+                    this.delete(action.options.id);
+                }, action.options.timeout);
+            } else {
+                this.delete(action.options.id);
+            }
+        }
+    }
+
+    protected render(): void {
+        if (this.containerElement === undefined) {
+            return;
+        }
+
+        this.containerElement.innerHTML = '';
+
+        this.values(this.messages).forEach(message => {
+            this.containerElement.appendChild(this.createToastMessage(message));
+        });
+    }
+
+    protected delete(id: symbol): void {
+        delete this.messages[id];
+        this.render();
+    }
+
+    protected createToastMessage(option: ToastOptions): HTMLDivElement {
+        const cell = document.createElement('div');
+        cell.classList.add('toast-cell', `toast-column-${option.position}`);
+
+        const container = document.createElement('div');
+        container.classList.add('toast-container');
+
+        const text = document.createElement('span');
+        text.textContent = option.message;
+
+        container.appendChild(text);
+        cell.appendChild(container);
+
+        return cell;
+    }
+
+    preInitialize(): void {
+        this.show(this.editorContext.modelRoot);
+    }
+
+    values(obj: { [key: symbol]: ToastOptions }): ToastOptions[] {
+        return Object.getOwnPropertySymbols(obj).map(s => obj[s]);
+    }
+}

package/src/features/accessibility/view-key-tools/deselect-key-tool.ts

@@ -0,0 +1,88 @@
+/********************************************************************************
+ * Copyright (c) 2023 Business Informatics Group (TU Wien) and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the Eclipse
+ * Public License v. 2.0 are satisfied: GNU General Public License, version 2
+ * with the GNU Classpath Exception which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ ********************************************************************************/
+
+import { inject, injectable } from 'inversify';
+import { toArray } from 'sprotty/lib/utils/iterable';
+import { matchesKeystroke } from 'sprotty/lib/utils/keyboard';
+import {
+    Action,
+    KeyListener,
+    KeyTool,
+    SModelElement,
+    SRoutableElement,
+    SelectAction,
+    SwitchEditModeAction,
+    isSelectable
+} from '~glsp-sprotty';
+import { Tool } from '../../../base/tool-manager/tool';
+import { SResizeHandle } from '../../change-bounds/model';
+
+/**
+ * Deselects the element if there is no interaction possible with element.
+ */
+@injectable()
+export class DeselectKeyTool implements Tool {
+    static ID = 'glsp.deselect-key-tool';
+
+    isEditTool = true;
+
+    protected readonly deselectKeyListener = new DeselectKeyListener();
+
+    @inject(KeyTool) protected readonly keytool: KeyTool;
+
+    get id(): string {
+        return DeselectKeyTool.ID;
+    }
+
+    enable(): void {
+        this.keytool.register(this.deselectKeyListener);
+    }
+
+    disable(): void {
+        this.keytool.deregister(this.deselectKeyListener);
+    }
+}
+
+export class DeselectKeyListener extends KeyListener {
+    override keyDown(target: SModelElement, event: KeyboardEvent): Action[] {
+        if (this.matchesDeselectKeystroke(event)) {
+            const isResizeHandleActive = toArray(target.root.index.all().filter(el => el instanceof SResizeHandle)).length > 0;
+
+            if (isResizeHandleActive) {
+                return [];
+            }
+
+            const deselect = toArray(target.root.index.all().filter(element => isSelectable(element) && element.selected));
+            const actions: Action[] = [];
+
+            if (deselect.length > 0) {
+                actions.push(SelectAction.create({ deselectedElementsIDs: deselect.map(e => e.id) }));
+            }
+
+            const routableDeselect = deselect.filter(e => e instanceof SRoutableElement).map(e => e.id);
+            if (routableDeselect.length > 0) {
+                actions.push(SwitchEditModeAction.create({ elementsToDeactivate: routableDeselect }));
+            }
+
+            return actions;
+        }
+        return [];
+    }
+
+    protected matchesDeselectKeystroke(event: KeyboardEvent): boolean {
+        return matchesKeystroke(event, 'Escape');
+    }
+}