1. 问题背景与Odoo列表视图渲染机制
在Odoo的列表视图中，开发者经常需要根据特定业务逻辑动态地禁用某些行的复选框。例如，当一个产品的库存量为零时，可能需要禁用其对应的选择框，以防止用户对其进行操作。通常，这可以通过扩展ListRenderer并重写其_renderRow方法来实现，在行渲染时根据数据条件设置复选框的disabled属性。
然而，一个常见的问题是，当用户点击或修改列表视图中的任何一行时，之前被禁用的复选框会自动重新启用。这使得前端的禁用逻辑失效，需要刷新页面才能恢复。其根本原因在于Odoo的列表视图，特别是可编辑列表视图（ListEditableRenderer），在处理行编辑模式时，会通过其内部机制统一管理记录选择器的状态。具体来说，Odoo在进入编辑模式时可能会调用_disableRecordSelectors来禁用所有选择器，而在退出编辑模式或更新行后，会调用_enableRecordSelectors来重新启用它们。这些内部方法会覆盖我们在_renderRow中设置的disabled属性。
Odoo内部ListEditableRenderer中控制选择器的方法大致如下：
// Odoo 14.0/addons/web/static/src/js/views/list/list_editable_renderer.js
_disableRecordSelectors: function () {
this.$('.o_list_record_selector input').attr('disabled', 'disabled');
},
_enableRecordSelectors: function () {
this.$('.o_list_record_selector input').attr('disabled', false);
},这些方法会直接操作DOM，将所有.o_list_record_selector input元素的disabled属性设置为true或false，从而导致我们自定义的禁用逻辑被覆盖。
2. 解决方案：创建自定义列表渲染器
为了解决上述问题，我们需要创建一个自定义的列表渲染器，并不仅仅是重写_renderRow，更重要的是要介入Odoo对选择器启用/禁用过程的控制。核心思想是：在Odoo尝试重新启用所有选择器之后，我们再次根据业务逻辑判断并禁用那些应该保持禁用的复选框。
2.1 定义自定义ListRenderer
我们将创建一个新的JavaScript文件（例如：static/src/js/custom_list_renderer.js）来定义我们的自定义渲染器。
odoo.define('your_module_name.CustomListRenderer', function (require) {
"use strict";
var ListRenderer = require('web.ListRenderer');
var ListView = require('web.ListView');
var viewRegistry = require('web.view_registry');
// 定义需要保持禁用状态的类别
var CATEGORIES_TO_EXCLUDE = ['Maintenance', 'Installation', 'Transport', "Volume d'impression"];
var CustomListRenderer = ListRenderer.extend({
/**
* 扩展 _renderRow 方法，在初始渲染时禁用符合条件的复选框。
* 这是首次加载视图时应用禁用逻辑的地方。
*/
_renderRow: function (record) {
var tr = this._super.apply(this, arguments); // 调用父类的_renderRow方法获取原始行元素
// 根据库存和类别条件禁用复选框
var shouldBeDisabled = record.data.stock <= 0 && !CATEGORIES_TO_EXCLUDE.includes(record.data.small_category_name_field);
tr.find(".o_list_record_selector input[type='checkbox']").prop('disabled', shouldBeDisabled);
return tr;
},
/**
* 重写 _enableRecordSelectors 方法，确保在Odoo尝试启用所有选择器后，
* 仍然能够保持特定复选框的禁用状态。
*/
_enableRecordSelectors: function () {
this._super.apply(this, arguments); // 首先，调用父类方法，让Odoo启用所有选择器
var self = this;
// 遍历当前渲染的所有记录，重新应用禁用逻辑
this.records.forEach(function(record) {
// 查找当前记录对应的DOM行元素
var tr = self.$el.find('tr[data-id="' + record.id + '"]');
if (tr.length) {
var shouldBeDisabled = record.data.stock <= 0 && !CATEGORIES_TO_EXCLUDE.includes(record.data.small_category_name_field);
tr.find(".o_list_record_selector input[type='checkbox']").prop('disabled', shouldBeDisabled);
}
});
},
/**
* _disableRecordSelectors 方法通常可以保持不变，因为它只是全局禁用。
* 如果有特殊需求，也可以在此处添加逻辑。
*/
// _disableRecordSelectors: function () {
// this._super.apply(this, arguments);
// },
});
// 定义自定义ListView，并配置使用CustomListRenderer
var CustomListView = ListView.extend({
config: _.extend({}, ListView.prototype.config, {
Renderer: CustomListRenderer,
}),
});
// 将自定义视图注册到视图注册表中，以便在XML中通过js_class引用
viewRegistry.add('custom_tree_renderer', CustomListView);
return {
CustomListRenderer: CustomListRenderer,
CustomListView: CustomListView,
};
});代码解析：
- odoo.define(...): Odoo模块定义标准语法。
- require(...): 导入所需的Odoo Web模块，如ListRenderer、ListView和viewRegistry。
- CATEGORIES_TO_EXCLUDE: 定义一个常量数组，用于存放不需要禁用复选框的类别名称，增加代码可读性和可维护性。
-
CustomListRenderer = ListRenderer.extend(...): 继承Odoo的ListRenderer。
- _renderRow(record): 这个方法在每一行数据被渲染时调用。我们首先调用this._super()来执行父类的渲染逻辑，然后根据record.data.stock和record.data.small_category_name_field的值来判断是否禁用该行的复选框。
- _enableRecordSelectors(): 这是解决核心问题的关键。当Odoo尝试重新启用所有记录选择器时，此方法会被调用。我们首先调用this._super()让Odoo执行其默认的启用操作。紧接着，我们遍历当前渲染器中的所有records，找到对应的DOM行元素，并重新应用我们的禁用逻辑。这样，即使Odoo尝试启用，我们也能立即根据条件再次禁用。
- CustomListView = ListView.extend(...): 继承Odoo的ListView，并配置其Renderer属性为我们自定义的CustomListRenderer。这是将自定义渲染器与视图关联起来的桥梁。
- viewRegistry.add('custom_tree_renderer', CustomListView): 将我们自定义的CustomListView注册到Odoo的视图注册表中，并为其指定一个唯一的名称custom_tree_renderer。这个名称将在XML视图中用到。
2.2 在Odoo XML视图中应用自定义渲染器
在你的Odoo模块的XML视图文件中，找到你想要应用此自定义逻辑的tree视图定义，并添加js_class属性，值为你在viewRegistry.add中注册的名称。
your.model.tree your.model
重要提示：
- 确保你的JavaScript文件被正确加载。你需要在模块的__manifest__.py文件中，将JavaScript文件添加到assets配置中，例如：
'assets': { 'web.assets_backend': [ 'your_module_name/static/src/js/custom_list_renderer.js', ], }, - 在每次修改JavaScript或XML文件后，务必升级你的Odoo模块，以确保更改生效。
3. 注意事项与最佳实践
- 选择器精度：在_renderRow和_enableRecordSelectors中，使用tr.find(".o_list_record_selector input[type='checkbox']")来精确选择目标复选框，避免影响其他元素。
- 性能考量：_enableRecordSelectors会在每次Odoo尝试启用选择器时遍历所有记录。对于包含大量记录的视图，确保你的禁用逻辑尽可能高效，避免复杂的计算。
- Odoo版本兼容性：Odoo的内部API（如ListRenderer的方法和DOM结构）在不同版本之间可能会有变化。本教程基于Odoo v14，在升级到新版本时，请注意检查相关方法的行为是否一致。
- 模块化：将自定义逻辑封装在独立的JS文件中，并使用odoo.define进行模块化管理，有助于代码的组织和维护。
- 调试：在开发过程中，利用浏览器开发工具（F12）的console.log()来输出变量值，追踪代码执行流程，是定位问题的有效方法。
4. 总结
通过扩展Odoo的ListRenderer并重写_renderRow和_enableRecordSelectors方法，我们可以有效地控制列表视图中复选框的禁用状态，使其在用户交互后依然保持稳定。这种方法深入理解了Odoo前端渲染机制，提供了一种健壮且可维护的解决方案，确保了自定义UI逻辑的持久性，从而显著提升了Odoo应用的可用性和用户体验。
