@qooxdoo/framework 7.9.1 → 8.0.0-beta.1

package/source/class/qx/core/property/ExplicitPropertyStorage.js

@@ -0,0 +1,87 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+     2023-24 Zenesis Limited (https://www.zenesis.com)
+
+   License:
+     MIT: https://opensource.org/licenses/MIT
+     See the LICENSE file in the project's top-level directory for details.
+
+   Authors:
+     * John Spackman (github.com/johnspackman)
+
+************************************************************************ */
+
+/**
+ * Property storage for properties which have explicit getter/setter methods in the property definition
+ */
+qx.Bootstrap.define("qx.core.property.ExplicitPropertyStorage", {
+  extend: Object,
+  implement: qx.core.property.IPropertyStorage,
+
+  /**
+   * @param {qx.core.property.Property} property
+   * @param {Function} clazz Qooxdoo class which the property relates to
+   */
+  construct(property, clazz) {
+    super();
+    let def = property.getDefinition();
+    this.__property = property;
+    this.__get = def.get;
+    this.__getAsync = def.getAsync || def.get;
+    this.__set = def.set;
+    this.__setAsync = def.setAsync || def.set;
+  },
+
+  members: {
+    /**
+     * @type {qx.core.property.Property}
+     */
+    __property: null,
+    /**
+     * @Override
+     */
+    get(thisObj, property) {
+      return this.__get.call(thisObj, property, thisObj);
+    },
+
+    /**
+     * @Override
+     */
+    getAsync(thisObj, property) {
+      return this.__getAsync.call(thisObj, property, thisObj);
+    },
+
+    /**
+     * @Override
+     */
+    set(thisObj, property, value) {
+      this.__set.call(thisObj, value, property, thisObj);
+    },
+
+    /**
+     * @Override
+     */
+    setAsync(thisObj, property, value) {
+      return this.__setAsync.call(thisObj, property, value);
+    },
+
+    /**
+     * @Override
+     */
+    dereference(thisObj, property) {
+      // Nothing
+    },
+
+    /**
+     * @Override
+     */
+    isAsyncStorage() {
+      return this.__property.isAsync();
+    }
+  }
+});

package/source/class/qx/core/property/GroupProperty.js

@@ -0,0 +1,262 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+     2023-24 Zenesis Limited (https://www.zenesis.com)
+
+   License:
+     MIT: https://opensource.org/licenses/MIT
+     See the LICENSE file in the project's top-level directory for details.
+
+   Authors:
+     * John Spackman (github.com/johnspackman)
+
+************************************************************************ */
+
+/**
+ * Property implementation for property groups
+ */
+qx.Bootstrap.define("qx.core.property.GroupProperty", {
+  extend: Object,
+  implement: qx.core.property.IProperty,
+
+  construct(propertyName, clazz) {
+    super();
+    this.__propertyName = propertyName;
+    this.__clazz = clazz;
+  },
+
+  members: {
+    /** @type {String} the name of the property */
+    __propertyName: null,
+
+    /** @type {qx.Class} the class that defined the property */
+    __clazz: null,
+
+    /**
+     * @Override
+     */
+    clone(clazz) {
+      let clone = new qx.core.property.GroupProperty(this.__propertyName);
+      clone.__clazz = clazz;
+      return clone;
+    },
+
+    /**
+     * @Override
+     */
+    configure(def) {
+      this.__definition = def;
+
+      if (qx.core.Environment.get("qx.debug")) {
+        let allProperties = this.__clazz.prototype.$$properties;
+
+        // Validate that group contains only existing properties, and if
+        // themeable contains only themeable properties
+        for (let propertyName of def.group) {
+          if (!(propertyName in allProperties)) {
+            throw new Error(
+              `Class ${this.__clazz.classname}: ` +
+                `Property group '${this.__propertyName}': ` +
+                `property '${propertyName}' does not exist`
+            );
+          }
+
+          if (allProperties[propertyName] instanceof qx.core.property.GroupProperty) {
+            throw new Error(
+              `Class ${this.__clazz.classname}: ` +
+                `Property group '${this.__propertyName}': ` +
+                `can not add group '${propertyName}' to a group`
+            );
+          }
+
+          if (def.themeable && !allProperties[propertyName].isThemeable()) {
+            throw new Error(
+              `Class ${this.__clazz.classname}: ` +
+                `Property group '${this.__propertyName}': ` +
+                `can not add themeable property '${propertyName}' to ` +
+                "non-themeable group"
+            );
+          }
+        }
+      }
+    },
+
+    /**
+     * @Override
+     */
+    defineProperty(clazz, patch) {
+      let propertyName = this.getPropertyName();
+      let scopePrefix = "";
+      if (propertyName.startsWith("__")) {
+        scopePrefix = "__";
+        propertyName = propertyName.substring(2);
+      } else if (propertyName.startsWith("_")) {
+        scopePrefix = "_";
+        propertyName = propertyName.substring(1);
+      }
+      let upname = qx.Bootstrap.firstUp(propertyName);
+      let self = this;
+
+      const addMethod = (name, func) => {
+        clazz.prototype[scopePrefix + name] = func;
+        qx.Bootstrap.setDisplayName(func, clazz.classname, "prototype." + name);
+      };
+
+      // theme-specified
+      if (this.__definition.themeable) {
+        addMethod("setThemed" + upname, function (value) {
+          self.setThemed(this, value);
+        });
+
+        addMethod("resetThemed" + upname, function () {
+          self.resetThemed(this);
+        });
+      }
+
+      // Native property value
+      Object.defineProperty(clazz.prototype, propertyName, {
+        get: function () {
+          return undefined;
+        },
+        set: function (value) {
+          self.set(this, value);
+        },
+        configurable: qx.Class.$$options.propsAccessible || false,
+        enumerable: qx.Class.$$options.propsAccessible || false
+      });
+
+      addMethod("set" + upname, function (...args) {
+        return self.set(this, ...args);
+      });
+      addMethod("reset" + upname, function (...args) {
+        self.reset(this, ...args);
+      });
+    },
+
+    /**
+     * Sets a value
+     *
+     * @param {qx.core.Object} thisObj
+     * @param  {...any} args
+     */
+    set(thisObj, ...args) {
+      this.__iterateProperties((propertyName, value) => (thisObj[propertyName] = value), thisObj, ...args);
+    },
+
+    /**
+     * Resets a value
+     *
+     * @param {qx.core.Object} thisObj
+     * @param  {...any} args
+     */
+    reset(thisObj, value) {
+      this.__iterateProperties(
+        (propertyName, value) => {
+          let upname = qx.Bootstrap.firstUp(propertyName);
+          thisObj[`reset${upname}`]();
+        },
+        thisObj,
+        ...args
+      );
+    },
+
+    /**
+     * Sets a themed value
+     *
+     * @param {qx.core.Object} thisObj
+     * @param  {...any} args
+     */
+    setThemed(thisObj, ...args) {
+      this.__iterateProperties(
+        (propertyName, value) => {
+          let upname = qx.Bootstrap.firstUp(propertyName);
+          thisObj[`setThemed${upname}`](value);
+        },
+        thisObj,
+        ...args
+      );
+    },
+
+    /**
+     * Resets a themed value
+     *
+     * @param {qx.core.Object} thisObj
+     * @param  {...any} args
+     */
+    resetThemed(thisObj) {
+      this.__iterateProperties((propertyName, value) => {
+        let upname = qx.Bootstrap.firstUp(propertyName);
+        thisObj[`resetThemed${upname}`]();
+      }, thisObj);
+    },
+
+    /**
+     * Iterates all the properties, with the value to set
+     *
+     * @param {Function} callback which is passed the propertyName and value
+     * @param {qx.core.Object} thisObj
+     * @param  {...any} args
+     */
+    __iterateProperties(callback, thisObj, ...args) {
+      // No arguments (eg a `resetXxx` method)
+      if (!args || !args.length) {
+        for (let i = 0; i < this.__definition.group.length; i++) {
+          callback(this.__definition.group[i]);
+        }
+        return;
+      }
+
+      // We can have received separate arguments, or a single array of arguments. Convert the former to the latter if
+      // necessary.
+      if (args.length == 1 && qx.lang.Type.isArray(args[0])) {
+        args = args[0];
+      }
+      args = qx.lang.Array.clone(args);
+
+      for (let i = 0; i < this.__definition.group.length && args.length > 0; i++) {
+        let value = args.shift();
+        callback(this.__definition.group[i], value);
+
+        // If we're in shorthand mode, we may reuse that value. Put it back at the end of the argument
+        // list.
+        args.push(value);
+      }
+    },
+
+    /**
+     * Returns the property name
+     *
+     * @returns {String}
+     */
+    getPropertyName() {
+      return this.__propertyName;
+    },
+
+    /**
+     * Returns the event name
+     *
+     * @returns {String?}
+     */
+    getEventName() {
+      return null;
+    },
+
+    /**
+     * @Override
+     */
+    isInheritable() {
+      return null;
+    },
+
+    /**
+     * @Override
+     */
+    toString() {
+      return this.__clazz.classname + "." + this.__propertyName;
+    }
+  }
+});

package/source/class/qx/core/property/IProperty.js

@@ -0,0 +1,46 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+     2023-24 Zenesis Limited (https://www.zenesis.com)
+
+   License:
+     MIT: https://opensource.org/licenses/MIT
+     See the LICENSE file in the project's top-level directory for details.
+
+   Authors:
+     * John Spackman (github.com/johnspackman)
+
+************************************************************************ */
+
+/**
+ * Property implementations must support this interface
+ */
+qx.Interface.define("qx.core.property.IProperty", {
+  members: {
+    /**
+     * Configures the property from a property definition; note that this can be called
+     * after `clone` or after constructing a new object
+     *
+     * @param {*} def the property definition as written by the user
+     */
+    configure(def, clazz) {},
+
+    /**
+     * Called to define the property on a class prototype
+     *
+     * @param {qx.Class} clazz the class having the property defined
+     * @param {Boolean?} patch whether patching an existing class
+     */
+    defineProperty(clazz, patch) {},
+
+    /**
+     * Whether this property is inheritable
+     * @return {Boolean}
+     */
+    isInheritable() {}
+  }
+});

package/source/class/qx/core/property/IPropertyStorage.js

@@ -0,0 +1,83 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+     2023-24 Zenesis Limited (https://www.zenesis.com)
+
+   License:
+     MIT: https://opensource.org/licenses/MIT
+     See the LICENSE file in the project's top-level directory for details.
+
+   Authors:
+     * John Spackman (github.com/johnspackman)
+
+************************************************************************ */
+
+/**
+ * Interface for objects that provide actual property storage
+ */
+qx.Interface.define("qx.core.property.IPropertyStorage", {
+  members: {
+    /**
+     * Gets a value, returns undefined if the value is not set
+     *
+     * @param {qx.core.Object} thisObj
+     * @param {qx.core.propety.IProperty} property the property to get the value of
+     * @return {*}
+     */
+    get(thisObj, property) {},
+
+    /**
+     * Gets a value asynchronously, returns a promise for the value
+     *
+     * @param {qx.core.Object} thisObj
+     * @param {qx.core.propety.IProperty} property the property to get the value of
+     * @return {Promise<*>}
+     */
+    async getAsync(thisObj, property) {},
+
+    /**
+     * Sets a value
+     *
+     * @param {qx.core.Object} thisObj
+     * @param {qx.core.propety.IProperty} property the property to set the value of
+     * @param {*} value
+     */
+    set(thisObj, property, value) {},
+
+    /**
+     * Sets a value asynchronously
+     *
+     * @param {qx.core.Object} thisObj
+     * @param {qx.core.propety.IProperty} property the property to set the value of
+     * @param {*} value
+     */
+    async setAsync(thisObj, property, value) {},
+
+    /**
+     * Called when the property is reset; for standard properties, this just passes through to
+     * `set`, but pseudo properties may need to call the implemented `reset` method
+     *
+     * @param {qx.core.Object} thisObj
+     * @param {qx.core.propety.IProperty} property the property to set the value of
+     * @param {*} value
+     */
+    reset(thisObj, property, value) {},
+
+    /**
+     * Deletes the value
+     *
+     * @param {qx.core.Object} thisObj
+     * @param {qx.core.propety.IProperty} property the property to dereference
+     */
+    dereference(thisObj, property) {},
+
+    /**
+     * Returns whether the storage supports asynchronous backing, ie the getter could be async
+     */
+    isAsyncStorage() {}
+  }
+});

package/source/class/qx/core/property/ImmutableArrayStorage.js

@@ -0,0 +1,38 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+     2023-24 Zenesis Limited (https://www.zenesis.com)
+
+   License:
+     MIT: https://opensource.org/licenses/MIT
+     See the LICENSE file in the project's top-level directory for details.
+
+   Authors:
+     * John Spackman (github.com/johnspackman)
+
+************************************************************************ */
+
+/**
+ * Immutable storage for native arrays
+ */
+qx.Bootstrap.define("qx.core.property.ImmutableArrayStorage", {
+  extend: qx.core.property.SimplePropertyStorage,
+
+  members: {
+    /**
+     * @Override
+     */
+    set(thisObj, property, value) {
+      let oldValue = this.get(thisObj, property);
+      if (oldValue) {
+        qx.lang.Array.replace(oldValue, value || []);
+      } else {
+        super.set(thisObj, property, value);
+      }
+    }
+  }
+});

package/source/class/qx/core/property/ImmutableDataArrayStorage.js

@@ -0,0 +1,38 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+     2023-24 Zenesis Limited (https://www.zenesis.com)
+
+   License:
+     MIT: https://opensource.org/licenses/MIT
+     See the LICENSE file in the project's top-level directory for details.
+
+   Authors:
+     * John Spackman (github.com/johnspackman)
+
+************************************************************************ */
+
+/**
+ * Immutable storage for `qx.data.Array`
+ */
+qx.Bootstrap.define("qx.core.property.ImmutableDataArrayStorage", {
+  extend: qx.core.property.SimplePropertyStorage,
+
+  members: {
+    /**
+     * @Override
+     */
+    set(thisObj, property, value) {
+      let oldValue = this.get(thisObj, property);
+      if (oldValue) {
+        oldValue.replace(value || []);
+      } else {
+        super.set(thisObj, property, value);
+      }
+    }
+  }
+});

package/source/class/qx/core/property/ImmutableObjectStorage.js

@@ -0,0 +1,39 @@
+/* ************************************************************************
+
+   qooxdoo - the new era of web development
+
+   http://qooxdoo.org
+
+   Copyright:
+     2023-24 Zenesis Limited (https://www.zenesis.com)
+
+   License:
+     MIT: https://opensource.org/licenses/MIT
+     See the LICENSE file in the project's top-level directory for details.
+
+   Authors:
+     * John Spackman (github.com/johnspackman)
+
+************************************************************************ */
+
+/**
+ * Immutable storage for native objects
+ */
+qx.Bootstrap.define("qx.core.property.ImmutableObjectStorage", {
+  extend: qx.core.property.SimplePropertyStorage,
+
+  members: {
+    /**
+     * @Override
+     */
+    set(thisObj, property, value) {
+      let oldValue = this.get(thisObj, property);
+      if (oldValue) {
+        Object.keys(oldValue).forEach(key => delete oldValue[key]);
+        Object.assign(oldValue, value);
+      } else {
+        super.set(thisObj, property, value);
+      }
+    }
+  }
+});