CodingPirates/blockly
1
0
Fork 0
mirror of https://github.com/google/blockly.git synced 2026-01-09 01:50:11 +01:00
Code Issues Packages Projects Releases Wiki Activity

Improving field validator docs (PR #2018)

Browse Source 
Merge pull request #2018 from AnmAtAnm/field-validator-doc
This commit is contained in:
Andrew n marshall
2018-08-23 10:57:19 -07:00
committed by GitHub
parent 30ce093cd2 26903a8ca5
commit 57aa2e966b
1 changed files with 15 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
core/field.js
View File

@@ -40,10 +40,8 @@ goog.require('goog.userAgent');
/**
* Abstract class for an editable field.
* @param {string} text The initial content of the field.
* @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.
* @param {function(string):(string|null|undefined)=} opt_validator An optional
* function that is called to validate user input. See setValidator().
* @constructor
*/
Blockly.Field = function(text, opt_validator) {
@@ -291,15 +289,25 @@ Blockly.Field.prototype.setVisible = function(visible) {
};
/**
* Sets a new validation function for editable fields.
* @param {Function} handler New validation function, or null.
* Sets a new validation function for editable fields, or clears a previously
* set validator.
*
* The validator function takes in the text form of the users input, and
* optionally returns the accepted field text. Alternatively, if the function
* returns null, the field value change aborts. If the function does not return
* anything (or returns undefined), the input value is accepted as valid. This
* is a shorthand for fields using the validator function call as a field-level
* change event notification.
*
* @param {?function(string):(string|null|undefined)} handler The validator
* function or null to clear a previous validator.
*/
Blockly.Field.prototype.setValidator = function(handler) {
this.validator_ = handler;
};
/**
* Gets the validation function for editable fields.
* Gets the validation function for editable fields, or null if not set.
* @return {Function} Validation function, or null.
*/
Blockly.Field.prototype.getValidator = function() {