@eclipse-glsp/client 2.3.0-next.378 → 2.3.0-next.381

package/src/features/tools/change-bounds/change-bounds-manager.ts

@@ -46,7 +46,7 @@ import {
     movementRestrictionFeedback,
     removeMovementRestrictionFeedback
 } from '../../change-bounds/movement-restrictor';
-import { GridManager } from '../../grid/grid-manager';
+import { IGridManager } from '../../grid/grid-manager';
 import { IHelperLineManager } from '../../helper-lines/helper-line-manager';
 import { InsertIndicator } from '../node-creation/insert-indicator';
 import { ChangeBoundsTracker, TrackedElementMove, TrackedElementResize, TrackedMove, TrackedResize } from './change-bounds-tracker';
@@ -55,14 +55,140 @@ export const CSS_RESIZE_MODE = 'resize-mode';
 export const CSS_RESTRICTED_RESIZE = 'resize-not-allowed';
 export const CSS_ACTIVE_HANDLE = 'active';
 
+export interface IChangeBoundsManager {
+    /**
+     * Unsnap the modifier used for changing bounds.
+     * @returns The unsnapped keyboard modifier, or undefined if no modifier was snapped.
+     */
+    unsnapModifier(): KeyboardModifier | undefined;
+
+    /**
+     * Determine whether to use position snap for changing bounds.
+     * @param arg - The event argument.
+     * @returns True if position snap should be used, false otherwise.
+     */
+    usePositionSnap(arg: MouseEvent | KeyboardEvent | any): boolean;
+
+    /**
+     * Snap the position of an element.
+     * @param element - The element to snap.
+     * @param position - The position to snap.
+     * @returns The snapped position.
+     */
+    snapPosition(element: GModelElement, position: Point): Point;
+
+    /**
+     * Check if an element is valid for changing bounds.
+     * @param element - The element to check.
+     * @returns True if the element is valid, false otherwise.
+     */
+    isValid(element: GModelElement): boolean;
+
+    /**
+     * Check if an element has a valid position for changing bounds.
+     * @param element - The element to check.
+     * @param position - The position to check.
+     * @returns True if the element has a valid position, false otherwise.
+     */
+    hasValidPosition(element: GModelElement, position?: Point): boolean;
+
+    /**
+     * Check if an element has a valid size for changing bounds.
+     * @param element - The element to check.
+     * @param size - The size to check.
+     * @returns True if the element has a valid size, false otherwise.
+     */
+    hasValidSize(element: GModelElement, size?: Dimension): boolean;
+
+    /**
+     * Get the minimum size of an element for changing bounds.
+     * @param element - The element to get the minimum size for.
+     * @returns The minimum size of the element.
+     */
+    getMinimumSize(element: GModelElement): Dimension;
+
+    /**
+     * Determine whether to use movement restriction for changing bounds.
+     * @param arg - The event argument.
+     * @returns True if movement restriction should be used, false otherwise.
+     */
+    useMovementRestriction(arg: MouseEvent | KeyboardEvent | any): boolean;
+
+    /**
+     * Restrict the movement of an element.
+     * @param element - The element to restrict movement for.
+     * @param movement - The movement to restrict.
+     * @returns The restricted movement.
+     */
+    restrictMovement(element: GModelElement, movement: Movement): Movement;
+
+    /**
+     * Add move feedback for changing bounds.
+     * @param feedback - The feedback emitter.
+     * @param trackedMove - The tracked move.
+     * @param ctx - The context element. (optional)
+     * @param event - The mouse event. (optional)
+     * @returns The feedback emitter.
+     */
+    addMoveFeedback(feedback: FeedbackEmitter, trackedMove: TrackedMove, ctx?: GModelElement, event?: MouseEvent): FeedbackEmitter;
+
+    /**
+     * Add resize feedback for changing bounds.
+     * @param feedback - The feedback emitter.
+     * @param resize - The tracked resize.
+     * @param ctx - The context element. (optional)
+     * @param event - The mouse event. (optional)
+     * @returns The feedback emitter.
+     */
+    addResizeFeedback(feedback: FeedbackEmitter, resize: TrackedResize, ctx?: GModelElement, event?: MouseEvent): FeedbackEmitter;
+
+    /**
+     * Add move restriction feedback for changing bounds.
+     * @param feedback - The feedback emitter.
+     * @param change - The tracked element resize or move.
+     * @param ctx - The context element. (optional)
+     * @param event - The mouse event. (optional)
+     * @returns The feedback emitter.
+     */
+    addMoveRestrictionFeedback(
+        feedback: FeedbackEmitter,
+        change: TrackedElementResize | TrackedElementMove,
+        ctx?: GModelElement,
+        event?: MouseEvent
+    ): FeedbackEmitter;
+
+    /**
+     * Get the default resize locations for changing bounds.
+     * @returns The default resize handle locations.
+     */
+    defaultResizeLocations(): ResizeHandleLocation[];
+
+    /**
+     * Determine whether to use symmetric resize for changing bounds.
+     * @param arg - The event argument.
+     * @returns True if symmetric resize should be used, false otherwise.
+     */
+    useSymmetricResize(arg: MouseEvent | KeyboardEvent | any): boolean;
+
+    /**
+     * Create a tracker for changing bounds.
+     * @returns The change bounds tracker.
+     */
+    createTracker(): ChangeBoundsTracker;
+}
+
+/**
+ * The default {@link IChangeBoundsManager} implementation. It is responsible for managing
+ * the change of bounds for {@link GModelElement}s.
+ */
 @injectable()
-export class ChangeBoundsManager {
+export class ChangeBoundsManager implements IChangeBoundsManager {
     constructor(
         @inject(MousePositionTracker) readonly positionTracker: MousePositionTracker,
         @optional() @inject(TYPES.IMovementRestrictor) readonly movementRestrictor?: IMovementRestrictor,
         @optional() @inject(TYPES.ISnapper) readonly snapper?: ISnapper,
         @optional() @inject(TYPES.IHelperLineManager) readonly helperLineManager?: IHelperLineManager,
-        @optional() @inject(GridManager) protected gridManager?: GridManager
+        @optional() @inject(TYPES.IGridManager) protected gridManager?: IGridManager
     ) {}
 
     unsnapModifier(): KeyboardModifier | undefined {

package/src/features/tools/change-bounds/change-bounds-tool-feedback.ts

@@ -20,7 +20,7 @@ import { FeedbackCommand } from '../../../base/feedback/feedback-command';
 import { OptionalAction } from '../../../base/model/glsp-model-source';
 import { forEachElement } from '../../../utils/gmodel-util';
 import { ResizeHandleLocation, addResizeHandles, isResizable, removeResizeHandles } from '../../change-bounds/model';
-import { ChangeBoundsManager } from './change-bounds-manager';
+import { IChangeBoundsManager } from './change-bounds-manager';
 
 export interface ShowChangeBoundsToolResizeFeedbackAction extends Action {
     kind: typeof ShowChangeBoundsToolResizeFeedbackAction.KIND;
@@ -71,7 +71,7 @@ export class ShowChangeBoundsToolResizeFeedbackCommand extends FeedbackCommand {
     static readonly KIND = ShowChangeBoundsToolResizeFeedbackAction.KIND;
 
     @inject(TYPES.Action) protected action: ShowChangeBoundsToolResizeFeedbackAction;
-    @inject(ChangeBoundsManager) protected changeBoundsManager: ChangeBoundsManager;
+    @inject(TYPES.IChangeBoundsManager) protected changeBoundsManager: IChangeBoundsManager;
 
     execute(context: CommandExecutionContext): CommandReturn {
         const index = context.root.index;

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

@@ -24,7 +24,7 @@ import { GResizeHandleView } from './view';
 export const changeBoundsToolModule = new FeatureModule(
     (bind, unbind, isBound, rebind) => {
         const context = { bind, unbind, isBound, rebind };
-        bind(ChangeBoundsManager).toSelf().inSingletonScope();
+        bindAsService(context, TYPES.IChangeBoundsManager, ChangeBoundsManager);
         bindAsService(context, TYPES.IDefaultTool, ChangeBoundsTool);
         configureCommand(context, ShowChangeBoundsToolResizeFeedbackCommand);
         configureCommand(context, HideChangeBoundsToolResizeFeedbackCommand);

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

@@ -54,7 +54,7 @@ import { SetBoundsFeedbackAction } from '../../bounds/set-bounds-feedback-comman
 import { GResizeHandle, isResizable } from '../../change-bounds/model';
 import { IMovementRestrictor } from '../../change-bounds/movement-restrictor';
 import { BaseEditTool } from '../base-tools';
-import { CSS_ACTIVE_HANDLE, ChangeBoundsManager } from './change-bounds-manager';
+import { CSS_ACTIVE_HANDLE, IChangeBoundsManager } from './change-bounds-manager';
 import {
     HideChangeBoundsToolResizeFeedbackAction,
     MoveFinishedEventAction,
@@ -83,7 +83,7 @@ export class ChangeBoundsTool extends BaseEditTool {
     @inject(SelectionService) protected selectionService: SelectionService;
     @inject(EdgeRouterRegistry) @optional() readonly edgeRouterRegistry?: EdgeRouterRegistry;
     @inject(TYPES.IMovementRestrictor) @optional() readonly movementRestrictor?: IMovementRestrictor;
-    @inject(ChangeBoundsManager) readonly changeBoundsManager: ChangeBoundsManager;
+    @inject(TYPES.IChangeBoundsManager) readonly changeBoundsManager: IChangeBoundsManager;
 
     get id(): string {
         return ChangeBoundsTool.ID;

package/src/features/tools/edge-edit/edge-edit-tool-feedback.ts

@@ -48,7 +48,7 @@ import { FeedbackEmitter } from '../../../base/feedback/feedback-emitter';
 import { forEachElement, getMatchingElements, isRoutable, isRoutingHandle } from '../../../utils/gmodel-util';
 import { getAbsolutePosition, toAbsoluteBounds } from '../../../utils/viewpoint-util';
 import { addReconnectHandles, removeReconnectHandles } from '../../reconnect/model';
-import { ChangeBoundsManager } from '../change-bounds/change-bounds-manager';
+import { IChangeBoundsManager } from '../change-bounds/change-bounds-manager';
 import { ChangeBoundsTracker, MoveableRoutingHandle } from '../change-bounds/change-bounds-tracker';
 import { FeedbackEdgeEnd, feedbackEdgeEndId, feedbackEdgeId } from '../edge-creation/dangling-edge-feedback';
 import { FeedbackEdgeEndMovingMouseListener } from '../edge-creation/edge-creation-tool-feedback';
@@ -259,7 +259,7 @@ export class FeedbackEdgeRouteMovingMouseListener extends DragAwareMouseListener
     protected tracker: ChangeBoundsTracker;
 
     constructor(
-        protected changeBoundsManager: ChangeBoundsManager,
+        protected changeBoundsManager: IChangeBoundsManager,
         protected edgeRouterRegistry?: EdgeRouterRegistry
     ) {
         super();

package/src/features/tools/edge-edit/edge-edit-tool.ts

@@ -24,6 +24,7 @@ import {
     GRoutableElement,
     GRoutingHandle,
     ReconnectEdgeOperation,
+    TYPES,
     canEditRouting,
     findParentByFeature,
     isConnectable,
@@ -37,7 +38,7 @@ import { ISelectionListener, SelectionService } from '../../../base/selection-se
 import { calcElementAndRoutingPoints, isRoutable, isRoutingHandle } from '../../../utils/gmodel-util';
 import { GReconnectHandle, isReconnectHandle, isReconnectable, isSourceRoutingHandle, isTargetRoutingHandle } from '../../reconnect/model';
 import { BaseEditTool } from '../base-tools';
-import { ChangeBoundsManager } from '../change-bounds/change-bounds-manager';
+import { IChangeBoundsManager } from '../change-bounds/change-bounds-manager';
 import { DrawFeedbackEdgeAction, RemoveFeedbackEdgeAction, feedbackEdgeId } from '../edge-creation/dangling-edge-feedback';
 import {
     DrawFeedbackEdgeSourceAction,
@@ -56,7 +57,7 @@ export class EdgeEditTool extends BaseEditTool {
     @inject(SelectionService) protected selectionService: SelectionService;
     @inject(AnchorComputerRegistry) protected anchorRegistry: AnchorComputerRegistry;
     @inject(EdgeRouterRegistry) @optional() readonly edgeRouterRegistry?: EdgeRouterRegistry;
-    @inject(ChangeBoundsManager) readonly changeBoundsManager: ChangeBoundsManager;
+    @inject(TYPES.IChangeBoundsManager) readonly changeBoundsManager: IChangeBoundsManager;
 
     protected feedbackEdgeSourceMovingListener: FeedbackEdgeSourceMovingMouseListener;
     protected feedbackEdgeTargetMovingListener: FeedbackEdgeTargetMovingMouseListener;

package/src/features/tools/node-creation/container-manager.ts

@@ -14,12 +14,12 @@
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
 
-import { GModelElement, Point, findChildrenAtPosition } from '@eclipse-glsp/sprotty';
+import { GModelElement, Point, TYPES, findChildrenAtPosition } from '@eclipse-glsp/sprotty';
 import { inject, injectable } from 'inversify';
 import { CSS_GHOST_ELEMENT, CursorCSS, cursorFeedbackAction } from '../../../base/feedback/css-feedback';
 import { FeedbackEmitter } from '../../../base/feedback/feedback-emitter';
 import { ContainerElement, isContainable } from '../../hints/model';
-import { ChangeBoundsManager } from '../change-bounds/change-bounds-manager';
+import { IChangeBoundsManager } from '../change-bounds/change-bounds-manager';
 
 export interface InsertOptions extends Record<string, unknown> {
     /** Flag to indicate whether the location within a container needs to be valid. Default: false */
@@ -58,7 +58,7 @@ export interface IContainerManager {
  */
 @injectable()
 export class ContainerManager implements IContainerManager {
-    @inject(ChangeBoundsManager) protected readonly changeBoundsManager: ChangeBoundsManager;
+    @inject(TYPES.IChangeBoundsManager) protected readonly changeBoundsManager: IChangeBoundsManager;
 
     insert(proxy: GModelElement, location: Point, elementTypeId: string, opts?: Partial<InsertOptions>): TrackedInsert {
         const options = { ...DEFAULT_INSERT_OPTIONS, ...opts };

package/src/features/tools/node-creation/node-creation-tool.ts

@@ -43,7 +43,7 @@ import { AddTemplateElementsAction, getTemplateElementId } from '../../element-t
 import { MouseTrackingElementPositionListener, PositioningTool } from '../../element-template/mouse-tracking-element-position-listener';
 import { RemoveTemplateElementsAction } from '../../element-template/remove-template-element';
 import { BaseCreationTool } from '../base-tools';
-import { ChangeBoundsManager } from '../change-bounds/change-bounds-manager';
+import { IChangeBoundsManager } from '../change-bounds/change-bounds-manager';
 import { TrackedMove } from '../change-bounds/change-bounds-tracker';
 import { IContainerManager, TrackedInsert } from './container-manager';
 import { InsertIndicator } from './insert-indicator';
@@ -54,7 +54,7 @@ export class NodeCreationTool extends BaseCreationTool<TriggerNodeCreationAction
 
     protected isTriggerAction = TriggerNodeCreationAction.is;
 
-    @inject(ChangeBoundsManager) readonly changeBoundsManager: ChangeBoundsManager;
+    @inject(TYPES.IChangeBoundsManager) readonly changeBoundsManager: IChangeBoundsManager;
     @inject(TYPES.IContainerManager) readonly containerManager: IContainerManager;
     @inject(TYPES.IModelFactory) modelFactory: IModelFactory;
 

package/src/views/ggraph-view.tsx

@@ -13,15 +13,15 @@
  *
  * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
  ********************************************************************************/
-import { Bounds, Dimension, Point, RenderingContext, SGraphImpl, SGraphView, Writable } from '@eclipse-glsp/sprotty';
+import { Bounds, Dimension, Point, RenderingContext, SGraphImpl, SGraphView, TYPES, Writable } from '@eclipse-glsp/sprotty';
 import { inject, injectable, optional } from 'inversify';
 import { VNode } from 'snabbdom';
-import { GridManager, GridStyle } from '../features/grid/grid-manager';
+import { GridStyle, IGridManager } from '../features/grid/grid-manager';
 import { GridProperty } from '../features/grid/grid-style';
 
 @injectable()
 export class GGraphView extends SGraphView {
-    @inject(GridManager) @optional() protected gridManager?: GridManager;
+    @inject(TYPES.IGridManager) @optional() protected gridManager?: IGridManager;
 
     override render(model: Readonly<SGraphImpl>, context: RenderingContext): VNode {
         const graph = super.render(model, context);
@@ -45,7 +45,7 @@ export class GGraphView extends SGraphView {
         };
     }
 
-    protected getBackgroundBounds(viewport: Readonly<SGraphImpl>, context: RenderingContext, gridManager: GridManager): Writable<Bounds> {
+    protected getBackgroundBounds(viewport: Readonly<SGraphImpl>, context: RenderingContext, gridManager: IGridManager): Writable<Bounds> {
         const position = Point.multiplyScalar(Point.subtract(gridManager.grid, viewport.scroll), viewport.zoom);
         const size = Dimension.fromPoint(Point.multiplyScalar(gridManager.grid, viewport.zoom));
         return { ...position, ...size };

package/src/views/glsp-projection-view.tsx

@@ -25,6 +25,7 @@ import {
     ProjectionParams,
     RenderingContext,
     SGraphImpl,
+    TYPES,
     ViewProjection,
     Writable,
     html,
@@ -33,7 +34,7 @@ import {
 } from '@eclipse-glsp/sprotty';
 import { inject, injectable, optional } from 'inversify';
 import { VNode, VNodeStyle, h } from 'snabbdom';
-import { GridManager, GridStyle } from '../features/grid/grid-manager';
+import { GridStyle, IGridManager } from '../features/grid/grid-manager';
 import { GridProperty } from '../features/grid/grid-style';
 
 /**
@@ -42,7 +43,7 @@ import { GridProperty } from '../features/grid/grid-style';
 @injectable()
 export class GLSPProjectionView extends ProjectedViewportView {
     @inject(EdgeRouterRegistry) edgeRouterRegistry: EdgeRouterRegistry;
-    @inject(GridManager) @optional() protected gridManager?: GridManager;
+    @inject(TYPES.IGridManager) @optional() protected gridManager?: IGridManager;
 
     override render(model: Readonly<GViewportRootElement>, context: RenderingContext, args?: IViewArgs): VNode {
         const rootNode: VNode = (
@@ -83,7 +84,7 @@ export class GLSPProjectionView extends ProjectedViewportView {
         };
     }
 
-    protected getBackgroundBounds(viewport: Readonly<SGraphImpl>, context: RenderingContext, gridManager: GridManager): Writable<Bounds> {
+    protected getBackgroundBounds(viewport: Readonly<SGraphImpl>, context: RenderingContext, gridManager: IGridManager): Writable<Bounds> {
         const position = Point.multiplyScalar(Point.subtract(gridManager.grid, viewport.scroll), viewport.zoom);
         const size = Dimension.fromPoint(Point.multiplyScalar(gridManager.grid, viewport.zoom));
         return { ...position, ...size };