[REF] web: add documentation to form view
This commit is contained in:
Géry Debongnie
committed by
Aaron Bohy
Aaron Bohy
parent
0250e60dd2
commit
47bb855c7e
@@ -267,6 +267,7 @@ var FormController = BasicController.extend({
|
||||
* When the user clicks on a form button, this function determines what
|
||||
* should happen.
|
||||
*
|
||||
* @private
|
||||
* @param {Object} attrs the attrs of the button clicked
|
||||
* @param {Object} [record] the current state of the view
|
||||
* @returns {Deferred}
|
||||
@@ -294,6 +295,7 @@ var FormController = BasicController.extend({
|
||||
},
|
||||
/**
|
||||
* @override method from FieldManagerMixin
|
||||
* @private
|
||||
* @param {string} id it is ignored, because we already know it.
|
||||
* @param {string[]} fields
|
||||
* @param {OdooEvent} event the event that triggered the change
|
||||
@@ -306,6 +308,7 @@ var FormController = BasicController.extend({
|
||||
* When a save operation has been confirmed from the model, this method is
|
||||
* called.
|
||||
*
|
||||
* @private
|
||||
* @override method from field manager mixin
|
||||
* @param {string} id
|
||||
*/
|
||||
@@ -328,6 +331,7 @@ var FormController = BasicController.extend({
|
||||
* Helper function to display a warning that some field have an invalid
|
||||
* value. This is used when a save operation cannot be completed.
|
||||
*
|
||||
* @private
|
||||
* @param {string[]} invalidFields list of field names
|
||||
*/
|
||||
_notifyInvalidFields: function (invalidFields) {
|
||||
@@ -346,6 +350,7 @@ var FormController = BasicController.extend({
|
||||
* client to add it in the url, for example.
|
||||
*
|
||||
* @override method from AbstractController
|
||||
* @private
|
||||
* @param {Object} [state]
|
||||
*/
|
||||
_pushState: function (state) {
|
||||
@@ -358,6 +363,7 @@ var FormController = BasicController.extend({
|
||||
* Change the view mode to 'edit'
|
||||
*
|
||||
* @see _toReadOnlyMode
|
||||
* @private
|
||||
*/
|
||||
_toEditMode: function () {
|
||||
this.$el.addClass('o_form_editable');
|
||||
@@ -367,6 +373,7 @@ var FormController = BasicController.extend({
|
||||
* Change the view mode to 'readonly'
|
||||
*
|
||||
* @see _toEditMode
|
||||
* @private
|
||||
*/
|
||||
_toReadOnlyMode: function () {
|
||||
this.$el.removeClass('o_form_editable');
|
||||
@@ -376,6 +383,7 @@ var FormController = BasicController.extend({
|
||||
* Updates the controller's title according to the new state
|
||||
*
|
||||
* @override
|
||||
* @private
|
||||
* @param {Object} state
|
||||
* @returns {Deferred}
|
||||
*/
|
||||
@@ -387,7 +395,7 @@ var FormController = BasicController.extend({
|
||||
return this._super.apply(this, arguments);
|
||||
},
|
||||
/**
|
||||
* @todo move this in _update
|
||||
* @private
|
||||
*/
|
||||
_updateButtons: function () {
|
||||
if (this.$buttons) {
|
||||
@@ -400,7 +408,7 @@ var FormController = BasicController.extend({
|
||||
},
|
||||
/**
|
||||
* Show or hide the sidebar according to the actual_mode
|
||||
* @todo move this in _update
|
||||
* @private
|
||||
*/
|
||||
_updateSidebar: function () {
|
||||
if (this.sidebar) {
|
||||
@@ -435,6 +443,8 @@ var FormController = BasicController.extend({
|
||||
},
|
||||
/**
|
||||
* Bounce the 'Edit' button.
|
||||
*
|
||||
* @private
|
||||
*/
|
||||
_onBounceEdit: function () {
|
||||
if (this.$buttons) {
|
||||
@@ -444,6 +454,8 @@ var FormController = BasicController.extend({
|
||||
/**
|
||||
* If the user clicks on 'Discard', we have to check if the changes can be
|
||||
* discarded, then actually do it.
|
||||
*
|
||||
* @private
|
||||
*/
|
||||
_onDiscardChange: function () {
|
||||
var self = this;
|
||||
@@ -458,6 +470,8 @@ var FormController = BasicController.extend({
|
||||
},
|
||||
/**
|
||||
* Called when the user clicks on 'Duplicate Record' in the sidebar
|
||||
*
|
||||
* @private
|
||||
*/
|
||||
_onDuplicateRecord: function () {
|
||||
var self = this;
|
||||
@@ -475,6 +489,7 @@ var FormController = BasicController.extend({
|
||||
* come from widgets that are editable even in readonly (e.g. Priority).
|
||||
*
|
||||
* @override
|
||||
* @private
|
||||
* @param {OdooEvent} event
|
||||
*/
|
||||
_onFieldChanged: function (event) {
|
||||
@@ -484,6 +499,7 @@ var FormController = BasicController.extend({
|
||||
this._super.apply(this, arguments);
|
||||
},
|
||||
/**
|
||||
* @private
|
||||
* @param {OdooEvent} event
|
||||
*/
|
||||
_onButtonClicked: function (event) {
|
||||
@@ -522,6 +538,7 @@ var FormController = BasicController.extend({
|
||||
/**
|
||||
* Open a record in a form view dialog
|
||||
*
|
||||
* @private
|
||||
* @param {OdooEvent} event
|
||||
*/
|
||||
_onOpenRecord: function (event) {
|
||||
@@ -556,6 +573,7 @@ var FormController = BasicController.extend({
|
||||
* This method is called when someone tries to sort a column, most likely
|
||||
* in a x2many list view
|
||||
*
|
||||
* @private
|
||||
* @param {OdooEvent} event
|
||||
*/
|
||||
_onToggleColumnOrder: function (event) {
|
||||
|
||||
@@ -150,6 +150,7 @@ return BasicRenderer.extend({
|
||||
/**
|
||||
* Adds the adequate classnames to a field widget's $el.
|
||||
*
|
||||
* @private
|
||||
* @param {Object} widget a field widget
|
||||
* @param {Object} field description of the field
|
||||
*/
|
||||
@@ -162,6 +163,11 @@ return BasicRenderer.extend({
|
||||
widget.$el.addClass('o_form_field_empty');
|
||||
}
|
||||
},
|
||||
/**
|
||||
* @private
|
||||
* @param {jQueryElement} $el
|
||||
* @param {Object} node
|
||||
*/
|
||||
_addOnClickAction: function ($el, node) {
|
||||
var self = this;
|
||||
$el.click(function () {
|
||||
@@ -172,6 +178,9 @@ return BasicRenderer.extend({
|
||||
});
|
||||
});
|
||||
},
|
||||
/**
|
||||
* @private
|
||||
*/
|
||||
_evaluateModifiers: function () {
|
||||
var self = this;
|
||||
_.each(this.nodeModifiers, function (d) {
|
||||
@@ -184,6 +193,11 @@ return BasicRenderer.extend({
|
||||
}
|
||||
});
|
||||
},
|
||||
/**
|
||||
* @private
|
||||
* @param {string} name
|
||||
* @returns {string}
|
||||
*/
|
||||
_getIDForLabel: function (name) {
|
||||
var idForLabel = this.idsForLabels[name];
|
||||
if (!idForLabel) {
|
||||
@@ -192,6 +206,12 @@ return BasicRenderer.extend({
|
||||
}
|
||||
return idForLabel;
|
||||
},
|
||||
/**
|
||||
* @private
|
||||
* @param {jQueryElement} $el
|
||||
* @param {Object} node
|
||||
* @param {function} onEvalCallback
|
||||
*/
|
||||
_handleAttributes: function ($el, node, onEvalCallback) {
|
||||
// register the modifiers with their corresponding $el so that they can
|
||||
// be re-evaluated at each field changed
|
||||
@@ -204,6 +224,11 @@ return BasicRenderer.extend({
|
||||
$el.addClass(node.attrs.class);
|
||||
}
|
||||
},
|
||||
/**
|
||||
* @private
|
||||
* @param {Object} node
|
||||
* @returns {jQueryElement}
|
||||
*/
|
||||
_renderButtonBox: function (node) {
|
||||
var $result = $('<' + node.tag + '>', { 'class': 'o_not_full' });
|
||||
// Avoid to show buttons if we are in create mode (edit mode without res_id)
|
||||
@@ -256,6 +281,11 @@ return BasicRenderer.extend({
|
||||
this._handleAttributes($result, node);
|
||||
return $result;
|
||||
},
|
||||
/**
|
||||
* @private
|
||||
* @param {Object} node
|
||||
* @returns {FieldWidget}
|
||||
*/
|
||||
_renderFieldWidget: function (node) {
|
||||
var name = node.attrs.name;
|
||||
var field = this.state.fields[name];
|
||||
@@ -281,6 +311,11 @@ return BasicRenderer.extend({
|
||||
|
||||
return widget;
|
||||
},
|
||||
/**
|
||||
* @private
|
||||
* @param {Object} node
|
||||
* @returns {jQueryElement}
|
||||
*/
|
||||
_renderGenericTag: function (node) {
|
||||
var $result = $('<' + node.tag + '>');
|
||||
_.each(node.attrs, function (attr, name) {
|
||||
@@ -292,6 +327,11 @@ return BasicRenderer.extend({
|
||||
$result.append(_.map(node.children, this._renderNode.bind(this)));
|
||||
return $result;
|
||||
},
|
||||
/**
|
||||
* @private
|
||||
* @param {Object} node
|
||||
* @returns {jQueryElement}
|
||||
*/
|
||||
_renderHeaderButton: function (node) {
|
||||
var $button = $('<button>')
|
||||
.text(node.attrs.string)
|
||||
@@ -300,6 +340,11 @@ return BasicRenderer.extend({
|
||||
this._handleAttributes($button, node);
|
||||
return $button;
|
||||
},
|
||||
/**
|
||||
* @private
|
||||
* @param {Object} node
|
||||
* @returns {jQueryElement}
|
||||
*/
|
||||
_renderInnerField: function (node) {
|
||||
var field = this.state.fields[node.attrs.name];
|
||||
var fieldDescr = node.attrs.string || field.string;
|
||||
@@ -326,6 +371,11 @@ return BasicRenderer.extend({
|
||||
.append($('<td colspan="1">').css(style).append(widget.$el));
|
||||
}
|
||||
},
|
||||
/**
|
||||
* @private
|
||||
* @param {Object} node
|
||||
* @returns {jQueryElement}
|
||||
*/
|
||||
_renderInnerGroup: function (node) {
|
||||
var $result = $('<table class="o_group o_inner_group"/>');
|
||||
this._handleAttributes($result, node);
|
||||
@@ -360,6 +410,13 @@ return BasicRenderer.extend({
|
||||
}
|
||||
return $result;
|
||||
},
|
||||
/**
|
||||
* @private
|
||||
* @param {jQueryElement} $result
|
||||
* @param {string} label
|
||||
* @param {Object} linkedNode
|
||||
* @returns {jQueryElement}
|
||||
*/
|
||||
_renderInnerGroupLabel: function ($result, label, linkedNode) {
|
||||
var $first = $('<td class="o_td_label">')
|
||||
.append(this._renderNode(label));
|
||||
@@ -367,6 +424,12 @@ return BasicRenderer.extend({
|
||||
var $tr = $('<tr>').append($first).append($second);
|
||||
return $result.append($tr);
|
||||
},
|
||||
/**
|
||||
* @private
|
||||
* @param {jQueryElement} $result
|
||||
* @param {Object[]} nodes
|
||||
* @returns {jQueryElement}
|
||||
*/
|
||||
_renderInnerGroupRow: function ($result, nodes) {
|
||||
var $tr = $('<tr>');
|
||||
for (var i = 0; i < nodes.length; i++) {
|
||||
@@ -385,6 +448,7 @@ return BasicRenderer.extend({
|
||||
* if they are asynchronous, they register their deferred in this.defs, and
|
||||
* the _renderView method will properly wait.
|
||||
*
|
||||
* @private
|
||||
* @param {Object} node
|
||||
* @returns {jQueryElement | string}
|
||||
*/
|
||||
@@ -401,6 +465,11 @@ return BasicRenderer.extend({
|
||||
}
|
||||
return this._renderGenericTag(node);
|
||||
},
|
||||
/**
|
||||
* @private
|
||||
* @param {Object} node
|
||||
* @returns {jQueryElement}
|
||||
*/
|
||||
_renderStatButton: function (node) {
|
||||
var $button = $('<button>').addClass('btn btn-sm oe_stat_button');
|
||||
if (node.attrs.icon) {
|
||||
@@ -414,6 +483,12 @@ return BasicRenderer.extend({
|
||||
this._handleAttributes($button, node);
|
||||
return $button;
|
||||
},
|
||||
/**
|
||||
* @private
|
||||
* @param {Object} page
|
||||
* @param {string} page_id
|
||||
* @returns {jQueryElement}
|
||||
*/
|
||||
_renderTabHeader: function (page, page_id) {
|
||||
var $a = $('<a>', {
|
||||
'data-toggle': 'tab',
|
||||
@@ -424,11 +499,22 @@ return BasicRenderer.extend({
|
||||
});
|
||||
return $('<li>').append($a);
|
||||
},
|
||||
/**
|
||||
* @private
|
||||
* @param {Object} page
|
||||
* @param {string} page_id
|
||||
* @returns {jQueryElement}
|
||||
*/
|
||||
_renderTabPage: function (page, page_id) {
|
||||
var $result = $('<div class="tab-pane" id="' + page_id + '">');
|
||||
$result.append(_.map(page.children, this._renderNode.bind(this)));
|
||||
return $result;
|
||||
},
|
||||
/**
|
||||
* @private
|
||||
* @param {Object} node
|
||||
* @returns {jQueryElement}
|
||||
*/
|
||||
_renderTagButton: function (node) {
|
||||
var widget = {
|
||||
node: node,
|
||||
@@ -442,9 +528,19 @@ return BasicRenderer.extend({
|
||||
this._handleAttributes($button, node);
|
||||
return $button;
|
||||
},
|
||||
/**
|
||||
* @private
|
||||
* @param {Object} node
|
||||
* @returns {jQueryElement}
|
||||
*/
|
||||
_renderTagField: function (node) {
|
||||
return this._renderFieldWidget(node).$el;
|
||||
},
|
||||
/**
|
||||
* @private
|
||||
* @param {Object} node
|
||||
* @returns {jQueryElement}
|
||||
*/
|
||||
_renderTagForm: function (node) {
|
||||
var $result = $('<div/>');
|
||||
if (node.attrs.class) {
|
||||
@@ -453,6 +549,11 @@ return BasicRenderer.extend({
|
||||
$result.append(_.map(node.children, this._renderNode.bind(this)));
|
||||
return $result;
|
||||
},
|
||||
/**
|
||||
* @private
|
||||
* @param {Object} node
|
||||
* @returns {jQueryElement}
|
||||
*/
|
||||
_renderTagGroup: function (node) {
|
||||
var self = this;
|
||||
var isOuterGroup = _.some(node.children, function (child) {
|
||||
@@ -476,6 +577,11 @@ return BasicRenderer.extend({
|
||||
this._handleAttributes($result, node);
|
||||
return $result;
|
||||
},
|
||||
/**
|
||||
* @private
|
||||
* @param {Object} node
|
||||
* @returns {jQueryElement}
|
||||
*/
|
||||
_renderTagHeader: function (node) {
|
||||
var self = this;
|
||||
var $statusbar = $('<div>', {class: 'o_form_statusbar'});
|
||||
@@ -491,6 +597,11 @@ return BasicRenderer.extend({
|
||||
});
|
||||
return $statusbar;
|
||||
},
|
||||
/**
|
||||
* @private
|
||||
* @param {Object} node
|
||||
* @returns {jQueryElement}
|
||||
*/
|
||||
_renderTagLabel: function (node) {
|
||||
var text;
|
||||
if ('string' in node.attrs) { // allow empty string
|
||||
@@ -507,6 +618,11 @@ return BasicRenderer.extend({
|
||||
this._handleAttributes($result, node);
|
||||
return $result;
|
||||
},
|
||||
/**
|
||||
* @private
|
||||
* @param {Object} node
|
||||
* @returns {jQueryElement}
|
||||
*/
|
||||
_renderTagNotebook: function (node) {
|
||||
var self = this;
|
||||
var $headers = $('<ul class="nav nav-tabs">');
|
||||
@@ -537,9 +653,19 @@ return BasicRenderer.extend({
|
||||
.append($headers)
|
||||
.append($pages);
|
||||
},
|
||||
/**
|
||||
* @private
|
||||
* @param {Object} node
|
||||
* @returns {jQueryElement}
|
||||
*/
|
||||
_renderTagSeparator: function (node) {
|
||||
return $('<div/>').addClass('o_horizontal_separator').text(node.attrs.string);
|
||||
},
|
||||
/**
|
||||
* @private
|
||||
* @param {Object} node
|
||||
* @returns {jQueryElement}
|
||||
*/
|
||||
_renderTagSheet: function (node) {
|
||||
this.has_sheet = true;
|
||||
var $result = $('<div>').addClass('o_form_sheet_bg');
|
||||
@@ -553,6 +679,7 @@ return BasicRenderer.extend({
|
||||
* the root of the arch, then, when every deferred (from the field widgets)
|
||||
* are done, it will resolves itself.
|
||||
*
|
||||
* @private
|
||||
* @override method from BasicRenderer
|
||||
* @returns {Deferred}
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user