Files
blockly/core/workspace_dragger.ts
Ben Henning 4074cee31b feat!: Make everything ISelectable focusable (#9004)
* feat!: Make bubbles, comments, and icons focusable

* feat!: Make ISelectable and ICopyable focusable.

* feat: Consolidate selection calls.

Now everything is based on focus with selection only being used as a
proxy.

* feat: Invert responsibility for setSelected().

Now setSelected() is only for quasi-external use.

* feat: Push up shadow check to getters.

Needed new common-level helper.

* chore: Lint fixes.

* feat!: Allow IFocusableNode to disable focus.

* chore: post-merge lint fixes

* fix: Fix tests + text bubble focusing.

This fixed then regressed a circular dependency causing the node and
advanced compilation steps to fail. This investigation is ongoing.

* fix: Clean up & fix imports.

This ensures the node and advanced compilation test steps now pass.

* fix: Lint fixes + revert commented out logic.

* chore: Remove unnecessary cast.

Addresses reviewer comment.

* fix: Some issues and a bunch of clean-ups.

This addresses a bunch of review comments, and fixes selecting workspace
comments.

* chore: Lint fix.

* fix: Remove unnecessary shadow consideration.

* chore: Revert import.

* chore: Some doc updates & added a warn statement.
2025-05-09 08:16:14 -07:00

93 lines
2.6 KiB
TypeScript

/**
* @license
* Copyright 2017 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
/**
* Methods for dragging a workspace visually.
*
* @class
*/
// Former goog.module ID: Blockly.WorkspaceDragger
import {Coordinate} from './utils/coordinate.js';
import type {WorkspaceSvg} from './workspace_svg.js';
/**
* Class for a workspace dragger. It moves the workspace around when it is
* being dragged by a mouse or touch.
*
*/
export class WorkspaceDragger {
private readonly horizontalScrollEnabled: boolean;
private readonly verticalScrollEnabled: boolean;
protected startScrollXY_: Coordinate;
/** @param workspace The workspace to drag. */
constructor(private workspace: WorkspaceSvg) {
/** Whether horizontal scroll is enabled. */
this.horizontalScrollEnabled = this.workspace.isMovableHorizontally();
/** Whether vertical scroll is enabled. */
this.verticalScrollEnabled = this.workspace.isMovableVertically();
/**
* The scroll position of the workspace at the beginning of the drag.
* Coordinate system: pixel coordinates.
*/
this.startScrollXY_ = new Coordinate(workspace.scrollX, workspace.scrollY);
}
/**
* Sever all links from this object.
*
* @internal
*/
dispose() {
// AnyDuringMigration because: Type 'null' is not assignable to type
// 'WorkspaceSvg'.
this.workspace = null as AnyDuringMigration;
}
/**
* Start dragging the workspace.
*
* @internal
*/
startDrag() {}
/**
* Finish dragging the workspace and put everything back where it belongs.
*
* @param currentDragDeltaXY How far the pointer has moved from the position
* at the start of the drag, in pixel coordinates.
* @internal
*/
endDrag(currentDragDeltaXY: Coordinate) {
// Make sure everything is up to date.
this.drag(currentDragDeltaXY);
}
/**
* Move the workspace based on the most recent mouse movements.
*
* @param currentDragDeltaXY How far the pointer has moved from the position
* at the start of the drag, in pixel coordinates.
* @internal
*/
drag(currentDragDeltaXY: Coordinate) {
const newXY = Coordinate.sum(this.startScrollXY_, currentDragDeltaXY);
if (this.horizontalScrollEnabled && this.verticalScrollEnabled) {
this.workspace.scroll(newXY.x, newXY.y);
} else if (this.horizontalScrollEnabled) {
this.workspace.scroll(newXY.x, this.workspace.scrollY);
} else if (this.verticalScrollEnabled) {
this.workspace.scroll(this.workspace.scrollX, newXY.y);
} else {
throw new TypeError('Invalid state.');
}
}
}