/** * @license * Copyright 2017 Google LLC * SPDX-License-Identifier: Apache-2.0 */ /** * @fileoverview Horizontal flyout tray containing blocks which may be created. */ 'use strict'; /** * Horizontal flyout tray containing blocks which may be created. * @class */ goog.module('Blockly.HorizontalFlyout'); const WidgetDiv = goog.require('Blockly.WidgetDiv'); const browserEvents = goog.require('Blockly.browserEvents'); const object = goog.require('Blockly.utils.object'); const registry = goog.require('Blockly.registry'); const toolbox = goog.require('Blockly.utils.toolbox'); /* eslint-disable-next-line no-unused-vars */ const {Coordinate} = goog.requireType('Blockly.utils.Coordinate'); const {DropDownDiv} = goog.require('Blockly.DropDownDiv'); const {Flyout} = goog.require('Blockly.Flyout'); /* eslint-disable-next-line no-unused-vars */ const {Options} = goog.requireType('Blockly.Options'); const {Rect} = goog.require('Blockly.utils.Rect'); const {Scrollbar} = goog.require('Blockly.Scrollbar'); /** * Class for a flyout. * @param {!Options} workspaceOptions Dictionary of options for the * workspace. * @extends {Flyout} * @constructor * @alias Blockly.HorizontalFlyout */ const HorizontalFlyout = function(workspaceOptions) { HorizontalFlyout.superClass_.constructor.call(this, workspaceOptions); this.horizontalLayout = true; }; object.inherits(HorizontalFlyout, Flyout); /** * Sets the translation of the flyout to match the scrollbars. * @param {!{x:number,y:number}} xyRatio Contains a y property which is a float * between 0 and 1 specifying the degree of scrolling and a * similar x property. * @protected */ HorizontalFlyout.prototype.setMetrics_ = function(xyRatio) { if (!this.isVisible()) { return; } const metricsManager = this.workspace_.getMetricsManager(); const scrollMetrics = metricsManager.getScrollMetrics(); const viewMetrics = metricsManager.getViewMetrics(); const absoluteMetrics = metricsManager.getAbsoluteMetrics(); if (typeof xyRatio.x === 'number') { this.workspace_.scrollX = -(scrollMetrics.left + (scrollMetrics.width - viewMetrics.width) * xyRatio.x); } this.workspace_.translate( this.workspace_.scrollX + absoluteMetrics.left, this.workspace_.scrollY + absoluteMetrics.top); }; /** * Calculates the x coordinate for the flyout position. * @return {number} X coordinate. */ HorizontalFlyout.prototype.getX = function() { // X is always 0 since this is a horizontal flyout. return 0; }; /** * Calculates the y coordinate for the flyout position. * @return {number} Y coordinate. */ HorizontalFlyout.prototype.getY = function() { if (!this.isVisible()) { return 0; } const metricsManager = this.targetWorkspace.getMetricsManager(); const absoluteMetrics = metricsManager.getAbsoluteMetrics(); const viewMetrics = metricsManager.getViewMetrics(); const toolboxMetrics = metricsManager.getToolboxMetrics(); let y = 0; const atTop = this.toolboxPosition_ === toolbox.Position.TOP; // If this flyout is not the trashcan flyout (e.g. toolbox or mutator). if (this.targetWorkspace.toolboxPosition === this.toolboxPosition_) { // If there is a category toolbox. if (this.targetWorkspace.getToolbox()) { if (atTop) { y = toolboxMetrics.height; } else { y = viewMetrics.height - this.height_; } // Simple (flyout-only) toolbox. } else { if (atTop) { y = 0; } else { // The simple flyout does not cover the workspace. y = viewMetrics.height; } } // Trashcan flyout is opposite the main flyout. } else { if (atTop) { y = 0; } else { // Because the anchor point of the flyout is on the top, but we want // to align the bottom edge of the flyout with the bottom edge of the // blocklyDiv, we calculate the full height of the div minus the height // of the flyout. y = viewMetrics.height + absoluteMetrics.top - this.height_; } } return y; }; /** * Move the flyout to the edge of the workspace. */ HorizontalFlyout.prototype.position = function() { if (!this.isVisible() || !this.targetWorkspace.isVisible()) { return; } const metricsManager = this.targetWorkspace.getMetricsManager(); const targetWorkspaceViewMetrics = metricsManager.getViewMetrics(); // Record the width for workspace metrics. this.width_ = targetWorkspaceViewMetrics.width; const edgeWidth = targetWorkspaceViewMetrics.width - 2 * this.CORNER_RADIUS; const edgeHeight = this.height_ - this.CORNER_RADIUS; this.setBackgroundPath_(edgeWidth, edgeHeight); const x = this.getX(); const y = this.getY(); this.positionAt_(this.width_, this.height_, x, y); }; /** * Create and set the path for the visible boundaries of the flyout. * @param {number} width The width of the flyout, not including the * rounded corners. * @param {number} height The height of the flyout, not including * rounded corners. * @private */ HorizontalFlyout.prototype.setBackgroundPath_ = function(width, height) { const atTop = this.toolboxPosition_ === toolbox.Position.TOP; // Start at top left. const path = ['M 0,' + (atTop ? 0 : this.CORNER_RADIUS)]; if (atTop) { // Top. path.push('h', width + 2 * this.CORNER_RADIUS); // Right. path.push('v', height); // Bottom. path.push( 'a', this.CORNER_RADIUS, this.CORNER_RADIUS, 0, 0, 1, -this.CORNER_RADIUS, this.CORNER_RADIUS); path.push('h', -width); // Left. path.push( 'a', this.CORNER_RADIUS, this.CORNER_RADIUS, 0, 0, 1, -this.CORNER_RADIUS, -this.CORNER_RADIUS); path.push('z'); } else { // Top. path.push( 'a', this.CORNER_RADIUS, this.CORNER_RADIUS, 0, 0, 1, this.CORNER_RADIUS, -this.CORNER_RADIUS); path.push('h', width); // Right. path.push( 'a', this.CORNER_RADIUS, this.CORNER_RADIUS, 0, 0, 1, this.CORNER_RADIUS, this.CORNER_RADIUS); path.push('v', height); // Bottom. path.push('h', -width - 2 * this.CORNER_RADIUS); // Left. path.push('z'); } this.svgBackground_.setAttribute('d', path.join(' ')); }; /** * Scroll the flyout to the top. */ HorizontalFlyout.prototype.scrollToStart = function() { this.workspace_.scrollbar.setX(this.RTL ? Infinity : 0); }; /** * Scroll the flyout. * @param {!Event} e Mouse wheel scroll event. * @protected */ HorizontalFlyout.prototype.wheel_ = function(e) { const scrollDelta = browserEvents.getScrollDeltaPixels(e); const delta = scrollDelta.x || scrollDelta.y; if (delta) { const metricsManager = this.workspace_.getMetricsManager(); const scrollMetrics = metricsManager.getScrollMetrics(); const viewMetrics = metricsManager.getViewMetrics(); const pos = (viewMetrics.left - scrollMetrics.left) + delta; this.workspace_.scrollbar.setX(pos); // When the flyout moves from a wheel event, hide WidgetDiv and DropDownDiv. WidgetDiv.hide(); 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 {!Array} contents The blocks and buttons to lay out. * @param {!Array} gaps The visible gaps between blocks. * @protected */ HorizontalFlyout.prototype.layout_ = function(contents, gaps) { this.workspace_.scale = this.targetWorkspace.scale; const margin = this.MARGIN; let cursorX = margin + this.tabWidth_; const cursorY = margin; if (this.RTL) { contents = contents.reverse(); } for (let i = 0, item; (item = contents[i]); i++) { if (item.type === 'block') { const block = item.block; const allBlocks = block.getDescendants(false); for (let j = 0, child; (child = allBlocks[j]); j++) { // Mark blocks as being inside a flyout. This is used to detect and // prevent the closure of the flyout if the user right-clicks on such a // block. child.isInFlyout = true; } block.render(); const root = block.getSvgRoot(); const blockHW = block.getHeightWidth(); // Figure out where to place the block. const tab = block.outputConnection ? this.tabWidth_ : 0; let moveX; if (this.RTL) { moveX = cursorX + blockHW.width; } else { moveX = cursorX - tab; } block.moveBy(moveX, cursorY); const rect = this.createRect_(block, moveX, cursorY, blockHW, i); cursorX += (blockHW.width + gaps[i]); this.addBlockListeners_(root, block, rect); } else if (item.type === 'button') { this.initFlyoutButton_(item.button, cursorX, cursorY); cursorX += (item.button.width + gaps[i]); } } }; /** * 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 {!Coordinate} currentDragDeltaXY How far the pointer has * moved from the position at mouse down, in pixel units. * @return {boolean} True if the drag is toward the workspace. * @package */ HorizontalFlyout.prototype.isDragTowardWorkspace = function( currentDragDeltaXY) { 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 up or down dragging. if ((dragDirection < 90 + range && dragDirection > 90 - range) || (dragDirection > -90 - range && dragDirection < -90 + range)) { return true; } return false; }; /** * Returns the bounding rectangle of the drag target area in pixel units * relative to viewport. * @return {?Rect} The component's bounding box. Null if drag * target area should be ignored. */ HorizontalFlyout.prototype.getClientRect = function() { 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 top = flyoutRect.top; if (this.toolboxPosition_ === toolbox.Position.TOP) { const height = flyoutRect.height; return new Rect(-BIG_NUM, top + height, -BIG_NUM, BIG_NUM); } else { // Bottom. return new Rect(top, BIG_NUM, -BIG_NUM, BIG_NUM); } }; /** * Compute height of flyout. toolbox.Position mat under each block. * For RTL: Lay out the blocks right-aligned. * @protected */ HorizontalFlyout.prototype.reflowInternal_ = function() { this.workspace_.scale = this.getFlyoutScale(); let flyoutHeight = 0; const blocks = this.workspace_.getTopBlocks(false); for (let i = 0, block; (block = blocks[i]); i++) { flyoutHeight = Math.max(flyoutHeight, block.getHeightWidth().height); } const buttons = this.buttons_; for (let i = 0, button; (button = buttons[i]); i++) { flyoutHeight = Math.max(flyoutHeight, button.height); } flyoutHeight += this.MARGIN * 1.5; flyoutHeight *= this.workspace_.scale; flyoutHeight += Scrollbar.scrollbarThickness; if (this.height_ !== flyoutHeight) { for (let i = 0, block; (block = blocks[i]); i++) { if (block.flyoutRect_) { this.moveRectToBlock_(block.flyoutRect_, block); } } if (this.targetWorkspace.toolboxPosition === this.toolboxPosition_ && this.toolboxPosition_ === toolbox.Position.TOP && !this.targetWorkspace.getToolbox()) { // This flyout is a simple toolbox. Reposition the workspace so that (0,0) // is in the correct position relative to the new absolute edge (ie // toolbox edge). this.targetWorkspace.translate( this.targetWorkspace.scrollX, this.targetWorkspace.scrollY + flyoutHeight); } // Record the height for workspace metrics and .position. this.height_ = flyoutHeight; this.position(); this.targetWorkspace.recordDragTargets(); } }; registry.register( registry.Type.FLYOUTS_HORIZONTAL_TOOLBOX, registry.DEFAULT, HorizontalFlyout); exports.HorizontalFlyout = HorizontalFlyout;