mirror of
https://github.com/google/blockly.git
synced 2026-01-10 10:27:08 +01:00
* Google changed from an Inc to an LLC. This happened back in 2017 but we didn’t notice. Officially we should update files from Inc to LLC when they are changed as part of regular edits, but this is a nightmare to remember for the next decade. * Remove project description/titles from licenses This is no longer part of Google’s header requirements. Our existing descriptions were useless (“Visual Blocks Editor”) or grossly obselete (“Visual Blocks Language”). * License no longer requires URL. * Fix license regexps.
83 lines
2.9 KiB
JavaScript
83 lines
2.9 KiB
JavaScript
/**
|
|
* @license
|
|
* Copyright 2019 Google LLC
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
/**
|
|
* @fileoverview Non-editable, serializable text field. Behaves like a
|
|
* normal label but is serialized to XML. It may only be
|
|
* edited programmatically.
|
|
*/
|
|
'use strict';
|
|
|
|
goog.provide('Blockly.FieldLabelSerializable');
|
|
|
|
goog.require('Blockly.FieldLabel');
|
|
goog.require('Blockly.fieldRegistry');
|
|
goog.require('Blockly.utils');
|
|
goog.require('Blockly.utils.object');
|
|
|
|
|
|
/**
|
|
* 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 {Blockly.FieldLabel}
|
|
* @constructor
|
|
*
|
|
*/
|
|
Blockly.FieldLabelSerializable = function(opt_value, opt_class, opt_config) {
|
|
Blockly.FieldLabelSerializable.superClass_.constructor.call(
|
|
this, opt_value, opt_class, opt_config);
|
|
};
|
|
Blockly.utils.object.inherits(Blockly.FieldLabelSerializable,
|
|
Blockly.FieldLabel);
|
|
|
|
/**
|
|
* 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 {!Blockly.FieldLabelSerializable} The new field instance.
|
|
* @package
|
|
* @nocollapse
|
|
*/
|
|
Blockly.FieldLabelSerializable.fromJson = function(options) {
|
|
var text = Blockly.utils.replaceMessageReferences(options['text']);
|
|
return new Blockly.FieldLabelSerializable(text, undefined, options);
|
|
};
|
|
|
|
/**
|
|
* Editable fields usually show some sort of UI indicating they are
|
|
* editable. This field should not.
|
|
* @type {boolean}
|
|
* @public
|
|
*/
|
|
Blockly.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}
|
|
* @public
|
|
*/
|
|
Blockly.FieldLabelSerializable.prototype.SERIALIZABLE = true;
|
|
|
|
Blockly.fieldRegistry.register(
|
|
'field_label_serializable', Blockly.FieldLabelSerializable);
|