sprotty/src/features/context-menu/mouse-listener.ts

A next-gen framework for graphical views

/********************************************************************************
 * Copyright (c) 2019 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 { inject } from "inversify";
import { Action, SelectAction } from "sprotty-protocol/lib/actions";
import { IActionDispatcher } from "../../base/actions/action-dispatcher";
import { SModelElementImpl } from "../../base/model/smodel";
import { findParentByFeature } from "../../base/model/smodel-utils";
import { TYPES } from "../../base/types";
import { MouseListener } from "../../base/views/mouse-tool";
import { isSelectable, isSelected } from "../select/model";
import { IContextMenuService, IContextMenuServiceProvider } from "./context-menu-service";
import { ContextMenuProviderRegistry } from "./menu-providers";

export class ContextMenuMouseListener extends MouseListener {
    @inject(TYPES.IActionDispatcher) protected actionDispatcher: IActionDispatcher;
    constructor(
        @inject(TYPES.IContextMenuServiceProvider) protected readonly contextMenuService: IContextMenuServiceProvider,
        @inject(TYPES.IContextMenuProviderRegistry) protected readonly menuProvider: ContextMenuProviderRegistry) {
        super();
    }

    override contextMenu(target: SModelElementImpl, event: MouseEvent): (Action | Promise<Action>)[] {
        this.showContextMenu(target, event);
        return [];
    }

    protected async showContextMenu(target: SModelElementImpl, event: MouseEvent): Promise<void> {
        let menuService: IContextMenuService;
        try {
            menuService = await this.contextMenuService();
        } catch (rejected) {
            // IContextMenuService is not bound => do nothing
            return;
        }

        let isTargetSelected = false;
        const selectableTarget = findParentByFeature(target, isSelectable);
        if (selectableTarget) {
            isTargetSelected = selectableTarget.selected;
            selectableTarget.selected = true;
        }

        const root = target.root;
        const mousePosition = { x: event.x, y: event.y };
        if (target.id === root.id || isSelected(selectableTarget)) {
            const menuItems = await this.menuProvider.getItems(root, mousePosition);
            const restoreSelection = () => { if (selectableTarget) selectableTarget.selected = isTargetSelected; };
            menuService.show(menuItems, mousePosition, restoreSelection);
        } else {
            if (isSelectable(target)) {
                const options = { selectedElementsIDs: [target.id], deselectedElementsIDs: Array.from(root.index.all().filter(isSelected), (val) => { return val.id; }) };
                await this.actionDispatcher.dispatch(SelectAction.create(options));
            }
            const items = await this.menuProvider.getItems(root, mousePosition);
            menuService.show(items, mousePosition);
        }
    }
}