blockly 7.20211209.2 → 8.0.0

package/core/field_label.js

@@ -19,119 +19,130 @@ goog.module('Blockly.FieldLabel');
 
 const dom = goog.require('Blockly.utils.dom');
 const fieldRegistry = goog.require('Blockly.fieldRegistry');
-const object = goog.require('Blockly.utils.object');
 const parsing = goog.require('Blockly.utils.parsing');
 const {Field} = goog.require('Blockly.Field');
+/* eslint-disable-next-line no-unused-vars */
+const {Sentinel} = goog.requireType('Blockly.utils.Sentinel');
 
 
 /**
  * Class for a non-editable, non-serializable text field.
- * @param {string=} opt_value The initial value of the field. Should cast to a
- *    string. Defaults to an empty string if null or undefined.
- * @param {string=} opt_class Optional CSS class for the field's text.
- * @param {Object=} opt_config A map of options used to configure the field.
- *    See the [field creation documentation]{@link
- * https://developers.google.com/blockly/guides/create-custom-blocks/fields/built-in-fields/label#creation}
- *    for a list of properties this parameter supports.
  * @extends {Field}
- * @constructor
  * @alias Blockly.FieldLabel
  */
-const FieldLabel = function(opt_value, opt_class, opt_config) {
+class FieldLabel extends Field {
   /**
-   * The html class name to use for this field.
-   * @type {?string}
-   * @private
+   * @param {(string|!Sentinel)=} opt_value The initial value of the
+   *     field. Should cast to a string. Defaults to an empty string if null or
+   *     undefined.
+   *     Also accepts Field.SKIP_SETUP if you wish to skip setup (only used by
+   *     subclasses that want to handle configuration and setting the field
+   *     value after their own constructors have run).
+   * @param {string=} opt_class Optional CSS class for the field's text.
+   * @param {Object=} opt_config A map of options used to configure the field.
+   *    See the [field creation documentation]{@link
+   * https://developers.google.com/blockly/guides/create-custom-blocks/fields/built-in-fields/label#creation}
+   *    for a list of properties this parameter supports.
    */
-  this.class_ = null;
-
-  FieldLabel.superClass_.constructor.call(this, opt_value, null, opt_config);
-
-  if (!opt_config) {  // If the config was not passed use old configuration.
-    this.class_ = opt_class || null;
+  constructor(opt_value, opt_class, opt_config) {
+    super(Field.SKIP_SETUP);
+
+    /**
+     * The html class name to use for this field.
+     * @type {?string}
+     * @private
+     */
+    this.class_ = null;
+
+    /**
+     * Editable fields usually show some sort of UI indicating they are
+     * editable. This field should not.
+     * @type {boolean}
+     */
+    this.EDITABLE = false;
+
+    if (opt_value === Field.SKIP_SETUP) return;
+    if (opt_config) {
+      this.configure_(opt_config);
+    } else {
+      this.class_ = opt_class || null;
+    }
+    this.setValue(opt_value);
   }
-};
-object.inherits(FieldLabel, Field);
-
-/**
- * The default value for this field.
- * @type {*}
- * @protected
- */
-FieldLabel.prototype.DEFAULT_VALUE = '';
 
-/**
- * Construct a FieldLabel from a JSON arg object,
- * dereferencing any string table references.
- * @param {!Object} options A JSON object with options (text, and class).
- * @return {!FieldLabel} The new field instance.
- * @package
- * @nocollapse
- */
-FieldLabel.fromJson = function(options) {
-  const text = parsing.replaceMessageReferences(options['text']);
-  // `this` might be a subclass of FieldLabel if that class doesn't override
-  // the static fromJson method.
-  return new this(text, undefined, options);
-};
+  /**
+   * @override
+   */
+  configure_(config) {
+    super.configure_(config);
+    this.class_ = config['class'];
+  }
 
-/**
- * Editable fields usually show some sort of UI indicating they are
- * editable. This field should not.
- * @type {boolean}
- */
-FieldLabel.prototype.EDITABLE = false;
+  /**
+   * Create block UI for this label.
+   * @package
+   */
+  initView() {
+    this.createTextElement_();
+    if (this.class_) {
+      dom.addClass(
+          /** @type {!SVGTextElement} */ (this.textElement_), this.class_);
+    }
+  }
 
-/**
- * @override
- */
-FieldLabel.prototype.configure_ = function(config) {
-  FieldLabel.superClass_.configure_.call(this, config);
-  this.class_ = config['class'];
-};
+  /**
+   * Ensure that the input value casts to a valid string.
+   * @param {*=} opt_newValue The input value.
+   * @return {?string} A valid string, or null if invalid.
+   * @protected
+   */
+  doClassValidation_(opt_newValue) {
+    if (opt_newValue === null || opt_newValue === undefined) {
+      return null;
+    }
+    return String(opt_newValue);
+  }
 
-/**
- * Create block UI for this label.
- * @package
- */
-FieldLabel.prototype.initView = function() {
-  this.createTextElement_();
-  if (this.class_) {
-    dom.addClass(
-        /** @type {!SVGTextElement} */ (this.textElement_), this.class_);
+  /**
+   * Set the CSS class applied to the field's textElement_.
+   * @param {?string} cssClass The new CSS class name, or null to remove.
+   */
+  setClass(cssClass) {
+    if (this.textElement_) {
+      // This check isn't necessary, but it's faster than letting removeClass
+      // figure it out.
+      if (this.class_) {
+        dom.removeClass(this.textElement_, this.class_);
+      }
+      if (cssClass) {
+        dom.addClass(this.textElement_, cssClass);
+      }
+    }
+    this.class_ = cssClass;
   }
-};
 
-/**
- * Ensure that the input value casts to a valid string.
- * @param {*=} opt_newValue The input value.
- * @return {?string} A valid string, or null if invalid.
- * @protected
- */
-FieldLabel.prototype.doClassValidation_ = function(opt_newValue) {
-  if (opt_newValue === null || opt_newValue === undefined) {
-    return null;
+  /**
+   * Construct a FieldLabel from a JSON arg object,
+   * dereferencing any string table references.
+   * @param {!Object} options A JSON object with options (text, and class).
+   * @return {!FieldLabel} The new field instance.
+   * @package
+   * @nocollapse
+   */
+  static fromJson(options) {
+    const text = parsing.replaceMessageReferences(options['text']);
+    // `this` might be a subclass of FieldLabel if that class doesn't override
+    // the static fromJson method.
+    return new this(text, undefined, options);
   }
-  return String(opt_newValue);
-};
+}
 
 /**
- * Set the CSS class applied to the field's textElement_.
- * @param {?string} cssClass The new CSS class name, or null to remove.
+ * The default value for this field.
+ * @type {*}
+ * @protected
  */
-FieldLabel.prototype.setClass = function(cssClass) {
-  if (this.textElement_) {
-    // This check isn't necessary, but it's faster than letting removeClass
-    // figure it out.
-    if (this.class_) {
-      dom.removeClass(this.textElement_, this.class_);
-    }
-    if (cssClass) {
-      dom.addClass(this.textElement_, cssClass);
-    }
-  }
-  this.class_ = cssClass;
-};
+FieldLabel.prototype.DEFAULT_VALUE = '';
 
 fieldRegistry.register('field_label', FieldLabel);
 

package/core/field_label_serializable.js

@@ -20,59 +20,60 @@
 goog.module('Blockly.FieldLabelSerializable');
 
 const fieldRegistry = goog.require('Blockly.fieldRegistry');
-const object = goog.require('Blockly.utils.object');
 const parsing = goog.require('Blockly.utils.parsing');
 const {FieldLabel} = goog.require('Blockly.FieldLabel');
 
 
 /**
  * Class for a non-editable, serializable text field.
- * @param {*} opt_value The initial value of the field. Should cast to a
- *    string. Defaults to an empty string if null or undefined.
- * @param {string=} opt_class Optional CSS class for the field's text.
- * @param {Object=} opt_config A map of options used to configure the field.
- *    See the [field creation documentation]{@link
- * https://developers.google.com/blockly/guides/create-custom-blocks/fields/built-in-fields/label-serializable#creation}
- *    for a list of properties this parameter supports.
  * @extends {FieldLabel}
- * @constructor
- *
  * @alias Blockly.FieldLabelSerializable
  */
-const FieldLabelSerializable = function(opt_value, opt_class, opt_config) {
-  FieldLabelSerializable.superClass_.constructor.call(
-      this, opt_value, opt_class, opt_config);
-};
-object.inherits(FieldLabelSerializable, FieldLabel);
+class FieldLabelSerializable extends FieldLabel {
+  /**
+   * @param {string=} opt_value The initial value of the field. Should cast to a
+   *    string. Defaults to an empty string if null or undefined.
+   * @param {string=} opt_class Optional CSS class for the field's text.
+   * @param {Object=} opt_config A map of options used to configure the field.
+   *    See the [field creation documentation]{@link
+   * https://developers.google.com/blockly/guides/create-custom-blocks/fields/built-in-fields/label-serializable#creation}
+   *    for a list of properties this parameter supports.
+   */
+  constructor(opt_value, opt_class, opt_config) {
+    super(String(opt_value ?? ''), opt_class, opt_config);
 
-/**
- * Construct a FieldLabelSerializable from a JSON arg object,
- * dereferencing any string table references.
- * @param {!Object} options A JSON object with options (text, and class).
- * @return {!FieldLabelSerializable} The new field instance.
- * @package
- * @nocollapse
- */
-FieldLabelSerializable.fromJson = function(options) {
-  const text = parsing.replaceMessageReferences(options['text']);
-  // `this` might be a subclass of FieldLabelSerializable if that class doesn't
-  // override the static fromJson method.
-  return new this(text, undefined, options);
-};
+    /**
+     * Editable fields usually show some sort of UI indicating they are
+     * editable. This field should not.
+     * @type {boolean}
+     */
+    this.EDITABLE = false;
 
-/**
- * Editable fields usually show some sort of UI indicating they are
- * editable. This field should not.
- * @type {boolean}
- */
-FieldLabelSerializable.prototype.EDITABLE = false;
+    /**
+     * Serializable fields are saved by the XML renderer, non-serializable
+     * fields are not.  This field should be serialized, but only edited
+     * programmatically.
+     * @type {boolean}
+     */
+    this.SERIALIZABLE = true;
+  }
 
-/**
- * Serializable fields are saved by the XML renderer, non-serializable fields
- * are not.  This field should be serialized, but only edited programmatically.
- * @type {boolean}
- */
-FieldLabelSerializable.prototype.SERIALIZABLE = true;
+  /**
+   * Construct a FieldLabelSerializable from a JSON arg object,
+   * dereferencing any string table references.
+   * @param {!Object} options A JSON object with options (text, and class).
+   * @return {!FieldLabelSerializable} The new field instance.
+   * @package
+   * @nocollapse
+   * @override
+   */
+  static fromJson(options) {
+    const text = parsing.replaceMessageReferences(options['text']);
+    // `this` might be a subclass of FieldLabelSerializable if that class
+    // doesn't override the static fromJson method.
+    return new this(text, undefined, options);
+  }
+}
 
 fieldRegistry.register('field_label_serializable', FieldLabelSerializable);