@eclipse-scout/core 22.0.12 → 22.0.22

package/src/testing/JasmineScoutUtil.js

@@ -0,0 +1,127 @@
+/*
+ * Copyright (c) 2010-2022 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
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *     BSI Business Systems Integration AG - initial API and implementation
+ */
+import {arrays, scout, strings} from '../index';
+import $ from 'jquery';
+
+let _jsonResourceCache = {};
+
+/**
+ * Utility functions for jasmine tests.
+ */
+export const JasmineScoutUtil = {
+
+  /**
+   * @param {string} jsonResourceUrl
+   * @param {object} [options]
+   * @param {boolean} [options.useCache=true]
+   * @return {Promise<object>} - the loaded JSON data structure
+   */
+  loadJsonResource(jsonResourceUrl, options = {}) {
+    scout.assertParameter('jsonResourceUrl', jsonResourceUrl);
+
+    if (scout.nvl(options.useCache, true)) {
+      let json = _jsonResourceCache[jsonResourceUrl];
+      if (json) {
+        return $.resolvedPromise(json);
+      }
+    }
+
+    return $.ajax({
+      async: false,
+      type: 'GET',
+      dataType: 'json',
+      contentType: 'application/json; charset=UTF-8',
+      cache: false,
+      url: jsonResourceUrl
+    })
+      .done(json => {
+        if (scout.nvl(options.useCache, true)) {
+          _jsonResourceCache[jsonResourceUrl] = json;
+        }
+        return $.resolvedPromise(json);
+      })
+      .fail((jqXHR, textStatus, errorThrown) => {
+        throw new Error('Could not load resource from url: ' + jsonResourceUrl);
+      });
+  },
+
+  /**
+   * @param {string} resourceUrlToMock
+   * @param {string} jsonResourceUrl
+   * @param {object} [options]
+   * @param {boolean} [options.useCache=true]
+   * @param {*} [options.restriction]
+   * @param {string} [options.method]
+   */
+  loadJsonResourceAndMockRestCall(resourceUrlToMock, jsonResourceUrl, options = {}) {
+    scout.assertParameter('resourceUrlToMock', resourceUrlToMock);
+
+    this.loadJsonResource(jsonResourceUrl, options)
+      .then(json => this.mockRestCall(resourceUrlToMock, json, options));
+  },
+
+  /**
+   * @param {string} resourceUrlToMock
+   * @param {array} lookupRows
+   * @param {*} [parentRestriction]
+   */
+  mockRestLookupCall(resourceUrlToMock, lookupRows, parentRestriction) {
+    scout.assertParameter('resourceUrlToMock', resourceUrlToMock);
+
+    // Normalize lookup rows
+    lookupRows = arrays.ensure(lookupRows).map(lookupRow => $.extend({
+      active: true,
+      enabled: true,
+      parentId: null
+    }, lookupRow));
+
+    // getAll()
+    this.mockRestCall(resourceUrlToMock, {
+      rows: lookupRows
+    }, {
+      restriction: parentRestriction
+    });
+
+    // getKey()
+    lookupRows.forEach(lookupRow => {
+      this.mockRestCall(resourceUrlToMock, {
+        rows: [lookupRow]
+      }, {
+        restriction: lookupRow.id
+      });
+    });
+  },
+
+  /**
+   * @param {string} resourceUrlToMock
+   * @param {*} responseData
+   * @param {object} [options]
+   * @param {*} [options.restriction]
+   * @param {string} [options.method]
+   */
+  mockRestCall(resourceUrlToMock, responseData, options = {}) {
+    let url = new RegExp('.*' + strings.quote(resourceUrlToMock) + '.*');
+    let data = options.restriction ? new RegExp('.*' + strings.quote(options.restriction) + '.*') : undefined;
+    jasmine.Ajax.stubRequest(url, data, options.method).andReturn({
+      status: 200,
+      responseText: JSON.stringify(responseData)
+    });
+  },
+
+  /**
+   * If a ajax call is not mocked, this fallback will be triggered to show information about which url is not mocked.
+   */
+  captureNotMockedCalls() {
+    jasmine.Ajax.stubRequest(/.*/).andCallFunction((stub, mockAjax) => {
+      fail('Ajax call not mocked for url: ' + mockAjax.url + ', method: ' + mockAjax.method);
+    });
+  }
+};

package/src/testing/index.js

@@ -8,8 +8,14 @@
  * Contributors:
  *     BSI Business Systems Integration AG - initial API and implementation
  */
+
+// /////////////////////////////////////////////////////////////////
+// TEST SUPPORT - DO NOT USE IN PRODUCTION CODE
+// /////////////////////////////////////////////////////////////////
+
 export {default as TestingApp} from './TestingApp';
 export {default as JasmineScout} from './JasmineScout';
+export {JasmineScoutUtil} from './JasmineScoutUtil';
 export {default as LocaleSpecHelper} from './text/LocaleSpecHelper';
 export {default as MenuSpecHelper} from './menu/MenuSpecHelper';
 export {default as TreeSpecHelper} from './tree/TreeSpecHelper';
@@ -31,6 +37,4 @@ export {default as GroupBoxSpecHelper} from './form/fields/groupbox/GroupBoxSpec
 import * as self from './index.js';
 
 export default self;
-if (window) {
-  window.scout = Object.assign(window.scout || {}, self);
-}
+window.scout = Object.assign(window.scout || {}, self);

package/src/tile/TileGrid.js

@@ -1,9 +1,9 @@
 /*
- * Copyright (c) 2010-2021 BSI Business Systems Integration AG.
+ * Copyright (c) 2010-2022 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
+ * https://www.eclipse.org/legal/epl-v10.html
  *
  * Contributors:
  *     BSI Business Systems Integration AG - initial API and implementation
@@ -42,8 +42,6 @@ export default class TileGrid extends Widget {
     this.selectedTiles = [];
     this.selectionHandler = new TileGridSelectionHandler(this);
     this.scrollable = true;
-    this.scrolling = false;
-    this.scrollTopDirty = false;
     this.startupAnimationDone = false;
     this.startupAnimationEnabled = false;
     this.tiles = [];
@@ -594,18 +592,14 @@ export default class TileGrid extends Widget {
     let scrollTop = this.$container[0].scrollTop;
     let scrollLeft = this.$container[0].scrollLeft;
     if (this.scrollTop !== scrollTop && this.virtual) {
-      this.scrolling = true;
-      this.revalidateLayout();
-      this.scrolling = false;
+      this.htmlComp.layout.updateViewPort();
     }
     this.scrollTop = scrollTop;
     this.scrollLeft = scrollLeft;
   }
 
   _onScrollParentScroll(event) {
-    this.scrolling = true;
-    this.revalidateLayoutTree(false);
-    this.scrolling = false;
+    this.htmlComp.layout.updateViewPort();
   }
 
   setWithPlaceholders(withPlaceholders) {
@@ -961,12 +955,8 @@ export default class TileGrid extends Widget {
     this.ensureTileRendered(tile);
     // If tile was not rendered it is not yet positioned correctly -> make sure layout is valid before trying to scroll
     // Layout must not render the viewport because scroll position is not correct yet -> just make sure tiles are at the correct position
-    this.scrolling = true;
-    this.scrollTopDirty = true;
-    this.validateLayoutTree();
-    this.scrolling = false;
+    this.htmlComp.layout.updateViewPort(true);
     tile.reveal(options);
-    this.scrollTopDirty = false;
   }
 
   revealSelection() {

package/src/tile/TileGridLayout.js

@@ -3,7 +3,7 @@
  * 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
+ * https://www.eclipse.org/legal/epl-v10.html
  *
  * Contributors:
  *     BSI Business Systems Integration AG - initial API and implementation
@@ -44,19 +44,29 @@ export default class TileGridLayout extends LogicalGridLayout {
     this.maxWidth = -1;
   }
 
-  layout($container) {
-    let htmlComp = this.widget.htmlComp;
-    if (this.widget.scrolling) {
-      // Try to layout only as much as needed while scrolling in virtual mode
-      // Scroll top may be dirty when layout is validated before scrolling to a specific tile (see tileGrid.scrollTo)
-      if (!this.widget.scrollTopDirty) {
-        this.widget._renderViewPort();
-      }
-      this._layout($container);
-      this.widget.trigger('layoutAnimationDone');
+  /**
+   *
+   * @param {boolean} [scrollTopDirty] If the scroll top position should be considered dirty while updating the view port.
+   * If true, the view port is not rendered, as the scroll positions are not reliable anyway. Then only the layout of the TileGrid is updated.
+   */
+  updateViewPort(scrollTopDirty) {
+    let tileGrid = this.widget;
+    if (!tileGrid.rendered) {
       return;
     }
 
+    // Try to layout only as much as needed while scrolling in virtual mode
+    // Scroll top may be dirty when layout is validated before scrolling to a specific tile (see tileGrid.scrollTo)
+    if (!scout.nvl(scrollTopDirty, false)) {
+      tileGrid._renderViewPort();
+    }
+    this._layout(tileGrid.$container);
+    tileGrid.trigger('layoutAnimationDone');
+  }
+
+  layout($container) {
+    let htmlComp = this.widget.htmlComp;
+
     // Animate only once on startup (if enabled) but animate every time on resize
     let animated = htmlComp.layouted || (this.widget.startupAnimationEnabled && !this.widget.startupAnimationDone) || this.widget.renderAnimationEnabled;
     this.tiles = this.widget.renderedTiles();

package/src/tile/accordion/TileAccordion.js

@@ -3,7 +3,7 @@
  * 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
+ * https://www.eclipse.org/legal/epl-v10.html
  *
  * Contributors:
  *     BSI Business Systems Integration AG - initial API and implementation
@@ -350,24 +350,7 @@ export default class TileAccordion extends Accordion {
   }
 
   _filter() {
-    this.groups.forEach(group => {
-      group.body.filter();
-
-      // If the layout has not been invalidated as part of the filtering above, it even though must be validated here.
-      // This is because groups above might have fewer visible Tiles now which makes room for this group.
-      // The revalidateLayout() with scrolling=true here ensures TileGrid._renderViewPort() is called to ensure these Tiles become visible as there is space available now.
-      // It is executed as postValidateFunction because the groups above must have completed their layouting so that
-      // TileGrid._renderViewPort() knows that there is more space available now.
-      if (group.body.htmlComp && group.body.htmlComp.valid && !group.body._accordionLayoutHandler /* skip if already registered */) {
-        group.body._accordionLayoutHandler = () => {
-          group.body.scrolling = true;
-          group.body.revalidateLayout();
-          group.body.scrolling = false;
-          group.body._accordionLayoutHandler = null;
-        };
-        this.session.layoutValidator.schedulePostValidateFunction(group.body._accordionLayoutHandler);
-      }
-    });
+    this.groups.forEach(group => group.body.filter());
   }
 
   /**
@@ -700,10 +683,8 @@ export default class TileAccordion extends Accordion {
         // Btw: another group may be doing it as well at the same time (e.g. because of exclusiveExpand)
         return;
       }
-      if (group.body.virtual) {
-        group.body.scrolling = true;
-        group.body.revalidateLayout();
-        group.body.scrolling = false;
+      if (group.body.virtual && group.body.htmlComp) {
+        group.body.htmlComp.layout.updateViewPort();
       }
     });
   }

package/src/tile/accordion/TileAccordionLayout.js

@@ -1,9 +1,9 @@
 /*
- * Copyright (c) 2010-2021 BSI Business Systems Integration AG.
+ * Copyright (c) 2010-2022 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
+ * https://www.eclipse.org/legal/epl-v10.html
  *
  * Contributors:
  *     BSI Business Systems Integration AG - initial API and implementation
@@ -19,8 +19,45 @@ export default class TileAccordionLayout extends AccordionLayout {
   }
 
   layout($container) {
+    let previousGroupHeights = this.tileAccordion.groups
+      .map(group => group.body)
+      .map(tileGrid => this._getTileGridHeight(tileGrid));
+
     super.layout($container);
     this._updateFilterFieldMaxWidth($container);
+
+    this.tileAccordion.groups
+      .map(group => group.body)
+      .forEach((tileGrid, index) => this._updateTileGridViewPort(tileGrid, previousGroupHeights[index]));
+  }
+
+  _updateTileGridViewPort(tileGrid, previousHeight) {
+    if (!tileGrid.rendered || !tileGrid.htmlComp || previousHeight <= 0) {
+      return;
+    }
+
+    let newHeight = this._getTileGridHeight(tileGrid);
+    if (previousHeight === newHeight && tileGrid.virtual) {
+      // The viewPort of the virtual tileGrid has not been updated as no layout update was done for the grid because its height is unchanged.
+      // But as there might be more space available in the accordion now (its height might have changed), enforce a viewPort update to ensure all necessary tiles are rendered.
+      tileGrid.setViewRangeSize(tileGrid.calculateViewRangeSize(), false);
+      tileGrid.htmlComp.layout.updateViewPort();
+    }
+  }
+
+  _getTileGridHeight(tileGrid) {
+    if (!tileGrid) {
+      return 0;
+    }
+    let htmlComp = tileGrid.htmlComp;
+    if (!htmlComp) {
+      return 0;
+    }
+    let size = tileGrid.htmlComp.sizeCached;
+    if (!size) {
+      return 0;
+    }
+    return size.height;
   }
 
   _updateFilterFieldMaxWidth($container) {

package/src/util/arrays.js

@@ -12,6 +12,10 @@ import {objects, strings} from '../index';
 
 /**
  * Ensures the given parameter is an array
+ *
+ * @template T
+ * @param {T[]|T|null} array
+ * @return T[]
  */
 export function ensure(array) {
   if (array === undefined || array === null) {

package/src/util/objects.js

@@ -127,6 +127,9 @@ export function someProperties(obj, properties) {
   });
 }
 
+/**
+ * @return {*}
+ */
 export function valueCopy(obj) {
   // Nothing to be done for immutable things
   if (obj === undefined || obj === null || typeof obj !== 'object') {
@@ -220,7 +223,7 @@ export function findChildObjectByKey(parentObj, property, propertyValue) {
  * @return Object Returns the selected object.
  * @throws Throws an error, if the provided parameters are malformed, or a property could not be found/a id property filter does not find any elements.
  */
-function getByPath(object, path) {
+export function getByPath(object, path) {
   scout.assertParameter('object', object, Object);
   scout.assertParameter('path', path);
 

package/src/widget/FilterSupport.js

@@ -3,7 +3,7 @@
  * 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
+ * https://www.eclipse.org/legal/epl-v10.html
  *
  * Contributors:
  *     BSI Business Systems Integration AG - initial API and implementation
@@ -125,13 +125,11 @@ export default class FilterSupport extends WidgetSupport {
 
     this._filterField.$field.attr('tabIndex', -1);
 
-    let color = styles.getFirstOpaqueBackgroundColor(this._filterField.$container),
-      colorRgba = $.extend(true, {red: 0, green: 0, blue: 0, alpha: 1}, styles.rgb(color)),
-      transparent50Color = 'rgba(' + colorRgba.red + ', ' + colorRgba.green + ', ' + colorRgba.blue + ', ' + 0.5 + ')',
-      transparent80Color = 'rgba(' + colorRgba.red + ', ' + colorRgba.green + ', ' + colorRgba.blue + ', ' + 0.8 + ')';
-    this._filterField.$container.css('--filter-field-background-color', color);
-    this._filterField.$container.css('--filter-field-transparent-50-background-color', transparent50Color);
-    this._filterField.$container.css('--filter-field-transparent-80-background-color', transparent80Color);
+    if (!this.widget.rendered) {
+      this.widget.session.layoutValidator.schedulePostValidateFunction(this._updateFilterFieldBackgroundColor.bind(this));
+    } else {
+      this._updateFilterFieldBackgroundColor();
+    }
 
     this._textFilter = this._createTextFilter();
     this._textFilter.synthetic = true;
@@ -164,6 +162,19 @@ export default class FilterSupport extends WidgetSupport {
     this._filterField.keyStrokeContext.registerKeyStroke(this._exitFilterFieldKeyStroke);
   }
 
+  _updateFilterFieldBackgroundColor() {
+    if (!this._filterField || !this._filterField.rendered) {
+      return;
+    }
+    let color = styles.getFirstOpaqueBackgroundColor(this._filterField.$container),
+      colorRgba = $.extend(true, {red: 0, green: 0, blue: 0, alpha: 1}, styles.rgb(color)),
+      transparent50Color = 'rgba(' + colorRgba.red + ', ' + colorRgba.green + ', ' + colorRgba.blue + ', ' + 0.5 + ')',
+      transparent80Color = 'rgba(' + colorRgba.red + ', ' + colorRgba.green + ', ' + colorRgba.blue + ', ' + 0.8 + ')';
+    this._filterField.$container.css('--filter-field-background-color', color);
+    this._filterField.$container.css('--filter-field-transparent-50-background-color', transparent50Color);
+    this._filterField.$container.css('--filter-field-transparent-80-background-color', transparent80Color);
+  }
+
   _onFilterFieldDisplayTextChanged(event) {
     if (this._filterField && this._filterField.rendered) {
       this._filterField.$container.toggleClass('empty', !event.newValue);