summaryrefslogtreecommitdiff
path: root/blockly/core/field_number.js
diff options
context:
space:
mode:
Diffstat (limited to 'blockly/core/field_number.js')
-rw-r--r--blockly/core/field_number.js101
1 files changed, 101 insertions, 0 deletions
diff --git a/blockly/core/field_number.js b/blockly/core/field_number.js
new file mode 100644
index 0000000..f72e7f0
--- /dev/null
+++ b/blockly/core/field_number.js
@@ -0,0 +1,101 @@
+/**
+ * @license
+ * Visual Blocks Editor
+ *
+ * Copyright 2016 Google Inc.
+ * https://developers.google.com/blockly/
+ *
+ * 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 Number input field
+ * @author fenichel@google.com (Rachel Fenichel)
+ */
+'use strict';
+
+goog.provide('Blockly.FieldNumber');
+
+goog.require('Blockly.FieldTextInput');
+goog.require('goog.math');
+
+/**
+ * Class for an editable number field.
+ * @param {number|string} value The initial content of the field.
+ * @param {number|string|undefined} opt_min Minimum value.
+ * @param {number|string|undefined} opt_max Maximum value.
+ * @param {number|string|undefined} opt_precision Precision for value.
+ * @param {Function=} opt_validator An optional function that is called
+ * to validate any constraints on what the user entered. Takes the new
+ * text as an argument and returns either the accepted text, a replacement
+ * text, or null to abort the change.
+ * @extends {Blockly.FieldTextInput}
+ * @constructor
+ */
+Blockly.FieldNumber =
+ function(value, opt_min, opt_max, opt_precision, opt_validator) {
+ value = String(value);
+ Blockly.FieldNumber.superClass_.constructor.call(this, value, opt_validator);
+ this.setConstraints(opt_min, opt_max, opt_precision);
+};
+goog.inherits(Blockly.FieldNumber, Blockly.FieldTextInput);
+
+/**
+ * Set the maximum, minimum and precision constraints on this field.
+ * Any of these properties may be undefiend or NaN to be disabled.
+ * Setting precision (usually a power of 10) enforces a minimum step between
+ * values. That is, the user's value will rounded to the closest multiple of
+ * precision. The least significant digit place is inferred from the precision.
+ * Integers values can be enforces by choosing an integer precision.
+ * @param {number|string|undefined} min Minimum value.
+ * @param {number|string|undefined} max Maximum value.
+ * @param {number|string|undefined} precision Precision for value.
+ */
+Blockly.FieldNumber.prototype.setConstraints = function(min, max, precision) {
+ precision = parseFloat(precision);
+ this.precision_ = isNaN(precision) ? 0 : precision;
+ min = parseFloat(min);
+ this.min_ = isNaN(min) ? -Infinity : min;
+ max = parseFloat(max);
+ this.max_ = isNaN(max) ? Infinity : max;
+ this.setValue(this.callValidator(this.getValue()));
+};
+
+/**
+ * Ensure that only a number in the correct range may be entered.
+ * @param {string} text The user's text.
+ * @return {?string} A string representing a valid number, or null if invalid.
+ */
+Blockly.FieldNumber.prototype.classValidator = function(text) {
+ if (text === null) {
+ return null;
+ }
+ text = String(text);
+ // TODO: Handle cases like 'ten', '1.203,14', etc.
+ // 'O' is sometimes mistaken for '0' by inexperienced users.
+ text = text.replace(/O/ig, '0');
+ // Strip out thousands separators.
+ text = text.replace(/,/g, '');
+ var n = parseFloat(text || 0);
+ if (isNaN(n)) {
+ // Invalid number.
+ return null;
+ }
+ // Round to nearest multiple of precision.
+ if (this.precision_ && isFinite(n)) {
+ n = Math.round(n / this.precision_) * this.precision_;
+ }
+ // Get the value in range.
+ n = goog.math.clamp(n, this.min_, this.max_);
+ return String(n);
+};