/** * @license * Copyright 2017 Google LLC * SPDX-License-Identifier: Apache-2.0 */ /** * Layout code for a vertical variant of the flyout. * * @class */ // Former goog.module ID: Blockly.VerticalFlyout import * as browserEvents from './browser_events.js'; import * as dropDownDiv from './dropdowndiv.js'; import {Flyout} from './flyout_base.js'; import type {FlyoutItem} from './flyout_item.js'; import type {Options} from './options.js'; import * as registry from './registry.js'; import {Scrollbar} from './scrollbar.js'; import type {Coordinate} from './utils/coordinate.js'; import {Rect} from './utils/rect.js'; import * as toolbox from './utils/toolbox.js'; import * as WidgetDiv from './widgetdiv.js'; /** * Class for a flyout. */ export class VerticalFlyout extends Flyout { /** The name of the vertical flyout in the registry. */ static registryName = 'verticalFlyout'; /** @param workspaceOptions Dictionary of options for the workspace. */ constructor(workspaceOptions: Options) { super(workspaceOptions); } /** * Sets the translation of the flyout to match the scrollbars. * * @param xyRatio Contains a y property which is a float between 0 and 1 * specifying the degree of scrolling and a similar x property. */ protected override setMetrics_(xyRatio: {x: number; y: number}) { if (!this.isVisible()) { return; } const metricsManager = this.workspace_.getMetricsManager(); const scrollMetrics = metricsManager.getScrollMetrics(); const viewMetrics = metricsManager.getViewMetrics(); const absoluteMetrics = metricsManager.getAbsoluteMetrics(); if (typeof xyRatio.y === 'number') { this.workspace_.scrollY = -( scrollMetrics.top + (scrollMetrics.height - viewMetrics.height) * xyRatio.y ); } this.workspace_.translate( this.workspace_.scrollX + absoluteMetrics.left, this.workspace_.scrollY + absoluteMetrics.top, ); } /** * Calculates the x coordinate for the flyout position. * * @returns X coordinate. */ override getX(): number { if (!this.isVisible()) { return 0; } const metricsManager = this.targetWorkspace!.getMetricsManager(); const absoluteMetrics = metricsManager.getAbsoluteMetrics(); const viewMetrics = metricsManager.getViewMetrics(); const toolboxMetrics = metricsManager.getToolboxMetrics(); let x = 0; // If this flyout is not the trashcan flyout (e.g. toolbox or mutator). // Trashcan flyout is opposite the main flyout. if (this.targetWorkspace!.toolboxPosition === this.toolboxPosition_) { // If there is a category toolbox. // Simple (flyout-only) toolbox. if (this.targetWorkspace!.getToolbox()) { if (this.toolboxPosition_ === toolbox.Position.LEFT) { x = toolboxMetrics.width; } else { x = viewMetrics.width - this.getWidth(); } } else { if (this.toolboxPosition_ === toolbox.Position.LEFT) { x = 0; } else { // The simple flyout does not cover the workspace. x = viewMetrics.width; } } } else { if (this.toolboxPosition_ === toolbox.Position.LEFT) { x = 0; } else { // Because the anchor point of the flyout is on the left, but we want // to align the right edge of the flyout with the right edge of the // blocklyDiv, we calculate the full width of the div minus the width // of the flyout. x = viewMetrics.width + absoluteMetrics.left - this.getWidth(); } } return x; } /** * Calculates the y coordinate for the flyout position. * * @returns Y coordinate. */ override getY(): number { // Y is always 0 since this is a vertical flyout. return 0; } /** Move the flyout to the edge of the workspace. */ override position() { if (!this.isVisible() || !this.targetWorkspace!.isVisible()) { return; } const metricsManager = this.targetWorkspace!.getMetricsManager(); const targetWorkspaceViewMetrics = metricsManager.getViewMetrics(); this.height_ = targetWorkspaceViewMetrics.height; const edgeWidth = this.getWidth() - this.CORNER_RADIUS; const edgeHeight = targetWorkspaceViewMetrics.height - 2 * this.CORNER_RADIUS; this.setBackgroundPath(edgeWidth, edgeHeight); const x = this.getX(); const y = this.getY(); this.positionAt_(this.getWidth(), this.getHeight(), x, y); } /** * Create and set the path for the visible boundaries of the flyout. * * @param width The width of the flyout, not including the rounded corners. * @param height The height of the flyout, not including rounded corners. */ private setBackgroundPath(width: number, height: number) { const atRight = this.toolboxPosition_ === toolbox.Position.RIGHT; const totalWidth = width + this.CORNER_RADIUS; // Decide whether to start on the left or right. const path: Array = [ 'M ' + (atRight ? totalWidth : 0) + ',0', ]; // Top. path.push('h', atRight ? -width : width); // Rounded corner. path.push( 'a', this.CORNER_RADIUS, this.CORNER_RADIUS, 0, 0, atRight ? 0 : 1, atRight ? -this.CORNER_RADIUS : this.CORNER_RADIUS, this.CORNER_RADIUS, ); // Side closest to workspace. path.push('v', Math.max(0, height)); // Rounded corner. path.push( 'a', this.CORNER_RADIUS, this.CORNER_RADIUS, 0, 0, atRight ? 0 : 1, atRight ? this.CORNER_RADIUS : -this.CORNER_RADIUS, this.CORNER_RADIUS, ); // Bottom. path.push('h', atRight ? width : -width); path.push('z'); this.svgBackground_!.setAttribute('d', path.join(' ')); } /** Scroll the flyout to the top. */ override scrollToStart() { this.workspace_.scrollbar?.setY(0); } /** * Scroll the flyout. * * @param e Mouse wheel scroll event. */ protected override wheel_(e: WheelEvent) { const scrollDelta = browserEvents.getScrollDeltaPixels(e); if (scrollDelta.y) { const metricsManager = this.workspace_.getMetricsManager(); const scrollMetrics = metricsManager.getScrollMetrics(); const viewMetrics = metricsManager.getViewMetrics(); const pos = viewMetrics.top - scrollMetrics.top + scrollDelta.y; this.workspace_.scrollbar?.setY(pos); // When the flyout moves from a wheel event, hide WidgetDiv and // dropDownDiv. WidgetDiv.hideIfOwnerIsInWorkspace(this.workspace_); dropDownDiv.hideWithoutAnimation(); } // Don't scroll the page. e.preventDefault(); // Don't propagate mousewheel event (zooming). e.stopPropagation(); } /** * Lay out the blocks in the flyout. * * @param contents The flyout items to lay out. */ protected override layout_(contents: FlyoutItem[]) { this.workspace_.scale = this.targetWorkspace!.scale; const margin = this.MARGIN; const cursorX = this.RTL ? margin : margin + this.tabWidth_; let cursorY = margin; for (const item of contents) { item.getElement().moveBy(cursorX, cursorY); cursorY += item.getElement().getBoundingRectangle().getHeight(); } } /** * Determine if a drag delta is toward the workspace, based on the position * and orientation of the flyout. This is used in determineDragIntention_ to * determine if a new block should be created or if the flyout should scroll. * * @param currentDragDeltaXY How far the pointer has moved from the position * at mouse down, in pixel units. * @returns True if the drag is toward the workspace. */ override isDragTowardWorkspace(currentDragDeltaXY: Coordinate): boolean { const dx = currentDragDeltaXY.x; const dy = currentDragDeltaXY.y; // Direction goes from -180 to 180, with 0 toward the right and 90 on top. const dragDirection = (Math.atan2(dy, dx) / Math.PI) * 180; const range = this.dragAngleRange_; // Check for left or right dragging. if ( (dragDirection < range && dragDirection > -range) || dragDirection < -180 + range || dragDirection > 180 - range ) { return true; } return false; } /** * Returns the bounding rectangle of the drag target area in pixel units * relative to viewport. * * @returns The component's bounding box. Null if drag target area should be * ignored. */ override getClientRect(): Rect | null { if (!this.svgGroup_ || this.autoClose || !this.isVisible()) { // The bounding rectangle won't compute correctly if the flyout is closed // and auto-close flyouts aren't valid drag targets (or delete areas). return null; } const flyoutRect = this.svgGroup_.getBoundingClientRect(); // BIG_NUM is offscreen padding so that blocks dragged beyond the shown // flyout area are still deleted. Must be larger than the largest screen // size, but be smaller than half Number.MAX_SAFE_INTEGER (not available on // IE). const BIG_NUM = 1000000000; const left = flyoutRect.left; if (this.toolboxPosition_ === toolbox.Position.LEFT) { const width = flyoutRect.width; return new Rect(-BIG_NUM, BIG_NUM, -BIG_NUM, left + width); } else { // Right return new Rect(-BIG_NUM, BIG_NUM, left, BIG_NUM); } } /** * Compute width of flyout. * For RTL: Lay out the blocks and buttons to be right-aligned. */ protected override reflowInternal_() { this.workspace_.scale = this.getFlyoutScale(); let flyoutWidth = this.getContents().reduce((maxWidthSoFar, item) => { return Math.max( maxWidthSoFar, item.getElement().getBoundingRectangle().getWidth(), ); }, 0); flyoutWidth += this.MARGIN * 1.5 + this.tabWidth_; flyoutWidth *= this.workspace_.scale; flyoutWidth += Scrollbar.scrollbarThickness; if (this.getWidth() !== flyoutWidth) { if (this.RTL) { // With the flyoutWidth known, right-align the flyout contents. for (const item of this.getContents()) { const oldX = item.getElement().getBoundingRectangle().left; const newX = flyoutWidth / this.workspace_.scale - item.getElement().getBoundingRectangle().getWidth() - this.MARGIN - this.tabWidth_; item.getElement().moveBy(newX - oldX, 0); } } // TODO(#7689): Remove this. // Workspace with no scrollbars where this is permanently // open on the left. // If scrollbars exist they properly update the metrics. if ( !this.targetWorkspace.scrollbar && !this.autoClose && this.targetWorkspace.getFlyout() === this && this.toolboxPosition_ === toolbox.Position.LEFT ) { this.targetWorkspace.translate( this.targetWorkspace.scrollX + flyoutWidth, this.targetWorkspace.scrollY, ); } this.width_ = flyoutWidth; this.position(); this.targetWorkspace.resizeContents(); this.targetWorkspace.recordDragTargets(); } } } registry.register( registry.Type.FLYOUTS_VERTICAL_TOOLBOX, registry.DEFAULT, VerticalFlyout, );