From 868bcc90ba6eb1469ff4b9f211b1343046d1d5b4 Mon Sep 17 00:00:00 2001
From: David Monjoie <dmo@odoo.com>
Date: Tue, 14 Mar 2017 11:01:18 +0100
Subject: [ADD] web: add text field documentation

---
 addons/web/static/src/js/fields/basic_fields.js | 31 +++++++++++++++++++++----
 1 file changed, 27 insertions(+), 4 deletions(-)

(limited to 'addons/web/static/src/js/fields/basic_fields.js')

diff --git a/addons/web/static/src/js/fields/basic_fields.js b/addons/web/static/src/js/fields/basic_fields.js
index bd2d350385b..183ce3104db 100644
--- a/addons/web/static/src/js/fields/basic_fields.js
+++ b/addons/web/static/src/js/fields/basic_fields.js
@@ -480,15 +480,20 @@ var FieldText = AbstractField.extend({
         },
     }),
     supportedFieldTypes: ['text'],
+
+    /**
+     * In edit mode, the text widget contains a textarea. We append it in
+     * start() instead of _renderEdit() to keep the same textarea even
+     * if several _renderEdit are done. This allows to keep the cursor
+     * position and to autoresize only once.
+     *
+     * @override
+     */
     start: function () {
         this.$el.addClass('o_list_text o_form_textarea');
         this.$el.attr('id', this.idForLabel);
 
         if (this.mode === 'edit') {
-            // in edit mode, the widget contains a textarea. We append it in
-            // start() instead of _renderEdit() to keep the same textarea even
-            // if several _renderEdit are done. This allows to keep the cursor
-            // position and to autoresize only once
             this.$textarea = $('<textarea>').appendTo(this.$el);
             if (this.attrs.placeholder) {
                 this.$textarea.attr('placeholder', this.attrs.placeholder);
@@ -503,6 +508,11 @@ var FieldText = AbstractField.extend({
     // Public
     //--------------------------------------------------------------------------
 
+    /**
+     * Automatically selects the content of the field.
+     *
+     * @override
+     */
     activate: function () {
         var $textarea = this.$('textarea');
         $textarea.focus();
@@ -513,9 +523,22 @@ var FieldText = AbstractField.extend({
     // Private
     //--------------------------------------------------------------------------
 
+    /**
+     * Format the value and put it in the textarea.
+     *
+     * @override
+     * @private
+     */
     _renderEdit: function () {
         this.$textarea.val(this._formatValue(this.value));
     },
+
+    /**
+     * Format the value and display it.
+     *
+     * @override
+     * @private
+     */
     _renderReadonly: function () {
         this.$el.empty().text(this._formatValue(this.value));
     },
-- 
cgit v1.2.3