@eclipse-scout/core 11.0.32 → 11.0.41

package/src/util/ViewportScroller.js

@@ -0,0 +1,156 @@
+/*
+ * Copyright (c) 2010-2021 BSI Business Systems Integration AG.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *     BSI Business Systems Integration AG - initial API and implementation
+ */
+
+export default class ViewportScroller {
+
+  static SPEED_FACTOR_SLOW = 1 / 20;
+  static SPEED_FACTOR_MEDIUM = 1 / 10;
+  static SPEED_FACTOR_FAST = 1 / 5;
+
+  constructor(model) {
+    this.viewportWidth = 0;
+    this.viewportHeight = 0;
+    /** distance from the viewport edge (in pixel) where we start to scroll automatically */
+    this.e = 30;
+    /** position of "fast scroll" area. Same dimension as e. Negative values are outside the viewport. */
+    this.f = -30;
+    /** milliseconds */
+    this.initialDelay = 500;
+
+    /**
+     * Function that returns "false", if the scrolling should no longer be active (e.g. because the
+     * elements were removed from the DOM) or "true" otherwise.
+     * @return {boolean}
+     */
+    this.active = () => true;
+    /**
+     * Function that receives the computed delta scroll positions (positive or negative) when automatic scrolling is active.
+     * @param {number} dx
+     * @param {number} dy
+     */
+    this.scroll = (dx, dy) => {
+    };
+
+    $.extend(this, model);
+
+    // --- Do not change the following properties manually ---
+
+    this.dx = 0;
+    this.dy = 0;
+    this.started = false;
+    this.moved = false;
+
+    this._timeoutId = null;
+  }
+
+  _tick() {
+    if (!this.active()) {
+      return;
+    }
+    if (this.started && (this.dx || this.dy)) {
+      this.scroll(this.dx, this.dy);
+      this.moved = true;
+    }
+    // Reschedule for continuous scrolling
+    let delay = (this.moved ? 16 : this.initialDelay); // 16ms = 60fps
+    this._timeoutId = setTimeout(() => this._tick(), delay);
+  }
+
+  /**
+   * Normally, it should not be necessary to call this method manually. Use update() instead.
+   */
+  start() {
+    clearTimeout(this._timeoutId);
+    this._tick();
+    this.started = true;
+  }
+
+  /**
+   * Normally, it should not be necessary to call this method manually. Use update() instead.
+   */
+  stop() {
+    clearTimeout(this._timeoutId);
+    this._timeoutId = null;
+    this.started = false;
+    this.moved = false;
+    this.dx = 0;
+    this.dy = 0;
+  }
+
+  /**
+   * This method is intended to be called with the current mouse position (viewport-relative coordinates in pixel)
+   * on every mouse move event. It automatically computes the required delta scroll positions in both directions.
+   *
+   * @param {Point} mouse
+   */
+  update(mouse) {
+    let e = this.e;
+    let f = this.f;
+    // f2 = Half-way between e and f
+    let f2 = Math.floor((e + f) / 2);
+
+    let scrollAreaLeft = e;
+    let scrollAreaRight = this.viewportWidth - e;
+    let scrollAreaTop = e;
+    let scrollAreaBottom = this.viewportHeight - e;
+
+    // Slow scrolling between e and f2, medium scrolling between f2 and f, fast scrolling after f
+    const SLOW = ViewportScroller.SPEED_FACTOR_SLOW;
+    const MEDIUM = ViewportScroller.SPEED_FACTOR_MEDIUM;
+    const FAST = ViewportScroller.SPEED_FACTOR_FAST;
+    let speedFactorX = 0;
+    let speedFactorY = 0;
+
+    // dx/dy = distance (positive or negative) in pixel
+    let dx = 0;
+    let dy = 0;
+    // noinspection DuplicatedCode
+    if (mouse.x < scrollAreaLeft) {
+      dx = -(scrollAreaLeft - mouse.x);
+      speedFactorX = (mouse.x > f2 ? SLOW : (mouse.x > f ? MEDIUM : FAST));
+    } else if (mouse.x > scrollAreaRight) {
+      dx = (mouse.x - scrollAreaRight);
+      speedFactorX = (mouse.x > this.viewportWidth - f ? FAST : (mouse.x > this.viewportWidth - f2 ? MEDIUM : SLOW));
+    }
+    // noinspection DuplicatedCode
+    if (mouse.y < scrollAreaTop) {
+      dy = -(scrollAreaTop - mouse.y);
+      speedFactorY = (mouse.y > f2 ? SLOW : (mouse.y > f ? MEDIUM : FAST));
+    } else if (mouse.y > scrollAreaBottom) {
+      dy = (mouse.y - scrollAreaBottom);
+      speedFactorY = (mouse.y > this.viewportHeight - f ? FAST : (mouse.y > this.viewportHeight - f2 ? MEDIUM : SLOW));
+    }
+    // ax/ay = absolute distance in pixel
+    let ax = Math.abs(dx);
+    let ay = Math.abs(dy);
+    let a = Math.max(ax, ay);
+
+    if (a === 0) {
+      // Mouse not in scroll area -> stop previously started loop
+      this.stop();
+      return;
+    }
+
+    // Compute distance to scroll
+    let speedX = 1 + Math.floor(ax * speedFactorX);
+    let speedY = 1 + Math.floor(ay * speedFactorY);
+    this.dx = Math.sign(dx) * speedX;
+    this.dy = Math.sign(dy) * speedY;
+
+    // --- Start loop ---
+    this.started || this.start();
+
+    if (!this.moved && a > e) {
+      // If mouse is outside the viewport, ensure scrolling starts immediately (by calling start() again)
+      this.start();
+    }
+  }
+}

package/src/util/arrays.js

@@ -242,8 +242,8 @@ export function pushAll(arr, arr2) {
  * If the arrays contain objects instead of primitives, it uses their id to check for equality.
  */
 export function union(array1, array2) {
-  let result = [],
-    map = {};
+  let result = [];
+  let map = {};
 
   array1 = ensure(array1);
   array2 = ensure(array2);
@@ -437,11 +437,8 @@ export function findIndexFromReverse(arr, startIndex, predicate) {
  * Pushes all elements to the given array that are not null or undefined.
  */
 export function pushIfDefined(arr, ...elements) {
-  elements = elements.filter(element => {
-    return element !== null && element !== undefined;
-  });
-  if (arr && elements.length) {
-    arr.push(...elements);
+  if (arr) {
+    pushAll(arr, elements.filter(element => element !== null && element !== undefined));
   }
 }
 

package/src/util/events.js

@@ -100,7 +100,7 @@ export function onScrollStartEndDuringTouch($elem, startHandler, endHandler) {
     }
 
     clearTimeout(scrollTimeout);
-    // Check some ms later if a scroll event has occured in the mean time.
+    // Check some ms later if a scroll event has occurred in the mean time.
     // If yes it (probably) is still scrolling. If no it (probably) is not scrolling anymore -> call handler
     checkLater();
   };

package/src/util/fonts.js

@@ -41,7 +41,7 @@ export function bootstrap(fonts) {
     fonts: fonts,
     onComplete: (success, badFonts) => {
       if (!success && badFonts && badFonts.length) {
-        $.log.warn('Timeout ocurred while pre-loading the following fonts:\n\n- ' + badFonts.join('\n- ') + '\n\n' +
+        $.log.warn('Timeout occurred while pre-loading the following fonts:\n\n- ' + badFonts.join('\n- ') + '\n\n' +
           'Rendering will now continue, but font measurements may be inaccurate. ' +
           'To prevent unnecessary startup delays and layout problems, check the @font-face ' +
           'definitions and the referenced "src" URLs or programmatically add additional font-specific ' +

package/src/util/strings.js

@@ -154,9 +154,10 @@ export function encode(text) {
  * Tries to preserve the new lines. Since it does not consider the style, it won't be right in any cases.
  * A div for example always generates a new line, even if display style is not set to block.
  *
- * Options:
- * - compact: Multiple consecutive empty lines are reduced to a single empty line
- * - trim: Calls string.trim(). White space at the beginning and the end of the text gets removed.
+ * @param {object} [options]
+ * @param {boolean} [options.compact] Multiple consecutive empty lines are reduced to a single empty line. Default is false.
+ * @param {boolean}[options.trim] Calls string.trim(). White space at the beginning and the end of the text gets removed.. Default is false.
+ * @param {boolean} [options.removeFontIcons] Removes font icons. Default is false.
  */
 export function plainText(text, options) {
   if (!plainTextEncoder) { // lazy instantiation to avoid cyclic dependency errors during webpack bootstrap
@@ -456,6 +457,7 @@ export function truncateText(text, horizontalSpace, measureText) {
   return text;
 }
 
+// noinspection JSDeprecatedSymbols
 export default {
   asString,
   box,
@@ -470,6 +472,7 @@ export default {
   hasText,
   insertAt,
   join,
+  length,
   /** @deprecated */
   lowercaseFirstLetter,
   nl2br,
@@ -483,8 +486,11 @@ export default {
   repeat,
   splitMax,
   startsWith,
+  toLowerCase,
   toLowerCaseFirstLetter,
+  toUpperCase,
   toUpperCaseFirstLetter,
+  trim,
   truncateText,
   /** @deprecated */
   uppercaseFirstLetter