@eclipse-glsp/client 2.4.0-next.409 → 2.4.0-next.413

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

@@ -1,182 +0,0 @@
-/********************************************************************************
- * 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,
-    GChildElement,
-    IActionDispatcher,
-    IActionHandler,
-    ICommand,
-    Point,
-    GModelElement,
-    GModelRoot,
-    SetViewportAction,
-    TYPES,
-    Viewport,
-    findParentByFeature,
-    isViewport
-} from '@eclipse-glsp/sprotty';
-import { EditorContextService } from '../../../base/editor-context-service';
-import { SelectableBoundsAware, getElements, isSelectableAndBoundsAware } from '../../../utils/gmodel-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: GModelRoot & 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: GModelRoot & 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: GModelRoot & Viewport, element: GModelElement, bounds: Bounds): Bounds {
-        if (element instanceof GChildElement && element.parent !== viewport) {
-            return this.boundsInViewport(viewport, element.parent, element.parent.localToParent(bounds) as Bounds);
-        } else {
-            return bounds;
-        }
-    }
-
-    protected setNewZoomFactor(viewport: GModelRoot & 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-tool.ts

@@ -1,139 +0,0 @@
-/********************************************************************************
- * 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, GModelElement, IActionDispatcher, ISnapper, KeyListener, KeyTool, matchesKeystroke, TYPES } from '@eclipse-glsp/sprotty';
-import { inject, injectable, optional } from 'inversify';
-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: IActionDispatcher;
-    @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: GModelElement, 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/view-key-tools/movement-key-tool.ts

@@ -1,135 +0,0 @@
-/********************************************************************************
- * Copyright (c) 2023-2024 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, GModelElement, IActionDispatcher, ISnapper, KeyListener, KeyTool, matchesKeystroke, TYPES } from '@eclipse-glsp/sprotty';
-import { inject, injectable, optional } from 'inversify';
-import { SelectionService } from '../../../base/selection-service';
-import { Tool } from '../../../base/tool-manager/tool';
-import { Grid } from '../../grid/grid';
-import { IChangeBoundsManager } from '../../tools/change-bounds/change-bounds-manager';
-import { AccessibleKeyShortcutProvider, SetAccessibleKeyShortcutAction } from '../key-shortcut/accessible-key-shortcut';
-import { MoveElementAction, MoveViewportAction } from '../move-zoom/move-handler';
-
-/**
- * Moves viewport and elements when its focused and arrow keys are hit.
- */
-@injectable()
-export class MovementKeyTool implements Tool {
-    static ID = 'glsp.movement-key-tool';
-
-    isEditTool = true;
-
-    protected movementKeyListener: MoveKeyListener;
-
-    @inject(KeyTool) protected readonly keytool: KeyTool;
-    @inject(SelectionService) selectionService: SelectionService;
-    @inject(TYPES.ISnapper) @optional() readonly snapper?: ISnapper;
-    @inject(TYPES.IActionDispatcher) readonly actionDispatcher: IActionDispatcher;
-    @inject(TYPES.Grid) @optional() protected grid: Grid;
-    @inject(TYPES.IChangeBoundsManager) readonly changeBoundsManager: IChangeBoundsManager;
-
-    get id(): string {
-        return MovementKeyTool.ID;
-    }
-
-    enable(): void {
-        if (!this.movementKeyListener) {
-            this.movementKeyListener = new MoveKeyListener(this, this.grid);
-        }
-        this.keytool.register(this.movementKeyListener);
-        this.movementKeyListener.registerShortcutKey();
-    }
-
-    disable(): void {
-        this.keytool.deregister(this.movementKeyListener);
-    }
-}
-
-export class MoveKeyListener extends KeyListener implements AccessibleKeyShortcutProvider {
-    // Default x distance used if grid is not provided
-    static readonly defaultMoveX = 20;
-
-    // Default y distance used if grid is not provided
-    static readonly defaultMoveY = 20;
-
-    protected readonly token = MoveKeyListener.name;
-
-    constructor(
-        protected readonly tool: MovementKeyTool,
-        protected grid: Grid = { x: MoveKeyListener.defaultMoveX, y: MoveKeyListener.defaultMoveY }
-    ) {
-        super();
-    }
-
-    registerShortcutKey(): void {
-        this.tool.actionDispatcher.dispatchOnceModelInitialized(
-            SetAccessibleKeyShortcutAction.create({
-                token: this.token,
-                keys: [{ shortcuts: ['⬅  ⬆  ➡  ⬇'], description: 'Move element or viewport', group: 'Move', position: 0 }]
-            })
-        );
-    }
-
-    override keyDown(_element: GModelElement, event: KeyboardEvent): Action[] {
-        const selectedElementIds = this.tool.selectionService.getSelectedElementIDs();
-        const snap = this.tool.changeBoundsManager.usePositionSnap(event);
-        const offsetX = snap ? this.grid.x : 1;
-        const offsetY = snap ? this.grid.y : 1;
-
-        if (selectedElementIds.length > 0) {
-            if (this.matchesMoveUpKeystroke(event)) {
-                return [MoveElementAction.create(selectedElementIds, 0, -offsetY, snap)];
-            } else if (this.matchesMoveDownKeystroke(event)) {
-                return [MoveElementAction.create(selectedElementIds, 0, offsetY, snap)];
-            } else if (this.matchesMoveRightKeystroke(event)) {
-                return [MoveElementAction.create(selectedElementIds, offsetX, 0, snap)];
-            } else if (this.matchesMoveLeftKeystroke(event)) {
-                return [MoveElementAction.create(selectedElementIds, -offsetX, 0, snap)];
-            }
-        } else {
-            if (this.matchesMoveUpKeystroke(event)) {
-                return [MoveViewportAction.create(0, -offsetY)];
-            } else if (this.matchesMoveDownKeystroke(event)) {
-                return [MoveViewportAction.create(0, offsetY)];
-            } else if (this.matchesMoveRightKeystroke(event)) {
-                return [MoveViewportAction.create(offsetX, 0)];
-            } else if (this.matchesMoveLeftKeystroke(event)) {
-                return [MoveViewportAction.create(-offsetX, 0)];
-            }
-        }
-        return [];
-    }
-
-    protected matchesMoveUpKeystroke(event: KeyboardEvent): boolean {
-        const unsnap = this.tool.changeBoundsManager.unsnapModifier();
-        return matchesKeystroke(event, 'ArrowUp') || (!!unsnap && matchesKeystroke(event, 'ArrowUp', unsnap));
-    }
-
-    protected matchesMoveDownKeystroke(event: KeyboardEvent): boolean {
-        const unsnap = this.tool.changeBoundsManager.unsnapModifier();
-        return matchesKeystroke(event, 'ArrowDown') || (!!unsnap && matchesKeystroke(event, 'ArrowDown', unsnap));
-    }
-
-    protected matchesMoveRightKeystroke(event: KeyboardEvent): boolean {
-        const unsnap = this.tool.changeBoundsManager.unsnapModifier();
-        return matchesKeystroke(event, 'ArrowRight') || (!!unsnap && matchesKeystroke(event, 'ArrowRight', unsnap));
-    }
-
-    protected matchesMoveLeftKeystroke(event: KeyboardEvent): boolean {
-        const unsnap = this.tool.changeBoundsManager.unsnapModifier();
-        return matchesKeystroke(event, 'ArrowLeft') || (!!unsnap && matchesKeystroke(event, 'ArrowLeft', unsnap));
-    }
-}