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

package/core/field.d.ts

@@ -19,6 +19,7 @@ import { Sentinel } from './utils/sentinel.js';
 import { Size } from './utils/size.js';
 /**
  * Abstract class for an editable field.
+ *
  * @alias Blockly.Field
  */
 export declare abstract class Field implements IASTNodeLocationSvg, IASTNodeLocationWithBlock, IKeyboardAccessible, IRegistrable {
@@ -70,6 +71,7 @@ export declare abstract class Field implements IASTNodeLocationSvg, IASTNodeLoca
     protected constants_: ConstantProvider;
     /**
      * Has this field been disposed of?
+     *
      * @internal
      */
     disposed: boolean;
@@ -89,11 +91,13 @@ export declare abstract class Field implements IASTNodeLocationSvg, IASTNodeLoca
     protected clickTarget_: Element;
     /**
      * The prefix field.
+     *
      * @internal
      */
     prefixField: string | null;
     /**
      * The suffix field.
+     *
      * @internal
      */
     suffixField: string | null;
@@ -125,6 +129,7 @@ export declare abstract class Field implements IASTNodeLocationSvg, IASTNodeLoca
     constructor(value: any, opt_validator?: Function | null, opt_config?: FieldConfig);
     /**
      * Process the configuration map passed to the field.
+     *
      * @param config A map of options used to configure the field. See the
      *     individual field's documentation for a list of properties this
      *     parameter supports.
@@ -132,34 +137,40 @@ export declare abstract class Field implements IASTNodeLocationSvg, IASTNodeLoca
     protected configure_(config: FieldConfig): void;
     /**
      * Attach this field to a block.
+     *
      * @param block The block containing this field.
      */
     setSourceBlock(block: Block): void;
     /**
      * Get the renderer constant provider.
-     * @return The renderer constant provider.
+     *
+     * @returns The renderer constant provider.
      */
     getConstants(): ConstantProvider | null;
     /**
      * Get the block this field is attached to.
-     * @return The block containing this field.
+     *
+     * @returns The block containing this field.
      */
     getSourceBlock(): Block;
     /**
      * Initialize everything to render this field. Override
      * methods initModel and initView rather than this method.
-     * @final
+     *
+     * @sealed
      * @internal
      */
     init(): void;
     /**
      * Create the block UI for this field.
+     *
      * @internal
      */
     initView(): void;
     /**
      * Initializes the model of the field after it has been installed on a block.
      * No-op by default.
+     *
      * @internal
      */
     initModel(): void;
@@ -183,31 +194,35 @@ export declare abstract class Field implements IASTNodeLocationSvg, IASTNodeLoca
     /**
      * Sets the field's value based on the given XML element. Should only be
      * called by Blockly.Xml.
+     *
      * @param fieldElement The element containing info about the field's state.
      * @internal
      */
     fromXml(fieldElement: Element): void;
     /**
      * Serializes this field's value to XML. Should only be called by Blockly.Xml.
+     *
      * @param fieldElement The element to populate with info about the field's
      *     state.
-     * @return The element containing info about the field's state.
+     * @returns The element containing info about the field's state.
      * @internal
      */
     toXml(fieldElement: Element): Element;
     /**
      * Saves this fields value as something which can be serialized to JSON.
      * Should only be called by the serialization system.
+     *
      * @param _doFullSerialization If true, this signals to the field that if it
      *     normally just saves a reference to some state (eg variable fields) it
      *     should instead serialize the full state of the thing being referenced.
-     * @return JSON serializable state.
+     * @returns JSON serializable state.
      * @internal
      */
     saveState(_doFullSerialization?: boolean): any;
     /**
      * Sets the field's state based on the given state value. Should only be
      * called by the serialization system.
+     *
      * @param state The state we want to apply to the field.
      * @internal
      */
@@ -216,22 +231,25 @@ export declare abstract class Field implements IASTNodeLocationSvg, IASTNodeLoca
      * Returns a stringified version of the XML state, if it should be used.
      * Otherwise this returns null, to signal the field should use its own
      * serialization.
+     *
      * @param callingClass The class calling this method.
      *     Used to see if `this` has overridden any relevant hooks.
-     * @return The stringified version of the XML state, or null.
+     * @returns The stringified version of the XML state, or null.
      */
     protected saveLegacyState(callingClass: any): string | null;
     /**
      * Loads the given state using either the old XML hooks, if they should be
      * used. Returns true to indicate loading has been handled, false otherwise.
+     *
      * @param callingClass The class calling this method.
      *     Used to see if `this` has overridden any relevant hooks.
      * @param state The state to apply to the field.
-     * @return Whether the state was applied or not.
+     * @returns Whether the state was applied or not.
      */
     loadLegacyState(callingClass: any, state: any): boolean;
     /**
      * Dispose of all DOM objects and events belonging to this editable field.
+     *
      * @internal
      */
     dispose(): void;
@@ -240,42 +258,49 @@ export declare abstract class Field implements IASTNodeLocationSvg, IASTNodeLoca
     /**
      * Set whether this field's value can be changed using the editor when the
      *     source block is editable.
+     *
      * @param enabled True if enabled.
      */
     setEnabled(enabled: boolean): void;
     /**
      * Check whether this field's value can be changed using the editor when the
      *     source block is editable.
-     * @return Whether this field is enabled.
+     *
+     * @returns Whether this field is enabled.
      */
     isEnabled(): boolean;
     /**
      * Check whether this field defines the showEditor_ function.
-     * @return Whether this field is clickable.
+     *
+     * @returns Whether this field is clickable.
      */
     isClickable(): boolean;
     /**
      * Check whether this field is currently editable.  Some fields are never
      * EDITABLE (e.g. text labels). Other fields may be EDITABLE but may exist on
      * non-editable blocks or be currently disabled.
-     * @return Whether this field is currently enabled, editable and on an
+     *
+     * @returns Whether this field is currently enabled, editable and on an
      *     editable block.
      */
     isCurrentlyEditable(): boolean;
     /**
      * Check whether this field should be serialized by the XML renderer.
      * Handles the logic for backwards compatibility and incongruous states.
-     * @return Whether this field should be serialized or not.
+     *
+     * @returns Whether this field should be serialized or not.
      */
     isSerializable(): boolean;
     /**
      * Gets whether this editable field is visible or not.
-     * @return True if visible.
+     *
+     * @returns True if visible.
      */
     isVisible(): boolean;
     /**
      * Sets whether this editable field is visible or not. Should only be called
      * by input.setVisible.
+     *
      * @param visible True if visible.
      * @internal
      */
@@ -298,18 +323,21 @@ export declare abstract class Field implements IASTNodeLocationSvg, IASTNodeLoca
     setValidator(handler: Function): void;
     /**
      * Gets the validation function for editable fields, or null if not set.
-     * @return Validation function, or null.
+     *
+     * @returns Validation function, or null.
      */
     getValidator(): Function | null;
     /**
      * Gets the group element for this editable field.
      * Used for measuring the size and for positioning.
-     * @return The group element.
+     *
+     * @returns The group element.
      */
     getSvgRoot(): SVGGElement;
     /**
      * Updates the field to match the colour/style of the block. Should only be
      * called by BlockSvg.applyColour().
+     *
      * @internal
      */
     applyColour(): void;
@@ -323,27 +351,31 @@ export declare abstract class Field implements IASTNodeLocationSvg, IASTNodeLoca
     /**
      * Calls showEditor_ when the field is clicked if the field is clickable.
      * Do not override.
+     *
      * @param opt_e Optional mouse event that triggered the field to open, or
      *     undefined if triggered programmatically.
-     * @final
+     * @sealed
      * @internal
      */
     showEditor(opt_e?: Event): void;
     /**
      * A developer hook to create an editor for the field. This is no-op by
      * default, and must be overriden to create an editor.
+     *
      * @param _e Optional mouse event that triggered the field to open, or
      *     undefined if triggered programmatically.
      */
     protected showEditor_(_e?: Event): void;
     /**
      * Updates the size of the field based on the text.
+     *
      * @param opt_margin margin to use when positioning the text element.
      */
     protected updateSize_(opt_margin?: number): void;
     /**
      * Position a field's text element after a size change.  This handles both LTR
      * and RTL positioning.
+     *
      * @param xOffset x offset to use when positioning the text element.
      * @param contentWidth The content width.
      */
@@ -354,29 +386,33 @@ export declare abstract class Field implements IASTNodeLocationSvg, IASTNodeLoca
      * Returns the height and width of the field.
      *
      * This should *in general* be the only place render_ gets called from.
-     * @return Height and width.
+     *
+     * @returns Height and width.
      */
     getSize(): Size;
     /**
      * Returns the bounding box of the rendered field, accounting for workspace
      * scaling.
-     * @return An object with top, bottom, left, and right in pixels relative to
+     *
+     * @returns An object with top, bottom, left, and right in pixels relative to
      *     the top left corner of the page (window coordinates).
      * @internal
      */
     getScaledBBox(): Rect;
     /**
      * Get the text from this field to display on the block. May differ from
-     * ``getText`` due to ellipsis, and other formatting.
-     * @return Text to display.
+     * `getText` due to ellipsis, and other formatting.
+     *
+     * @returns Text to display.
      */
     protected getDisplayText_(): string;
     /**
      * Get the text from this field.
      * Override getText_ to provide a different behavior than simply casting the
      * value to a string.
-     * @return Current text.
-     * @final
+     *
+     * @returns Current text.
+     * @sealed
      */
     getText(): string;
     /**
@@ -384,7 +420,8 @@ export declare abstract class Field implements IASTNodeLocationSvg, IASTNodeLoca
      * Override if the text representation of the value of this field
      * is not just a string cast of its value.
      * Return null to resort to a string cast.
-     * @return Current text or null.
+     *
+     * @returns Current text or null.
      */
     protected getText_(): string | null;
     /**
@@ -392,6 +429,7 @@ export declare abstract class Field implements IASTNodeLocationSvg, IASTNodeLoca
      * rerender this field and adjust for any sizing changes.
      * Other fields on the same block will not rerender, because their sizes have
      * already been recorded.
+     *
      * @internal
      */
     markDirty(): void;
@@ -400,6 +438,7 @@ export declare abstract class Field implements IASTNodeLocationSvg, IASTNodeLoca
      * rerender this field and adjust for any sizing changes.
      * Other fields on the same block will not rerender, because their sizes have
      * already been recorded.
+     *
      * @internal
      */
     forceRerender(): void;
@@ -407,32 +446,37 @@ export declare abstract class Field implements IASTNodeLocationSvg, IASTNodeLoca
      * Used to change the value of the field. Handles validation and events.
      * Subclasses should override doClassValidation_ and doValueUpdate_ rather
      * than this method.
+     *
      * @param newValue New value.
-     * @final
+     * @sealed
      */
     setValue(newValue: any): void;
     /**
      * Process the result of validation.
+     *
      * @param newValue New value.
      * @param validatedValue Validated value.
-     * @return New value, or an Error object.
+     * @returns New value, or an Error object.
      */
     private processValidation_;
     /**
      * Get the current value of the field.
-     * @return Current value.
+     *
+     * @returns Current value.
      */
     getValue(): any;
     /**
      * Used to validate a value. Returns input by default. Can be overridden by
      * subclasses, see FieldDropdown.
+     *
      * @param opt_newValue The value to be validated.
-     * @return The validated value, same as input by default.
+     * @returns The validated value, same as input by default.
      */
     protected doClassValidation_(opt_newValue?: any): any;
     /**
      * Used to update the value of a field. Can be overridden by subclasses to do
      * custom storage of values/updating of external things.
+     *
      * @param newValue The value to be saved.
      */
     protected doValueUpdate_(newValue: any): void;
@@ -440,16 +484,19 @@ export declare abstract class Field implements IASTNodeLocationSvg, IASTNodeLoca
      * Used to notify the field an invalid value was input. Can be overridden by
      * subclasses, see FieldTextInput.
      * No-op by default.
+     *
      * @param _invalidValue The input value that was determined to be invalid.
      */
     protected doValueInvalid_(_invalidValue: any): void;
     /**
      * Handle a mouse down event on a field.
+     *
      * @param e Mouse down event.
      */
     protected onMouseDown_(e: Event): void;
     /**
      * Sets the tooltip for this field.
+     *
      * @param newTip The text for the tooltip, a function that returns the text
      *     for the tooltip, a parent object whose tooltip will be used, or null to
      *     display the tooltip of the parent block. To not display a tooltip pass
@@ -458,67 +505,78 @@ export declare abstract class Field implements IASTNodeLocationSvg, IASTNodeLoca
     setTooltip(newTip: Tooltip.TipInfo | null): void;
     /**
      * Returns the tooltip text for this field.
-     * @return The tooltip text for this field.
+     *
+     * @returns The tooltip text for this field.
      */
     getTooltip(): string;
     /**
      * The element to bind the click handler to. If not set explicitly, defaults
      * to the SVG root of the field. When this element is
      * clicked on an editable field, the editor will open.
-     * @return Element to bind click handler to.
+     *
+     * @returns Element to bind click handler to.
      */
     protected getClickTarget_(): Element;
     /**
      * Return the absolute coordinates of the top-left corner of this field.
      * The origin (0,0) is the top-left corner of the page body.
-     * @return Object with .x and .y properties.
+     *
+     * @returns Object with .x and .y properties.
      */
     protected getAbsoluteXY_(): Coordinate;
     /**
      * Whether this field references any Blockly variables.  If true it may need
      * to be handled differently during serialization and deserialization.
      * Subclasses may override this.
-     * @return True if this field has any variable references.
+     *
+     * @returns True if this field has any variable references.
      * @internal
      */
     referencesVariables(): boolean;
     /**
      * Refresh the variable name referenced by this field if this field references
      * variables.
+     *
      * @internal
      */
     refreshVariableName(): void;
     /**
      * Search through the list of inputs and their fields in order to find the
      * parent input of a field.
-     * @return The input that the field belongs to.
+     *
+     * @returns The input that the field belongs to.
      * @internal
      */
     getParentInput(): Input;
     /**
      * Returns whether or not we should flip the field in RTL.
-     * @return True if we should flip in RTL.
+     *
+     * @returns True if we should flip in RTL.
      */
     getFlipRtl(): boolean;
     /**
      * Returns whether or not the field is tab navigable.
-     * @return True if the field is tab navigable.
+     *
+     * @returns True if the field is tab navigable.
      */
     isTabNavigable(): boolean;
     /**
      * Handles the given keyboard shortcut.
+     *
      * @param _shortcut The shortcut to be handled.
-     * @return True if the shortcut has been handled, false otherwise.
+     * @returns True if the shortcut has been handled, false otherwise.
      */
     onShortcut(_shortcut: KeyboardShortcut): boolean;
     /**
      * Add the cursor SVG to this fields SVG group.
+     *
      * @param cursorSvg The SVG root of the cursor to be added to the field group.
      * @internal
      */
     setCursorSvg(cursorSvg: SVGElement): void;
     /**
      * Add the marker SVG to this fields SVG group.
+     *
      * @param markerSvg The SVG root of the marker to be added to the field group.
      * @internal
      */
@@ -532,3 +590,4 @@ export declare abstract class Field implements IASTNodeLocationSvg, IASTNodeLoca
 export interface FieldConfig {
     tooltip?: string;
 }
+//# sourceMappingURL=field.d.ts.map

package/core/field_angle.d.ts

@@ -7,6 +7,7 @@ import { FieldTextInputConfig, FieldTextInput } from './field_textinput.js';
 import type { Sentinel } from './utils/sentinel.js';
 /**
  * Class for an editable angle field.
+ *
  * @alias Blockly.FieldAngle
  */
 export declare class FieldAngle extends FieldTextInput {
@@ -78,11 +79,13 @@ export declare class FieldAngle extends FieldTextInput {
     constructor(opt_value?: string | number | Sentinel, opt_validator?: Function, opt_config?: FieldAngleConfig);
     /**
      * Configure the field based on the given map of options.
+     *
      * @param config A map of options to configure the field based on.
      */
     protected configure_(config: FieldAngleConfig): void;
     /**
      * Create the block UI for this field.
+     *
      * @internal
      */
     initView(): void;
@@ -90,6 +93,7 @@ export declare class FieldAngle extends FieldTextInput {
     protected render_(): void;
     /**
      * Create and show the angle field's editor.
+     *
      * @param opt_e Optional mouse event that triggered the field to open, or
      *     undefined if triggered programmatically.
      */
@@ -102,6 +106,7 @@ export declare class FieldAngle extends FieldTextInput {
     private hide_;
     /**
      * Set the angle to match the mouse's position.
+     *
      * @param e Mouse move event.
      */
     protected onMouseMove_(e: Event): void;
@@ -109,6 +114,7 @@ export declare class FieldAngle extends FieldTextInput {
      * Handles and displays values that are input via mouse or arrow key input.
      * These values need to be rounded and wrapped before being displayed so
      * that the text input's value is appropriate.
+     *
      * @param angle New angle.
      */
     private displayMouseOrKeyboardValue_;
@@ -116,25 +122,29 @@ export declare class FieldAngle extends FieldTextInput {
     private updateGraph_;
     /**
      * Handle key down to the editor.
+     *
      * @param e Keyboard event.
      */
     protected onHtmlInputKeyDown_(e: Event): void;
     /**
      * Ensure that the input value is a valid angle.
+     *
      * @param opt_newValue The input value.
-     * @return A valid angle, or null if invalid.
+     * @returns A valid angle, or null if invalid.
      */
     protected doClassValidation_(opt_newValue?: any): number | null;
     /**
      * Wraps the value so that it is in the range (-360 + wrap, wrap).
+     *
      * @param value The value to wrap.
-     * @return The wrapped value.
+     * @returns The wrapped value.
      */
     private wrapValue_;
     /**
      * Construct a FieldAngle from a JSON arg object.
+     *
      * @param options A JSON object with options (angle).
-     * @return The new field instance.
+     * @returns The new field instance.
      * @nocollapse
      * @internal
      */
@@ -174,3 +184,4 @@ export interface FieldAngleConfig extends FieldTextInputConfig {
 export interface FieldAngleFromJsonConfig extends FieldAngleConfig {
     angle?: number;
 }
+//# sourceMappingURL=field_angle.d.ts.map

package/core/field_checkbox.d.ts

@@ -8,6 +8,7 @@ import { FieldConfig, Field } from './field.js';
 import type { Sentinel } from './utils/sentinel.js';
 /**
  * Class for a checkbox field.
+ *
  * @alias Blockly.FieldCheckbox
  */
 export declare class FieldCheckbox extends Field {
@@ -41,17 +42,20 @@ export declare class FieldCheckbox extends Field {
     constructor(opt_value?: string | boolean | Sentinel, opt_validator?: Function, opt_config?: FieldCheckboxConfig);
     /**
      * Configure the field based on the given map of options.
+     *
      * @param config A map of options to configure the field based on.
      */
     protected configure_(config: FieldCheckboxConfig): void;
     /**
      * Saves this field's value.
-     * @return The boolean value held by this field.
+     *
+     * @returns The boolean value held by this field.
      * @internal
      */
     saveState(): any;
     /**
      * Create the block UI for this checkbox.
+     *
      * @internal
      */
     initView(): void;
@@ -59,6 +63,7 @@ export declare class FieldCheckbox extends Field {
     getDisplayText_(): string;
     /**
      * Set the character used for the check mark.
+     *
      * @param character The character to use for the check mark, or null to use
      *     the default.
      */
@@ -67,29 +72,34 @@ export declare class FieldCheckbox extends Field {
     protected showEditor_(): void;
     /**
      * Ensure that the input value is valid ('TRUE' or 'FALSE').
+     *
      * @param opt_newValue The input value.
-     * @return A valid value ('TRUE' or 'FALSE), or null if invalid.
+     * @returns A valid value ('TRUE' or 'FALSE), or null if invalid.
      */
     protected doClassValidation_(opt_newValue?: any): string | null;
     /**
      * Update the value of the field, and update the checkElement.
+     *
      * @param newValue The value to be saved. The default validator guarantees
      *     that this is a either 'TRUE' or 'FALSE'.
      */
     protected doValueUpdate_(newValue: any): void;
     /**
      * Get the value of this field, either 'TRUE' or 'FALSE'.
-     * @return The value of this field.
+     *
+     * @returns The value of this field.
      */
     getValue(): string;
     /**
      * Get the boolean value of this field.
-     * @return The boolean value of this field.
+     *
+     * @returns The boolean value of this field.
      */
     getValueBoolean(): boolean;
     /**
      * Get the text of this field. Used when the block is collapsed.
-     * @return Text representing the value of this field ('true' or 'false').
+     *
+     * @returns Text representing the value of this field ('true' or 'false').
      */
     getText(): string;
     /**
@@ -97,14 +107,16 @@ export declare class FieldCheckbox extends Field {
      *
      * Converts 'TRUE' to true and 'FALSE' to false correctly, everything else
      * is cast to a boolean.
+     *
      * @param value The value to convert.
-     * @return The converted value.
+     * @returns The converted value.
      */
     private convertValueToBool_;
     /**
      * Construct a FieldCheckbox from a JSON arg object.
+     *
      * @param options A JSON object with options (checked).
-     * @return The new field instance.
+     * @returns The new field instance.
      * @nocollapse
      * @internal
      */
@@ -122,3 +134,4 @@ export interface FieldCheckboxConfig extends FieldConfig {
 export interface FieldCheckboxFromJsonConfig extends FieldCheckboxConfig {
     checked?: boolean;
 }
+//# sourceMappingURL=field_checkbox.d.ts.map