@qooxdoo/framework 7.7.2 → 7.9.0

package/source/class/qx/bom/Label.js

@@ -39,6 +39,9 @@ qx.Bootstrap.define("qx.bom.Label", {
       letterSpacing: 1
     },
 
+    /** @type{Object<String,Object>} cache of label sizes */
+    __sizeCache: {},
+
     /**
      * Generates the helper DOM element for text measuring
      *
@@ -286,6 +289,12 @@ qx.Bootstrap.define("qx.bom.Label", {
      * @return {Map} A map with preferred <code>width</code> and <code>height</code>.
      */
     getHtmlSize(content, styles, width) {
+      let cacheKey = this.__getCacheKey(styles, width);
+      let size = this.__getCachedSize(cacheKey, content);
+      if (size !== undefined) {
+        return size;
+      }
+
       var element = this._htmlElement || this.__prepareHtml();
 
       // apply width
@@ -293,7 +302,9 @@ qx.Bootstrap.define("qx.bom.Label", {
       // insert content
       element.innerHTML = content;
 
-      return this.__measureSize(element, styles);
+      size = this.__measureSize(element, styles);
+      this.__storeCacheSize(cacheKey, content, size);
+      return size;
     },
 
     /**
@@ -304,6 +315,12 @@ qx.Bootstrap.define("qx.bom.Label", {
      * @return {Map} A map with preferred <code>width</code> and <code>height</code>.
      */
     getTextSize(text, styles) {
+      let cacheKey = this.__getCacheKey(styles);
+      let size = this.__getCachedSize(cacheKey, text);
+      if (size !== undefined) {
+        return size;
+      }
+
       var element = this._textElement || this.__prepareText();
 
       if (
@@ -315,7 +332,70 @@ qx.Bootstrap.define("qx.bom.Label", {
         qx.bom.element.Attribute.set(element, "text", text);
       }
 
-      return this.__measureSize(element, styles);
+      size = this.__measureSize(element, styles);
+      this.__storeCacheSize(cacheKey, text, size);
+      return size;
+    },
+
+    /**
+     * Returns a key for a specific set of styles, used in the caching of size calculations
+     *
+     * @param {*} styles
+     * @param {Integer?} width optional width
+     * @returns
+     */
+    __getCacheKey(styles, width) {
+      let cacheKey = [];
+      for (let key in styles) {
+        let value = styles[key];
+        if (value !== null) {
+          cacheKey.push(key + ":" + value);
+        }
+      }
+      if (width !== undefined) {
+        cacheKey.push("width:" + width);
+      }
+      return cacheKey.join(",");
+    },
+
+    /**
+     * Returns the cached size of the given text
+     *
+     * @param {String} cacheKey
+     * @param {String} text
+     * @returns {*} size object
+     */
+    __getCachedSize(cacheKey, text) {
+      let cache = qx.bom.Label.__sizeCache[cacheKey];
+      return cache?.sizes[text];
+    },
+
+    /**
+     * Stores the size of the given text in the cache
+     *
+     * @param {String} cacheKey
+     * @param {String} text
+     * @param {*} size
+     */
+    __storeCacheSize(cacheKey, text, size) {
+      if (!size) {
+        return;
+      }
+
+      let cache = qx.bom.Label.__sizeCache[cacheKey];
+      if (cache === undefined) {
+        cache = qx.bom.Label.__sizeCache[cacheKey] = {
+          sizes: {}
+        };
+      }
+      cache.sizes[text] = size;
+    },
+
+    /**
+     * Flushes the size cache - use this when something changes, for example webfonts have been loaded
+     */
+    flushSizeCache() {
+      qx.bom.Label.__sizeCache = {};
     },
 
     /**

package/source/class/qx/bom/webfonts/WebFont.js

@@ -112,6 +112,7 @@ qx.Class.define("qx.bom.webfonts.WebFont", {
     },
 
     __applyValid(value) {
+      qx.bom.Label.flushSizeCache();
       this.fireDataEvent("changeStatus", {
         family: this.getFamily(),
         valid: value

package/source/class/qx/core/Environment.js

@@ -891,6 +891,7 @@ qx.Bootstrap.define("qx.core.Environment", {
       "qx.dynlocale": true,
       "qx.dyntheme": true,
       "qx.blankpage": "qx/static/blank.html",
+      "qx.data.marshal.Json.breakOnNonPojos": false,
       "qx.debug.databinding": false,
       "qx.debug.dispose": false,
       "qx.debug.startupTimings": false,
@@ -913,7 +914,8 @@ qx.Bootstrap.define("qx.core.Environment", {
       "qx.promise.warnings": true,
       "qx.promise.longStackTraces": true,
       "qx.command.bindEnabled": false,
-      "qx.headless": false
+      "qx.headless": false,
+      "qx.environment.allowRuntimeMutations": false
     },
 
     /**
@@ -1210,6 +1212,74 @@ qx.Bootstrap.define("qx.core.Environment", {
       return this._asyncChecks;
     },
 
+    // mutation of environment settings at runtime
+
+    /**
+     * Sets the environment setting for the given key to the given value. This deletes any check function
+     * associated with this key. 
+     * 
+     * This method is only available if "qx.environment.allowRuntimeMutations" is set to true.
+     *
+     * @param key {String} The key of the environment setting to set.
+     * @param value {var} The value to set the environment setting to. Must be a scalar value.
+     */
+    set: qx.Bootstrap.getEnvironmentSetting("qx.environment.allowRuntimeMutations") ? function(key, value) {
+      if (key === undefined) {
+        throw new TypeError("Key must be provided to set an environment setting.");
+      }
+      if (this.__environmentBackup === undefined) {
+        qx.Bootstrap.warn("Modifying environment settings at runtime is enabled. This is a security risk and should not be done in production code.");
+        this.__environmentBackup = Object.assign({}, this.__cache);
+        this.__checksBackup = Object.assign({}, this._checks);
+      }
+      this.__cache[key] = value;
+      delete this._checks[key];
+      delete this._checksMap[key];
+    }: undefined,
+
+    /**
+     * Removes the environment setting for the given key, and any check function associated with it. 
+     * This method is only available if "qx.environment.allowRuntimeMutations" is set to true.
+     *
+     * @param key {String} The key of the environment setting to remove.
+     */
+    remove: qx.Bootstrap.getEnvironmentSetting("qx.environment.allowRuntimeMutations") ? function(key) {
+      if (key === undefined) {
+        throw new TypeError("Key must be provided to remove an environment setting.");
+      }
+      if (this.__environmentBackup === undefined || this.__environmentBackup[key] === undefined) {
+        throw new TypeError(`Environment setting "${key}" does not exist.`);
+      }
+      delete this.__cache[key];
+      delete this._checks[key];
+      delete this._checksMap[key];
+    }: undefined,
+
+    /**
+     * Resets the environment settings to their original values. If a key is provided, only that key is reset.
+     * This method is only available if "qx.environment.allowRuntimeMutations" is set to true.
+     *
+     * @param key {String?} The key of the environment setting to reset. If not provided, all settings are reset.
+     */
+    reset: qx.Bootstrap.getEnvironmentSetting("qx.environment.allowRuntimeMutations") ? function(key) {
+      if (this.__environmentBackup === undefined) {
+        // no backup available, nothing to reset
+        return;
+      }
+      if (key !== undefined && this.__environmentBackup[key] === undefined) {
+        throw new TypeError(`Environment setting "${key}" does not exist.`);
+      }
+      if (key === undefined) {
+        // reset all keys
+        this.__cache = Object.assign({}, this.__environmentBackup);
+        this._checks = Object.assign({}, this.__checksBackup);
+        return;
+      }
+      // only reset the particular key 
+      this.__cache[key] = this.__environmentBackup[key];
+      this._checks[key] = this.__checksBackup[key];
+    }: undefined,
+
     /**
      * Initializer for the default values of the framework settings.
      */
@@ -1296,5 +1366,17 @@ qx.Bootstrap.define("qx.core.Environment", {
     if (statics.get("qx.allowUrlSettings") === true) {
       statics.__importFromUrl();
     }
+  },
+
+  environment: {
+    /**
+     * By setting this key to true, the environment variables can be mutated at runtime, using the {@link #set} method,
+     * which is otherwise not available. This is only useful for testing and debugging purposes. We strongly advise
+     * against enabling this in production code. You have been warned.
+     * Note: This enviroment key declaration is only for documentation purposes and is not used during bootstrapping, so
+     * changing the value here will have no effect.
+     */
+    "qx.environment.allowRuntimeMutations": false,
   }
+
 });

package/source/class/qx/data/controller/List.js

@@ -207,14 +207,10 @@ qx.Class.define("qx.data.controller.List", {
     }
   },
 
-  /*
-  *****************************************************************************
-     MEMBERS
-  *****************************************************************************
-  */
-
   members: {
-    // private members
+    /**
+     * Listener ID for the 'change' event of property `model`
+     */
     __changeModelListenerId: null,
     __lookupTable: null,
     __onUpdate: null,
@@ -376,12 +372,16 @@ qx.Class.define("qx.data.controller.List", {
         }
       }
 
-      // erase the selection if there is something selected
-      if (this.getSelection() != undefined && this.getSelection().length > 0) {
-        this.getSelection().splice(0, this.getSelection().length).dispose();
+      if (!this.getAllowSelectionNotInModel()) {
+        //erase the selection if there is something selected
+        if (
+          this.getSelection() != undefined &&
+          this.getSelection().length > 0
+        ) {
+          this.getSelection().splice(0, this.getSelection().length).dispose();
+        }
       }
 
-      // if a model is set
       if (value != null) {
         // add a new listener
         this.__changeModelListenerId = value.addListener(
@@ -392,28 +392,40 @@ qx.Class.define("qx.data.controller.List", {
 
         // renew the index lookup table
         this.__buildUpLookupTable();
+
         // check for the new length
         this.__changeModelLength();
 
-        // as we only change the labels of the items, the selection change event
-        // may be missing so we invoke it here
-        if (old == null) {
-          this._changeTargetSelection();
+        if (!this.getAllowSelectionNotInModel()) {
+          // as we only change the labels of the items, the selection change event
+          // may be missing so we invoke it here
+          if (old == null) {
+            this._changeTargetSelection();
+          } else {
+            // update the selection asynchronously
+            this.__syncTargetSelection = true;
+            qx.ui.core.queue.Widget.add(this);
+          }
         } else {
-          // update the selection asynchronously
-          this.__syncTargetSelection = true;
+          this.__syncModelSelection = true;
           qx.ui.core.queue.Widget.add(this);
         }
       } else {
         var target = this.getTarget();
         // if the model is set to null, we should remove all items in the target
         if (target != null) {
+          if (this.getAllowSelectionNotInModel()) {
+            this._startSelectionModification();
+          }
           // we need to remove the bindings too so use the controller method
           // for removing items
           var length = target.getChildren().length;
           for (var i = 0; i < length; i++) {
             this.__removeItem();
           }
+          if (this.getAllowSelectionNotInModel()) {
+            this._endSelectionModification();
+          }
         }
       }
     },
@@ -431,6 +443,10 @@ qx.Class.define("qx.data.controller.List", {
       // add a listener for the target change
       this._addChangeTargetListener(value, old);
 
+      if (this.getAllowSelectionNotInModel()) {
+        this._startSelectionModification();
+      }
+
       // if there was an old target
       if (old != undefined) {
         // remove all element of the old target
@@ -450,6 +466,10 @@ qx.Class.define("qx.data.controller.List", {
           }
         }
       }
+
+      if (this.getAllowSelectionNotInModel()) {
+        this._endSelectionModification();
+      }
     },
 
     /*
@@ -518,6 +538,9 @@ qx.Class.define("qx.data.controller.List", {
       var newLength = this.__lookupTable.length;
       var currentLength = this.getTarget().getChildren().length;
 
+      if (this.getAllowSelectionNotInModel()) {
+        this._startSelectionModification();
+      }
       // if there are more item
       if (newLength > currentLength) {
         // add the new elements
@@ -532,13 +555,19 @@ qx.Class.define("qx.data.controller.List", {
         }
       }
 
+      if (this.getAllowSelectionNotInModel()) {
+        this._endSelectionModification();
+      }
+
       // build up the look up table
       this.__buildUpLookupTable();
 
-      // sync the target selection in case someone deleted a item in
-      // selection mode "one" [BUG #4839]
-      this.__syncTargetSelection = true;
-      qx.ui.core.queue.Widget.add(this);
+      if (!this.getAllowSelectionNotInModel()) {
+        // sync the target selection in case someone deleted a item in
+        // selection mode "one" [BUG #4839]
+        this.__syncTargetSelection = true;
+        qx.ui.core.queue.Widget.add(this);
+      }
     },
 
     /**

package/source/class/qx/data/controller/MSelection.js

@@ -61,6 +61,24 @@ qx.Mixin.define("qx.data.controller.MSelection", {
       event: "changeSelection",
       apply: "_applySelection",
       init: null
+    },
+
+    /**
+     * If set to true, the selection property will be allowed to have items which are not in the model property.
+     * If the model property changes, this will not cause the selection property to be reset.
+     *
+     * If the selection property contains items which are not in the model property,
+     * the selection of the target widget (e.g. qx.ui.form.SelectBox) will only be the items that are both in this controller's model property
+     * and in this controller's selection property.
+     *
+     * This is useful when it is undesirable to reset the selection when the model changes,
+     * because if the selection is bound to a business object,
+     * data in the business object may be overwritten.
+     */
+    allowSelectionNotInModel: {
+      check: "Boolean",
+      init: false,
+      nullable: false
     }
   },
 
@@ -125,6 +143,16 @@ qx.Mixin.define("qx.data.controller.MSelection", {
       this.resetSelection();
     },
 
+    /**
+     * Removes any items from the selection property that are not in the model property.
+     */
+    syncSelectionWithModel() {
+      //We will create a copy of my selection array and work on that to ensure there is only one change event being fired.
+      let mySelection = this.getSelection().copy();
+      mySelection = mySelection.filter(item => this.getModel().includes(item));
+      this.getSelection().replace(mySelection);
+    },
+
     /*
     ---------------------------------------------------------------------------
        APPLY METHODS
@@ -226,6 +254,8 @@ qx.Mixin.define("qx.data.controller.MSelection", {
     /**
      * Helper method which should be called by the classes including this
      * Mixin when the target changes.
+     * Removes the 'changeSelection' listener from the old target
+     * and add a new one to the new target;
      *
      * @param value {qx.ui.core.Widget|null} The new target.
      * @param old {qx.ui.core.Widget|null} The old target.
@@ -268,9 +298,9 @@ qx.Mixin.define("qx.data.controller.MSelection", {
       // if its a multi selection target
       if (this.__targetSupportsMultiSelection()) {
         var targetSelection = [];
-        // go through the selection array
+        // go through my selection array
         for (var i = 0; i < this.getSelection().length; i++) {
-          // store each item
+          // store each selectable item from target widget
           var model = this.getSelection().getItem(i);
           var selectable = this.__getSelectableForModel(model);
           if (selectable != null) {
@@ -281,21 +311,24 @@ qx.Mixin.define("qx.data.controller.MSelection", {
 
         // get the selection of the target
         targetSelection = this.getTarget().getSelection();
-        // get all items selected in the list
-        var targetSelectionItems = [];
+        // get all models of items selected in the target
+        var targetSelectionModels = [];
         for (var i = 0; i < targetSelection.length; i++) {
-          targetSelectionItems[i] = targetSelection[i].getModel();
+          targetSelectionModels[i] = targetSelection[i].getModel();
         }
 
-        // go through the controller selection
-        for (var i = this.getSelection().length - 1; i >= 0; i--) {
-          // if the item in the controller selection is not selected in the list
-          if (!targetSelectionItems.includes(this.getSelection().getItem(i))) {
-            // remove the current element and get rid of the return array
-            this.getSelection().splice(i, 1).dispose();
+        if (!this.getAllowSelectionNotInModel()) {
+          // go through the controller selection
+          for (var i = this.getSelection().length - 1; i >= 0; i--) {
+            // if the item in the controller selection is not selected in the list
+            if (
+              !targetSelectionModels.includes(this.getSelection().getItem(i))
+            ) {
+              // remove the current element and get rid of the return array
+              this.getSelection().splice(i, 1).dispose();
+            }
           }
         }
-
         // if its a single selection target
       } else if (this.__targetSupportsSingleSelection()) {
         // get the model which should be selected

package/source/class/qx/data/marshal/Json.js

@@ -37,6 +37,10 @@ qx.Class.define("qx.data.marshal.Json", {
   },
 
   statics: {
+    /**
+     * Set to true when a warning has been shown that we are using the deprecated behaviour of trying to marshall non-POJO objects into Qooxdoo objects.
+     */
+    __shownNotBreakingOnNonPojosWarning: false,
     $$instance: null,
 
     /**
@@ -76,6 +80,25 @@ qx.Class.define("qx.data.marshal.Json", {
         Object.keys(data).sort().join('"') +
         (includeBubbleEvents === true ? "♥" : "")
       );
+    },
+
+    /**
+     * If the environment setting "qx.data.marshal.Json.breakOnNonPojos" is not set,
+     * it means we are using the old behaviour of marshalling non-POJO objects.
+     * A warning is shown if it hasn't been shown already.
+     */
+    checkIfWarnAboutNotBreakingOnNonPojos() {
+      if (
+        !qx.core.Environment.get("qx.data.marshal.Json.breakOnNonPojos") &&
+        !this.__shownNotBreakingOnNonPojosWarning
+      ) {
+        console.warn(
+          `Using deprecated behaviour of not breaking on non-POJOs when marshalling.
+          Please set the environment setting "qx.data.marshal.Json.breakOnNonPojos" to enable the new behaviour.
+          The old behaviour will be removed in the next major release of Qooxdoo.`
+        );
+        this.__shownNotBreakingOnNonPojosWarning = true;
+      }
     }
   },
 
@@ -170,12 +193,26 @@ qx.Class.define("qx.data.marshal.Json", {
      * @param depth {Number} The depth of the data relative to the data's root.
      */
     __toClass(data, includeBubbleEvents, parentProperty, depth) {
+      const breakOnNonPojos = qx.core.Environment.get(
+        "qx.data.marshal.Json.breakOnNonPojos"
+      );
+      this.constructor.checkIfWarnAboutNotBreakingOnNonPojos();
+
       // break on all primitive json types and qooxdoo objects
-      if (
-        !qx.lang.Type.isObject(data) ||
-        !!data.$$isString || // check for localized strings
-        data instanceof qx.core.Object
-      ) {
+      let shouldBreak;
+      if (breakOnNonPojos) {
+        shouldBreak =
+          !qx.lang.Type.isPojo(data) ||
+          !!data.$$isString || // check for localized strings
+          data instanceof qx.core.Object;
+      } else {
+        shouldBreak =
+          !qx.lang.Type.isObject(data) ||
+          !!data.$$isString || // check for localized strings
+          data instanceof qx.core.Object;
+      }
+
+      if (shouldBreak) {
         // check for arrays
         if (data instanceof Array || qx.Bootstrap.getClass(data) == "Array") {
           for (var i = 0; i < data.length; i++) {
@@ -405,15 +442,31 @@ qx.Class.define("qx.data.marshal.Json", {
      * @return {qx.core.Object} The created model object.
      */
     __toModel(data, includeBubbleEvents, parentProperty, depth) {
+      const breakOnNonPojos = qx.core.Environment.get(
+        "qx.data.marshal.Json.breakOnNonPojos"
+      );
+      this.constructor.checkIfWarnAboutNotBreakingOnNonPojos();
+
       var isObject = qx.lang.Type.isObject(data);
+      var isPojo = qx.lang.Type.isPojo(data);
+
       var isArray =
         data instanceof Array || qx.Bootstrap.getClass(data) == "Array";
 
-      if (
-        (!isObject && !isArray) ||
-        !!data.$$isString || // check for localized strings
-        data instanceof qx.core.Object
-      ) {
+      let shouldBreak;
+      if (breakOnNonPojos) {
+        shouldBreak =
+          (!isPojo && !isArray) ||
+          !!data.$$isString || // check for localized strings
+          data instanceof qx.core.Object;
+      } else {
+        shouldBreak =
+          (!isObject && !isArray) ||
+          !!data.$$isString || // check for localized strings
+          data instanceof qx.core.Object;
+      }
+
+      if (shouldBreak) {
         return data;
 
         // ignore rules
@@ -451,7 +504,7 @@ qx.Class.define("qx.data.marshal.Json", {
           );
         }
         return array;
-      } else if (isObject) {
+      } else if (breakOnNonPojos ? isPojo : isObject) {
         // create an instance for the object
         var hash = this.__jsonToBestHash(data, includeBubbleEvents);
         var model = this.__createInstance(hash, data, parentProperty, depth);

package/source/class/qx/dev/unit/AsyncWrapper.js

@@ -85,5 +85,13 @@ qx.Class.define("qx.dev.unit.AsyncWrapper", {
       nullable: false,
       init: 10000
     }
+  },
+
+  environment: {
+    /**
+     * The factor by which any delay is multiplied or false or zero if no such
+     * factor should be applied.
+     */
+    "qx.test.delay.scale": false
   }
 });