@eclipse-glsp/client 1.1.0-next.cb7168a.239 → 1.1.0-next.cc57a50.267

package/src/features/accessibility/move-zoom/zoom-handler.ts

@@ -0,0 +1,182 @@
+/********************************************************************************
+ * 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 { throttle } from 'lodash';
+import {
+    Action,
+    Bounds,
+    IActionDispatcher,
+    IActionHandler,
+    ICommand,
+    Point,
+    SChildElement,
+    SModelElement,
+    SModelRoot,
+    SetViewportAction,
+    TYPES,
+    Viewport,
+    findParentByFeature,
+    isViewport
+} from '~glsp-sprotty';
+import { EditorContextService } from '../../../base/editor-context-service';
+import { SelectableBoundsAware, getElements, isSelectableAndBoundsAware } from '../../../utils/smodel-util';
+
+/**
+ * Action for triggering zooming of the viewport.
+ */
+export interface ZoomViewportAction extends Action {
+    kind: typeof ZoomViewportAction.KIND;
+    /**
+     * used to specify the amount by which the viewport should be zoomed
+     */
+    zoomFactor: number;
+}
+
+export namespace ZoomViewportAction {
+    export const KIND = 'zoomViewportAction';
+
+    export function is(object: any): object is ZoomViewportAction {
+        return Action.hasKind(object, KIND);
+    }
+
+    export function create(zoomFactor: number): ZoomViewportAction {
+        return { kind: KIND, zoomFactor };
+    }
+}
+
+/**
+ * Action for triggering zooming of the elements..
+ */
+export interface ZoomElementAction extends Action {
+    kind: typeof ZoomElementAction.KIND;
+    /**
+     * used to specify the elements to be zoomed in/out
+     */
+    elementIds: string[];
+    /**
+     * used to specify the amount by which the viewport should be zoomed
+     */
+    zoomFactor: number;
+}
+
+export namespace ZoomElementAction {
+    export const KIND = 'zoomElementAction';
+
+    export function is(object: any): object is ZoomElementAction {
+        return Action.hasKind(object, KIND);
+    }
+
+    export function create(elementIds: string[], zoomFactor: number): ZoomElementAction {
+        return { kind: KIND, elementIds, zoomFactor };
+    }
+}
+
+/* The ZoomViewportHandler class is an implementation of the IActionHandler interface that handles
+zooming in and out of a viewport. */
+@injectable()
+export class ZoomViewportHandler implements IActionHandler {
+    @inject(EditorContextService)
+    protected editorContextService: EditorContextService;
+
+    static readonly defaultZoomInFactor = 1.1;
+    static readonly defaultZoomOutFactor = 0.9;
+
+    @inject(TYPES.IActionDispatcher) protected dispatcher: IActionDispatcher;
+    protected readonly throttledHandleViewportZoom = throttle((action: ZoomViewportAction) => this.handleZoomViewport(action), 150);
+
+    handle(action: Action): void {
+        if (ZoomViewportAction.is(action)) {
+            this.throttledHandleViewportZoom(action);
+        }
+    }
+
+    handleZoomViewport(action: ZoomViewportAction): void {
+        const viewport = findParentByFeature(this.editorContextService.modelRoot, isViewport);
+        if (!viewport) {
+            return;
+        }
+        this.dispatcher.dispatch(this.setNewZoomFactor(viewport, action.zoomFactor));
+    }
+
+    protected setNewZoomFactor(viewport: SModelRoot & Viewport, zoomFactor: number): SetViewportAction {
+        const newZoom = viewport.zoom * zoomFactor;
+
+        const newViewport = {
+            scroll: viewport.scroll,
+            zoom: newZoom
+        };
+
+        return SetViewportAction.create(viewport.id, newViewport, { animate: true });
+    }
+}
+
+/* The ZoomElementHandler class is an implementation of the IActionHandler interface that handles
+zooming in and out of elements. */
+@injectable()
+export class ZoomElementHandler implements IActionHandler {
+    @inject(EditorContextService)
+    protected editorContextService: EditorContextService;
+    @inject(TYPES.IActionDispatcher) protected dispatcher: IActionDispatcher;
+    protected readonly throttledHandleElementZoom = throttle((action: ZoomElementAction) => this.handleZoomElement(action), 150);
+
+    handle(action: Action): void | Action | ICommand {
+        if (ZoomElementAction.is(action)) {
+            this.throttledHandleElementZoom(action);
+        }
+    }
+
+    handleZoomElement(action: ZoomElementAction): void {
+        const viewport = findParentByFeature(this.editorContextService.modelRoot, isViewport);
+        if (!viewport) {
+            return;
+        }
+
+        const elements = getElements(this.editorContextService.modelRoot.index, action.elementIds, isSelectableAndBoundsAware);
+        const center = this.getCenter(viewport, elements);
+        this.dispatcher.dispatch(this.setNewZoomFactor(viewport, action.zoomFactor, center));
+    }
+
+    protected getCenter(viewport: SModelRoot & Viewport, selectedElements: SelectableBoundsAware[]): Point {
+        // Get bounds of elements based on the viewport
+        const allBounds = selectedElements.map(e => this.boundsInViewport(viewport, e, e.bounds));
+        const mergedBounds = allBounds.reduce((b0, b1) => Bounds.combine(b0, b1));
+        return Bounds.center(mergedBounds);
+    }
+
+    // copy from center-fit.ts, translates the children bounds to the viewport bounds
+    protected boundsInViewport(viewport: SModelRoot & Viewport, element: SModelElement, bounds: Bounds): Bounds {
+        if (element instanceof SChildElement && element.parent !== viewport) {
+            return this.boundsInViewport(viewport, element.parent, element.parent.localToParent(bounds) as Bounds);
+        } else {
+            return bounds;
+        }
+    }
+
+    protected setNewZoomFactor(viewport: SModelRoot & Viewport, zoomFactor: number, point: Point): SetViewportAction {
+        const newZoom = viewport.zoom * zoomFactor;
+
+        const newViewport = {
+            scroll: {
+                x: point.x - (0.5 * viewport.canvasBounds.width) / newZoom,
+                y: point.y - (0.5 * viewport.canvasBounds.height) / newZoom
+            },
+            zoom: newZoom
+        };
+
+        return SetViewportAction.create(viewport.id, newViewport, { animate: true });
+    }
+}

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

@@ -0,0 +1,129 @@
+/********************************************************************************
+ * 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 {
+    Action,
+    ChangeBoundsOperation,
+    Dimension,
+    IActionDispatcher,
+    IActionHandler,
+    ICommand,
+    ISnapper,
+    Point,
+    SModelElement,
+    SParentElement,
+    TYPES
+} from '~glsp-sprotty';
+import { EditorContextService } from '../../../base/editor-context-service';
+import { isValidMove, isValidSize, minHeight, minWidth } from '../../../utils/layout-utils';
+import { SelectableBoundsAware, getElements, isSelectableAndBoundsAware, toElementAndBounds } from '../../../utils/smodel-util';
+import { Resizable } from '../../change-bounds/model';
+import { GridSnapper } from '../../change-bounds/snap';
+
+export enum ResizeType {
+    Increase,
+    Decrease,
+    MinSize
+}
+
+/**
+ * Action for triggering resizing of elements.
+ */
+export interface ResizeElementAction extends Action {
+    kind: typeof ResizeElementAction.KIND;
+    elementIds: string[];
+    resizeType: ResizeType;
+}
+export namespace ResizeElementAction {
+    export const KIND = 'resizeElementAction';
+
+    export function is(object: any): object is ResizeElementAction {
+        return Action.hasKind(object, KIND);
+    }
+
+    export function create(elementIds: string[], resizeType: ResizeType): ResizeElementAction {
+        return { kind: KIND, elementIds, resizeType };
+    }
+}
+
+/* The ResizeElementHandler class is an implementation of the IActionHandler interface that handles
+resizing of elements. */
+@injectable()
+export class ResizeElementHandler implements IActionHandler {
+    @inject(EditorContextService)
+    protected editorContextService: EditorContextService;
+
+    @inject(TYPES.IActionDispatcher) protected dispatcher: IActionDispatcher;
+
+    // Default x resize used if GridSnapper is not provided
+    static readonly defaultResizeX = 20;
+
+    // Default y resize used if GridSnapper is not provided
+    static readonly defaultResizeY = 20;
+    protected grid = { x: ResizeElementHandler.defaultResizeX, y: ResizeElementHandler.defaultResizeY };
+
+    protected isEditMode = false;
+
+    constructor(@inject(TYPES.ISnapper) @optional() protected readonly snapper?: ISnapper) {
+        if (snapper instanceof GridSnapper) {
+            this.grid = snapper.grid;
+        }
+    }
+
+    handle(action: Action): void | Action | ICommand {
+        if (ResizeElementAction.is(action)) {
+            this.handleResizeElement(action);
+        }
+    }
+
+    handleResizeElement(action: ResizeElementAction): void {
+        const elements = getElements(this.editorContextService.modelRoot.index, action.elementIds, isSelectableAndBoundsAware);
+        this.dispatcher.dispatchAll(this.resize(elements, action));
+    }
+
+    protected resize(elements: SelectableBoundsAware[], action: ResizeElementAction): Action[] {
+        const actions: Action[] = [];
+
+        elements.forEach(element => {
+            const { x, y, width: oldWidth, height: oldHeight } = element.bounds;
+            let width = 0;
+            let height = 0;
+
+            if (action.resizeType === ResizeType.Decrease) {
+                width = oldWidth - this.grid.x;
+                height = oldHeight - this.grid.y;
+            } else if (action.resizeType === ResizeType.Increase) {
+                width = oldWidth + this.grid.x;
+                height = oldHeight + this.grid.y;
+            } else if (action.resizeType === ResizeType.MinSize) {
+                width = minWidth(element);
+                height = minHeight(element);
+            }
+
+            if (this.isValidBoundChange(element, { x, y }, { width, height })) {
+                const resizeElement = { id: element.id, bounds: { x, y, width, height } } as SModelElement & SParentElement & Resizable;
+                actions.push(ChangeBoundsOperation.create([toElementAndBounds(resizeElement)]));
+            }
+        });
+
+        return actions;
+    }
+
+    protected isValidBoundChange(element: SelectableBoundsAware, newPosition: Point, newSize: Dimension): boolean {
+        return isValidSize(element, newSize) && isValidMove(element, newPosition);
+    }
+}

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

@@ -0,0 +1,34 @@
+/********************************************************************************
+ * 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 { BindingContext, FeatureModule, TYPES, bindAsService, configureActionHandler } from '~glsp-sprotty';
+import { ResizeElementAction, ResizeElementHandler } from './resize-key-handler';
+import { ResizeKeyTool } from './resize-key-tool';
+
+/**
+ * Handles resize actions.
+ */
+export const resizeKeyModule = new FeatureModule((bind, unbind, isBound, rebind) => {
+    const context = { bind, unbind, isBound, rebind };
+    configureResizeTools(context);
+});
+
+export function configureResizeTools(context: BindingContext): void {
+    context.bind(ResizeElementHandler).toSelf().inSingletonScope();
+
+    configureActionHandler(context, ResizeElementAction.KIND, ResizeElementHandler);
+    bindAsService(context, TYPES.IDefaultTool, ResizeKeyTool);
+}

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

@@ -0,0 +1,127 @@
+/********************************************************************************
+ * 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, EnableDefaultToolsAction, EnableToolsAction, ISnapper, KeyListener, KeyTool, SModelElement, TYPES } from '~glsp-sprotty';
+import { GLSPActionDispatcher } from '../../../base/action-dispatcher';
+import { SelectionService } from '../../../base/selection-service';
+import { GLSPTool } from '../../../base/tool-manager/glsp-tool-manager';
+import { IMovementRestrictor } from '../../change-bounds/movement-restrictor';
+import { AccessibleKeyShortcutProvider, SetAccessibleKeyShortcutAction } from '../key-shortcut/accessible-key-shortcut';
+import { ResizeElementAction, ResizeType } from './resize-key-handler';
+
+@injectable()
+export class ResizeKeyTool implements GLSPTool {
+    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.onceModelInitialized().then(() => {
+            this.tool.actionDispatcher.dispatchAll([
+                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;
+            actions.push(EnableDefaultToolsAction.create());
+        }
+
+        if (selectedElementsIds.length > 0) {
+            if (!this.isEditMode && this.matchesActivateResizeModeKeystroke(event)) {
+                this.isEditMode = true;
+                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);
+}