blockly 9.0.0-beta.0 → 9.0.0-beta.1

package/core/field_image.ts

@@ -1,282 +0,0 @@
-/**
- * @license
- * Copyright 2012 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Image field.  Used for pictures, icons, etc.
- */
-
-/**
- * Image field.  Used for pictures, icons, etc.
- * @class
- */
-import * as goog from '../closure/goog/goog.js';
-goog.declareModuleId('Blockly.FieldImage');
-
-import {FieldConfig, Field} from './field.js';
-import * as fieldRegistry from './field_registry.js';
-import * as dom from './utils/dom.js';
-import * as parsing from './utils/parsing.js';
-import type {Sentinel} from './utils/sentinel.js';
-import {Size} from './utils/size.js';
-import {Svg} from './utils/svg.js';
-
-
-/**
- * Class for an image on a block.
- * @alias Blockly.FieldImage
- */
-export class FieldImage extends Field {
-  /**
-   * Vertical padding below the image, which is included in the reported height
-   * of the field.
-   */
-  private static readonly Y_PADDING = 1;
-  protected override size_: Size;
-  private readonly imageHeight_: number;
-
-  /** The function to be called when this field is clicked. */
-  private clickHandler_: ((p1: FieldImage) => AnyDuringMigration)|null = null;
-
-  /** The rendered field's image element. */
-  // AnyDuringMigration because:  Type 'null' is not assignable to type
-  // 'SVGImageElement'.
-  private imageElement_: SVGImageElement = null as AnyDuringMigration;
-
-  /**
-   * Editable fields usually show some sort of UI indicating they are
-   * editable. This field should not.
-   */
-  override readonly EDITABLE = false;
-
-  /**
-   * Used to tell if the field needs to be rendered the next time the block is
-   * rendered. Image fields are statically sized, and only need to be
-   * rendered at initialization.
-   */
-  protected override isDirty_ = false;
-
-  /** Whether to flip this image in RTL. */
-  private flipRtl_ = false;
-
-  /** Alt text of this image. */
-  private altText_ = '';
-  override value_: AnyDuringMigration;
-
-  /**
-   * @param src The URL of the image.
-   *     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 width Width of the image.
-   * @param height Height of the image.
-   * @param opt_alt Optional alt text for when block is collapsed.
-   * @param opt_onClick Optional function to be called when the image is
-   *     clicked. If opt_onClick is defined, opt_alt must also be defined.
-   * @param opt_flipRtl Whether to flip the icon in RTL.
-   * @param 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/image#creation}
-   * for a list of properties this parameter supports.
-   */
-  constructor(
-      src: string|Sentinel, width: string|number, height: string|number,
-      opt_alt?: string, opt_onClick?: (p1: FieldImage) => AnyDuringMigration,
-      opt_flipRtl?: boolean, opt_config?: FieldImageConfig) {
-    super(Field.SKIP_SETUP);
-
-    const imageHeight = Number(parsing.replaceMessageReferences(height));
-    const imageWidth = Number(parsing.replaceMessageReferences(width));
-    if (isNaN(imageHeight) || isNaN(imageWidth)) {
-      throw Error(
-          'Height and width values of an image field must cast to' +
-          ' numbers.');
-    }
-    if (imageHeight <= 0 || imageWidth <= 0) {
-      throw Error(
-          'Height and width values of an image field must be greater' +
-          ' than 0.');
-    }
-
-    /** The size of the area rendered by the field. */
-    this.size_ = new Size(imageWidth, imageHeight + FieldImage.Y_PADDING);
-
-    /**
-     * Store the image height, since it is different from the field height.
-     */
-    this.imageHeight_ = imageHeight;
-
-    if (typeof opt_onClick === 'function') {
-      this.clickHandler_ = opt_onClick;
-    }
-
-    if (src === Field.SKIP_SETUP) {
-      return;
-    }
-
-    if (opt_config) {
-      this.configure_(opt_config);
-    } else {
-      this.flipRtl_ = !!opt_flipRtl;
-      this.altText_ = parsing.replaceMessageReferences(opt_alt) || '';
-    }
-    this.setValue(parsing.replaceMessageReferences(src));
-  }
-
-  /**
-   * Configure the field based on the given map of options.
-   * @param config A map of options to configure the field based on.
-   */
-  protected override configure_(config: FieldImageConfig) {
-    super.configure_(config);
-    if (config.flipRtl) this.flipRtl_ = config.flipRtl;
-    if (config.alt) {
-      this.altText_ = parsing.replaceMessageReferences(config.alt);
-    }
-  }
-
-  /**
-   * Create the block UI for this image.
-   * @internal
-   */
-  override initView() {
-    this.imageElement_ = dom.createSvgElement(
-        Svg.IMAGE, {
-          'height': this.imageHeight_ + 'px',
-          'width': this.size_.width + 'px',
-          'alt': this.altText_,
-        },
-        this.fieldGroup_);
-    this.imageElement_.setAttributeNS(
-        dom.XLINK_NS, 'xlink:href', this.value_ as string);
-
-    if (this.clickHandler_) {
-      this.imageElement_.style.cursor = 'pointer';
-    }
-  }
-
-  override updateSize_() {}
-  // NOP
-
-  /**
-   * Ensure that the input value (the source URL) is a string.
-   * @param opt_newValue The input value.
-   * @return A string, or null if invalid.
-   */
-  protected override doClassValidation_(opt_newValue?: AnyDuringMigration):
-      string|null {
-    if (typeof opt_newValue !== 'string') {
-      return null;
-    }
-    return opt_newValue;
-  }
-
-  /**
-   * Update the value of this image field, and update the displayed image.
-   * @param newValue The value to be saved. The default validator guarantees
-   *     that this is a string.
-   */
-  protected override doValueUpdate_(newValue: AnyDuringMigration) {
-    this.value_ = newValue;
-    if (this.imageElement_) {
-      this.imageElement_.setAttributeNS(
-          dom.XLINK_NS, 'xlink:href', String(this.value_));
-    }
-  }
-
-  /**
-   * Get whether to flip this image in RTL
-   * @return True if we should flip in RTL.
-   */
-  override getFlipRtl(): boolean {
-    return this.flipRtl_;
-  }
-
-  /**
-   * Set the alt text of this image.
-   * @param alt New alt text.
-   */
-  setAlt(alt: string|null) {
-    if (alt === this.altText_) {
-      return;
-    }
-    this.altText_ = alt || '';
-    if (this.imageElement_) {
-      this.imageElement_.setAttribute('alt', this.altText_);
-    }
-  }
-
-  /**
-   * If field click is called, and click handler defined,
-   * call the handler.
-   */
-  protected override showEditor_() {
-    if (this.clickHandler_) {
-      this.clickHandler_(this);
-    }
-  }
-
-  /**
-   * Set the function that is called when this image  is clicked.
-   * @param func The function that is called when the image is clicked, or null
-   *     to remove.
-   */
-  setOnClickHandler(func: ((p1: FieldImage) => AnyDuringMigration)|null) {
-    this.clickHandler_ = func;
-  }
-
-  /**
-   * Use the `getText_` developer hook to override the field's text
-   * representation.
-   * Return the image alt text instead.
-   * @return The image alt text.
-   */
-  protected override getText_(): string|null {
-    return this.altText_;
-  }
-
-  /**
-   * Construct a FieldImage from a JSON arg object,
-   * dereferencing any string table references.
-   * @param options A JSON object with options (src, width, height, alt, and
-   *     flipRtl).
-   * @return The new field instance.
-   * @nocollapse
-   * @internal
-   */
-  static fromJson(options: FieldImageFromJsonConfig): FieldImage {
-    if (!options.src || !options.width || !options.height) {
-      throw new Error(
-          'src, width, and height values for an image field are' +
-          'required. The width and height must be non-zero.');
-    }
-    // `this` might be a subclass of FieldImage if that class doesn't override
-    // the static fromJson method.
-    return new this(
-        options.src, options.width, options.height, undefined, undefined,
-        undefined, options);
-  }
-}
-
-fieldRegistry.register('field_image', FieldImage);
-
-(FieldImage.prototype as AnyDuringMigration).DEFAULT_VALUE = '';
-
-/**
- * Config options for the image field.
- */
-export interface FieldImageConfig extends FieldConfig {
-  flipRtl?: boolean;
-  alt?: string;
-}
-
-/**
- * fromJson config options for the colour field.
- */
-export interface FieldImageFromJsonConfig extends FieldImageConfig {
-  src?: string;
-  width?: number;
-  height?: number;
-}

package/core/field_label.ts

@@ -1,152 +0,0 @@
-/**
- * @license
- * Copyright 2012 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Non-editable, non-serializable text field.  Used for titles,
- *    labels, etc.
- */
-
-/**
- * Non-editable, non-serializable text field.  Used for titles,
- *    labels, etc.
- * @class
- */
-import * as goog from '../closure/goog/goog.js';
-goog.declareModuleId('Blockly.FieldLabel');
-
-import {FieldConfig, Field} from './field.js';
-import * as fieldRegistry from './field_registry.js';
-import * as dom from './utils/dom.js';
-import * as parsing from './utils/parsing.js';
-import type {Sentinel} from './utils/sentinel.js';
-
-
-/**
- * Class for a non-editable, non-serializable text field.
- * @alias Blockly.FieldLabel
- */
-export class FieldLabel extends Field {
-  /** The html class name to use for this field. */
-  private class_: string|null = null;
-
-  /**
-   * Editable fields usually show some sort of UI indicating they are
-   * editable. This field should not.
-   */
-  override EDITABLE = false;
-
-  /**
-   * @param 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 opt_class Optional CSS class for the field's text.
-   * @param 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.
-   */
-  constructor(
-      opt_value?: string|Sentinel, opt_class?: string,
-      opt_config?: FieldLabelConfig) {
-    super(Field.SKIP_SETUP);
-
-    if (opt_value === Field.SKIP_SETUP) {
-      return;
-    }
-    if (opt_config) {
-      this.configure_(opt_config);
-    } else {
-      this.class_ = opt_class || null;
-    }
-    this.setValue(opt_value);
-  }
-
-  protected override configure_(config: FieldLabelConfig) {
-    super.configure_(config);
-    if (config.class) this.class_ = config.class;
-  }
-
-  /**
-   * Create block UI for this label.
-   * @internal
-   */
-  override initView() {
-    this.createTextElement_();
-    if (this.class_) {
-      dom.addClass((this.textElement_), this.class_);
-    }
-  }
-
-  /**
-   * Ensure that the input value casts to a valid string.
-   * @param opt_newValue The input value.
-   * @return A valid string, or null if invalid.
-   */
-  protected override doClassValidation_(opt_newValue?: AnyDuringMigration):
-      string|null {
-    if (opt_newValue === null || opt_newValue === undefined) {
-      return null;
-    }
-    return String(opt_newValue);
-  }
-
-  /**
-   * Set the CSS class applied to the field's textElement_.
-   * @param cssClass The new CSS class name, or null to remove.
-   */
-  setClass(cssClass: string|null) {
-    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;
-  }
-
-  /**
-   * Construct a FieldLabel from a JSON arg object,
-   * dereferencing any string table references.
-   * @param options A JSON object with options (text, and class).
-   * @return The new field instance.
-   * @nocollapse
-   * @internal
-   */
-  static fromJson(options: FieldLabelFromJsonConfig): FieldLabel {
-    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);
-  }
-}
-
-fieldRegistry.register('field_label', FieldLabel);
-
-(FieldLabel.prototype as AnyDuringMigration).DEFAULT_VALUE = '';
-
-// clang-format off
-// Clang does not like the 'class' keyword being used as a property.
-/**
- * Config options for the label field.
- */
-export interface FieldLabelConfig extends FieldConfig {
-  class?: string;
-}
-// clang-format on
-
-
-/**
- * fromJson config options for the label field.
- */
-export interface FieldLabelFromJsonConfig extends FieldLabelConfig {
-  text?: string;
-}

package/core/field_label_serializable.ts

@@ -1,76 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Non-editable, serializable text field. Behaves like a
- *    normal label but is serialized to XML. It may only be
- *    edited programmatically.
- */
-
-/**
- * Non-editable, serializable text field. Behaves like a
- *    normal label but is serialized to XML. It may only be
- *    edited programmatically.
- * @class
- */
-import * as goog from '../closure/goog/goog.js';
-goog.declareModuleId('Blockly.FieldLabelSerializable');
-
-import {FieldLabelConfig, FieldLabelFromJsonConfig, FieldLabel} from './field_label.js';
-import * as fieldRegistry from './field_registry.js';
-import * as parsing from './utils/parsing.js';
-
-
-/**
- * Class for a non-editable, serializable text field.
- * @alias Blockly.FieldLabelSerializable
- */
-export class FieldLabelSerializable extends FieldLabel {
-  /**
-   * Editable fields usually show some sort of UI indicating they are
-   * editable. This field should not.
-   */
-  override EDITABLE = false;
-
-  /**
-   * Serializable fields are saved by the XML renderer, non-serializable
-   * fields are not.  This field should be serialized, but only edited
-   * programmatically.
-   */
-  override SERIALIZABLE = true;
-
-  /**
-   * @param opt_value The initial value of the field. Should cast to a string.
-   *     Defaults to an empty string if null or undefined.
-   * @param opt_class Optional CSS class for the field's text.
-   * @param 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?: string, opt_class?: string, opt_config?: FieldLabelConfig) {
-    super(String(opt_value ?? ''), opt_class, opt_config);
-  }
-
-  /**
-   * Construct a FieldLabelSerializable from a JSON arg object,
-   * dereferencing any string table references.
-   * @param options A JSON object with options (text, and class).
-   * @return The new field instance.
-   * @nocollapse
-   * @internal
-   */
-  static override fromJson(options: FieldLabelFromJsonConfig):
-      FieldLabelSerializable {
-    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);