@eclipse-glsp/client 1.1.0-next.93fd4ec.241 → 1.1.0-next.976795c.271

package/src/features/svg-metadata/metadata-placer.ts

@@ -14,11 +14,9 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 
-import { injectable, inject } from 'inversify';
+import { inject, injectable } from 'inversify';
 import { VNode } from 'snabbdom';
-import { IVNodePostprocessor, SChildElement, SEdge, setAttr, SModelElement, SModelRoot } from 'sprotty';
-import { DOMHelper } from 'sprotty/lib/base/views/dom-helper';
-import { TYPES } from '../../base/types';
+import { DOMHelper, IVNodePostprocessor, SChildElement, SEdge, SModelElement, SModelRoot, TYPES, setAttr } from '~glsp-sprotty';
 
 @injectable()
 export class MetadataPlacer implements IVNodePostprocessor {

package/src/features/svg-metadata/svg-metadata-module.ts

@@ -0,0 +1,23 @@
+/********************************************************************************
+ * 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 { FeatureModule, TYPES } from '~glsp-sprotty';
+import { MetadataPlacer } from './metadata-placer';
+
+export const svgMetadataModule = new FeatureModule(bind => {
+    bind(MetadataPlacer).toSelf().inSingletonScope();
+    bind(TYPES.IVNodePostprocessor).toService(MetadataPlacer);
+});

package/src/features/tool-palette/tool-palette-module.ts

@@ -0,0 +1,24 @@
+/********************************************************************************
+ * Copyright (c) 2019-2023 EclipseSource 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, configureActionHandler, EnableDefaultToolsAction, FeatureModule, TYPES } from '~glsp-sprotty';
+import '../../../css/tool-palette.css';
+import { ToolPalette } from './tool-palette';
+
+export const toolPaletteModule = new FeatureModule((bind, _unbind, isBound, _rebind) => {
+    bindAsService(bind, TYPES.IUIExtension, ToolPalette);
+    bind(TYPES.IDiagramStartup).toService(ToolPalette);
+    configureActionHandler({ bind, isBound }, EnableDefaultToolsAction.KIND, ToolPalette);
+});

package/src/features/tool-palette/tool-palette.ts

@@ -13,25 +13,32 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { Action, MarkersReason, PaletteItem, RequestContextActions, RequestMarkersAction, SetContextActions } from '@eclipse-glsp/protocol';
 import { inject, injectable, postConstruct } from 'inversify';
 import {
     AbstractUIExtension,
+    Action,
     EnableDefaultToolsAction,
     EnableToolsAction,
     IActionHandler,
     ICommand,
     IToolManager,
+    MarkersReason,
+    PaletteItem,
+    RequestContextActions,
+    RequestMarkersAction,
     SModelRoot,
+    SetContextActions,
     SetUIExtensionVisibilityAction,
-    TYPES
-} from 'sprotty';
-import { codiconCSSClasses } from 'sprotty/lib/utils/codicon';
-import { matchesKeystroke } from 'sprotty/lib/utils/keyboard';
+    TYPES,
+    codiconCSSClasses,
+    matchesKeystroke
+} from '~glsp-sprotty';
 import { GLSPActionDispatcher } from '../../base/action-dispatcher';
-import { EditModeListener, EditorContextService } from '../../base/editor-context-service';
-import { MouseDeleteTool } from '../tools/delete-tool';
-import { MarqueeMouseTool } from '../tools/marquee-mouse-tool';
+import { EditorContextService, IEditModeListener } from '../../base/editor-context-service';
+import { FocusTracker } from '../../base/focus/focus-tracker';
+import { IDiagramStartup } from '../../base/model/diagram-loader';
+import { MouseDeleteTool } from '../tools/deletion/delete-tool';
+import { MarqueeMouseTool } from '../tools/marquee-selection/marquee-mouse-tool';
 
 const CLICKED_CSS_CLASS = 'clicked';
 const SEARCH_ICON_ID = 'search';
@@ -55,17 +62,18 @@ export namespace EnableToolPaletteAction {
     }
 }
 @injectable()
-export class ToolPalette extends AbstractUIExtension implements IActionHandler, EditModeListener {
+export class ToolPalette extends AbstractUIExtension implements IActionHandler, IEditModeListener, IDiagramStartup {
     static readonly ID = 'tool-palette';
 
     @inject(TYPES.IActionDispatcher) protected readonly actionDispatcher: GLSPActionDispatcher;
     @inject(TYPES.IToolManager) protected readonly toolManager: IToolManager;
     @inject(EditorContextService) protected readonly editorContext: EditorContextService;
+    @inject(FocusTracker) protected readonly focusTracker: FocusTracker;
 
     protected paletteItems: PaletteItem[];
     protected paletteItemsCopy: PaletteItem[] = [];
     protected bodyDiv?: HTMLElement;
-    protected lastActivebutton?: HTMLElement;
+    protected lastActiveButton?: HTMLElement;
     protected defaultToolsButton: HTMLElement;
     protected searchField: HTMLInputElement;
     modelRootId: string;
@@ -79,7 +87,7 @@ export class ToolPalette extends AbstractUIExtension implements IActionHandler,
 
     @postConstruct()
     postConstruct(): void {
-        this.editorContext.register(this);
+        this.editorContext.onEditModeChanged(change => this.editModeChanged(change.newValue, change.oldValue));
     }
 
     override initialize(): boolean {
@@ -89,10 +97,11 @@ export class ToolPalette extends AbstractUIExtension implements IActionHandler,
         return super.initialize();
     }
 
-    protected initializeContents(_containerElement: HTMLElement): void {
+    protected initializeContents(containerElement: HTMLElement): void {
         this.createHeader();
         this.createBody();
-        this.lastActivebutton = this.defaultToolsButton;
+        this.lastActiveButton = this.defaultToolsButton;
+        containerElement.setAttribute('aria-label', 'Tool-Palette');
     }
 
     protected override onBeforeShow(_containerElement: HTMLElement, root: Readonly<SModelRoot>): void {
@@ -199,7 +208,9 @@ export class ToolPalette extends AbstractUIExtension implements IActionHandler,
         const button = createIcon('inspect');
         button.id = 'btn_default_tools';
         button.title = 'Enable selection tool';
-        button.onclick = this.onClickStaticToolButton(this.defaultToolsButton);
+        button.onclick = this.onClickStaticToolButton(button);
+        button.ariaLabel = button.title;
+        button.tabIndex = 1;
         return button;
     }
 
@@ -207,6 +218,8 @@ export class ToolPalette extends AbstractUIExtension implements IActionHandler,
         const deleteToolButton = createIcon('chrome-close');
         deleteToolButton.title = 'Enable deletion tool';
         deleteToolButton.onclick = this.onClickStaticToolButton(deleteToolButton, MouseDeleteTool.ID);
+        deleteToolButton.ariaLabel = deleteToolButton.title;
+        deleteToolButton.tabIndex = 1;
         return deleteToolButton;
     }
 
@@ -214,6 +227,8 @@ export class ToolPalette extends AbstractUIExtension implements IActionHandler,
         const marqueeToolButton = createIcon('screen-full');
         marqueeToolButton.title = 'Enable marquee tool';
         marqueeToolButton.onclick = this.onClickStaticToolButton(marqueeToolButton, MarqueeMouseTool.ID);
+        marqueeToolButton.ariaLabel = marqueeToolButton.title;
+        marqueeToolButton.tabIndex = 1;
         return marqueeToolButton;
     }
 
@@ -223,7 +238,10 @@ export class ToolPalette extends AbstractUIExtension implements IActionHandler,
         validateActionButton.onclick = _event => {
             const modelIds: string[] = [this.modelRootId];
             this.actionDispatcher.dispatch(RequestMarkersAction.create(modelIds, { reason: MarkersReason.BATCH }));
+            validateActionButton.focus();
         };
+        validateActionButton.ariaLabel = validateActionButton.title;
+        validateActionButton.tabIndex = 1;
         return validateActionButton;
     }
 
@@ -242,6 +260,8 @@ export class ToolPalette extends AbstractUIExtension implements IActionHandler,
         };
         searchIcon.classList.add('search-icon');
         searchIcon.title = 'Filter palette entries';
+        searchIcon.ariaLabel = searchIcon.title;
+        searchIcon.tabIndex = 1;
         return searchIcon;
     }
 
@@ -300,41 +320,27 @@ export class ToolPalette extends AbstractUIExtension implements IActionHandler,
     }
 
     changeActiveButton(button?: HTMLElement): void {
-        if (this.lastActivebutton) {
-            this.lastActivebutton.classList.remove(CLICKED_CSS_CLASS);
+        if (this.lastActiveButton) {
+            this.lastActiveButton.classList.remove(CLICKED_CSS_CLASS);
         }
         if (button) {
             button.classList.add(CLICKED_CSS_CLASS);
-            this.lastActivebutton = button;
-        } else {
+            this.lastActiveButton = button;
+        } else if (this.defaultToolsButton) {
             this.defaultToolsButton.classList.add(CLICKED_CSS_CLASS);
-            this.lastActivebutton = this.defaultToolsButton;
+            this.lastActiveButton = this.defaultToolsButton;
         }
     }
 
-    handle(action: Action): ICommand | Action | void {
-        if (action.kind === EnableToolPaletteAction.KIND) {
-            const requestAction = RequestContextActions.create({
-                contextId: ToolPalette.ID,
-                editorContext: {
-                    selectedElementIds: []
-                }
-            });
-            this.actionDispatcher.requestUntil(requestAction).then(response => {
-                if (SetContextActions.is(response)) {
-                    this.paletteItems = response.actions.map(e => e as PaletteItem);
-                    this.actionDispatcher.dispatch(
-                        SetUIExtensionVisibilityAction.create({ extensionId: ToolPalette.ID, visible: !this.editorContext.isReadonly })
-                    );
-                }
-            });
-        } else if (action.kind === EnableDefaultToolsAction.KIND) {
-            this.changeActiveButton();
+    handle(action: EnableDefaultToolsAction): ICommand | Action | void {
+        this.changeActiveButton();
+        if (this.focusTracker.hasFocus) {
+            // if focus was deliberately taken do not restore focus to the palette
             this.restoreFocus();
         }
     }
 
-    editModeChanged(_oldValue: string, _newValue: string): void {
+    editModeChanged(_newValue: string, _oldValue: string): void {
         this.actionDispatcher.dispatch(
             SetUIExtensionVisibilityAction.create({ extensionId: ToolPalette.ID, visible: !this.editorContext.isReadonly })
         );
@@ -386,6 +392,20 @@ export class ToolPalette extends AbstractUIExtension implements IActionHandler,
         this.paletteItems = filteredPaletteItems;
         this.createBody();
     }
+
+    async preRequestModel(): Promise<void> {
+        const requestAction = RequestContextActions.create({
+            contextId: ToolPalette.ID,
+            editorContext: {
+                selectedElementIds: []
+            }
+        });
+        const response = await this.actionDispatcher.request<SetContextActions>(requestAction);
+        this.paletteItems = response.actions.map(e => e as PaletteItem);
+        if (!this.editorContext.isReadonly) {
+            this.show(this.editorContext.modelRoot);
+        }
+    }
 }
 
 export function compare(a: PaletteItem, b: PaletteItem): number {

package/src/features/tools/base-glsp-creation-tool.ts

@@ -0,0 +1,40 @@
+/********************************************************************************
+ * Copyright (c) 2023 EclipseSource 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 } from 'inversify';
+import { Action, EnableToolsAction, IActionHandler } from '~glsp-sprotty';
+import { BaseGLSPTool } from './base-glsp-tool';
+
+@injectable()
+export abstract class BaseGLSPCreationTool<T extends Action> extends BaseGLSPTool implements IActionHandler {
+    protected abstract isTriggerAction: (obj: any) => obj is T;
+    protected triggerAction: T;
+
+    handle(action: Action): Action | void {
+        if (this.isTriggerAction(action)) {
+            this.triggerAction = action;
+            return EnableToolsAction.create([this.id]);
+        }
+    }
+
+    override enable(): void {
+        if (this.triggerAction === undefined) {
+            throw new TypeError(`Could not enable tool ${this.id}. The triggerAction cannot be undefined.`);
+        }
+        this.doEnable();
+    }
+
+    protected abstract doEnable(): void;
+}

package/src/features/tools/base-glsp-tool.ts

@@ -1,5 +1,5 @@
 /********************************************************************************
- * Copyright (c) 2020-2022 EclipseSource and others.
+ * Copyright (c) 2020-2023 EclipseSource 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
@@ -13,25 +13,29 @@
  *
  * 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 { IActionDispatcher, KeyTool } from 'sprotty';
+import { Action, Disposable, DisposableCollection, IActionDispatcher, TYPES } from '~glsp-sprotty';
 import { EditorContextService } from '../../base/editor-context-service';
+import { IFeedbackActionDispatcher, IFeedbackEmitter } from '../../base/feedback/feedback-action-dispatcher';
 import { GLSPTool } from '../../base/tool-manager/glsp-tool-manager';
-import { TYPES } from '../../base/types';
-import { IMouseTool } from '../mouse-tool/mouse-tool';
-import { IFeedbackActionDispatcher, IFeedbackEmitter } from '../tool-feedback/feedback-action-dispatcher';
+import { GLSPKeyTool } from '../../base/view/key-tool';
+import { GLSPMouseTool } from '../../base/view/mouse-tool';
 
 @injectable()
 export abstract class BaseGLSPTool implements GLSPTool {
     @inject(TYPES.IFeedbackActionDispatcher) protected feedbackDispatcher: IFeedbackActionDispatcher;
     @inject(TYPES.IActionDispatcher) protected actionDispatcher: IActionDispatcher;
-    @inject(TYPES.MouseTool) protected mouseTool: IMouseTool;
-    @inject(KeyTool) protected keyTool: KeyTool;
+    @inject(GLSPMouseTool) protected mouseTool: GLSPMouseTool;
+    @inject(GLSPKeyTool) protected keyTool: GLSPKeyTool;
     @inject(EditorContextService) protected readonly editorContext: EditorContextService;
 
+    protected readonly toDisposeOnDisable = new DisposableCollection();
+
     abstract enable(): void;
-    abstract disable(): void;
+
+    disable(): void {
+        this.toDisposeOnDisable.dispose();
+    }
 
     abstract id: string;
 
@@ -43,11 +47,27 @@ export abstract class BaseGLSPTool implements GLSPTool {
         this.actionDispatcher.dispatchAll(actions);
     }
 
-    dispatchFeedback(actions: Action[], feedbackEmitter?: IFeedbackEmitter): void {
-        this.feedbackDispatcher.registerFeedback(feedbackEmitter ?? this, actions);
+    /**
+     * Registers `actions` to be sent out as feedback, i.e., changes that are re-established whenever the `SModelRoot`
+     * has been set or updated.
+     *
+     * @param feedbackActions the actions to be sent out.
+     * @param feedbackEmitter the emitter sending out feedback actions (this tool by default).
+     * @param cleanupActions the actions to be sent out when the feedback is de-registered through the returned Disposable.
+     * @returns A 'Disposable' that de-registers the feedback and cleans up any pending feedback with the given `cleanupActions`.
+     */
+    registerFeedback(feedbackActions: Action[], feedbackEmitter?: IFeedbackEmitter, cleanupActions?: Action[]): Disposable {
+        return this.feedbackDispatcher.registerFeedback(feedbackEmitter ?? this, feedbackActions, cleanupActions);
     }
 
-    deregisterFeedback(actions: Action[], feedbackEmitter?: IFeedbackEmitter): void {
-        this.feedbackDispatcher.deregisterFeedback(feedbackEmitter ?? this, actions);
+    /**
+     * De-registers all feedback from the given `feedbackEmitter` (this tool by default) and cleans up any pending feedback with the
+     * given `cleanupActions`.
+     *
+     * @param feedbackEmitter the emitter to be deregistered (this tool by default).
+     * @param cleanupActions the actions to be dispatched right after the deregistration to clean up any pending feedback.
+     */
+    deregisterFeedback(feedbackEmitter?: IFeedbackEmitter, cleanupActions?: Action[]): void {
+        this.feedbackDispatcher.deregisterFeedback(feedbackEmitter ?? this, cleanupActions);
     }
 }

package/src/features/tools/change-bounds/change-boounds-tool-module.ts

@@ -0,0 +1,28 @@
+/********************************************************************************
+ * Copyright (c) 2019-2023 EclipseSource 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 { FeatureModule, TYPES, bindAsService, configureCommand, configureView } from '~glsp-sprotty';
+import { SResizeHandle } from '../../change-bounds/model';
+import { ChangeBoundsTool } from './change-bounds-tool';
+import { HideChangeBoundsToolResizeFeedbackCommand, ShowChangeBoundsToolResizeFeedbackCommand } from './change-bounds-tool-feedback';
+import { SResizeHandleView } from './view';
+
+export const changeBoundsToolModule = new FeatureModule((bind, unbind, isBound, rebind) => {
+    const context = { bind, unbind, isBound, rebind };
+    bindAsService(context, TYPES.IDefaultTool, ChangeBoundsTool);
+    configureCommand(context, ShowChangeBoundsToolResizeFeedbackCommand);
+    configureCommand(context, HideChangeBoundsToolResizeFeedbackCommand);
+    configureView(context, SResizeHandle.TYPE, SResizeHandleView);
+});