当前位置：首页 > news >正文

Odoo列表视图的控制标签＜control＞详解

news 来源：原创 2025/6/9 10:40:37

整体解读：`<control>` 标签

<control> 标签在Odoo视图中，尤其是在表单视图 (Form View) 内的 one2many 或 many2many 字段（通常显示为可编辑列表或树状视图）中，扮演着操作面板或工具栏的角色。它用于组织一系列用户可以执行的动作按钮或链接，这些动作通常与创建新记录、修改现有记录或触发特定业务逻辑相关。

在早期的Odoo版本中（如Odoo 12及之前），<control> 标签与 <tree> 视图内的 editable="bottom" 或 editable="top" 属性结合使用时非常常见，它会在列表的底部或顶部提供如 "Add an item" 这样的链接。从Odoo 13开始，列表视图的交互方式有所改变，但 <control> 标签的概念和作用依然存在于特定场景，尤其是在需要提供多种创建选项或自定义操作时。

这段代码片段的核心目的是为用户提供多种方式来向一个相关的集合（例如，销售订单的订单行、发票的发票行）添加新条目，或者触发一个更复杂的操作（如从目录添加）。

`<create>` 标签详解

<create> 标签专门用于在 <control> 元素内部定义“创建新记录”的链接或按钮。点击这些元素通常会在关联的 one2many 或 many2many 字段中添加一条新的、空白的或预设了部分默认值的记录行，让用户可以进行编辑。

1. `<create name="add_line_control" string="Add a line"/>`

name="add_line_control":
- 含义: 这是一个在XML中用于唯一标识此 <create> 控件的名称。
- 作用机制: 这个 name 属性主要用于内部目的，例如在JavaScript代码中可能需要引用这个特定的控件，或者在Odoo框架内部处理不同的创建请求时进行区分。它通常不直接映射到Python模型中的方法名，而是作为一个UI元素的标识符。在同一 <control> 块中，name 应该是唯一的。
- UI呈现: 该名称本身通常不会直接显示在用户界面上。
string="Add a line":
- 含义: 这是定义在用户界面上显示的文本标签。
- 作用机制: Odoo框架会读取这个 string 属性，并在界面上渲染一个可点击的文本链接或按钮，其文本内容就是 "Add a line"。
- UI呈现: 用户会在界面上看到一个标签为 "Add a line" 的链接或按钮。
行为:
- 当用户点击这个 "Add a line" 控件时，Odoo通常会触发在其父级 one2many 或 many2many 字段所关联的模型上创建一个新的空记录。
- 这个新记录行会立即出现在可编辑列表中，允许用户填写其字段。
- 如果没有提供 context 属性来指定默认值，那么新创建的记录将使用其模型定义的默认值（通过 default_get 方法或字段的 default 属性）。

2. `<create name="add_section_control" string="Add a section" context="{'default_display_type': 'line_section'}"/>`

name="add_section_control":
- 含义与作用: 与 add_line_control 类似，这是一个唯一标识此创建控件的内部名称。
string="Add a section":
- 含义与UI呈现: 在用户界面上显示为 "Add a section" 的可点击文本。
context="{'default_display_type': 'line_section'}":
- 含义: context 属性是一个包含键值对的Python字典字符串。它允许在执行操作时向服务器传递额外的数据或指令。
- 作用机制:
  - 当用户点击 "Add a section" 时，这个 context 会被传递给目标模型（即 one2many 字段关联的模型）的 create() 方法或 default_get() 方法。
  - default_display_type: 这是一个在 context 中传递的键。它通常用于为新创建记录的某个字段预设一个默认值。这里的 default_ 前缀是Odoo的一个约定，表示这个键值对应该用来设置名为 display_type (去掉 default_ 前缀) 的字段的默认值。
  - 'line_section': 这是赋给 display_type 字段的值。
- display_type 字段: 在许多Odoo应用中（如销售、采购、会计），订单行或发票行模型会有一个名为 display_type 的字段 (通常是 fields.Selection)。这个字段用来区分不同类型的行。
  - 'line_section' 这个值通常表示新创建的行是一个章节行 (Section Line)。章节行通常用于在订单或发票的行项目中创建逻辑分组，它本身可能没有产品、数量或价格，而是仅显示一个标题或描述。
- 影响:
  - 当新记录被创建时，其 display_type 字段会自动设置为 'line_section'。
  - 这反过来会影响该行在列表中的显示方式。例如，一个 "section" 类型的行在视图中可能会有不同的列被显示或隐藏，或者有特殊的CSS样式（如加粗、背景色等），使其在视觉上与其他普通产品行区分开来。它也可能没有数量、单价等字段可供编辑。

3. `<create name="add_note_control" string="Add a note" context="{'default_display_type': 'line_note'}"/>`

name="add_note_control":
- 含义与作用: 与前两者类似，唯一标识此创建控件的内部名称。
string="Add a note":
- 含义与UI呈现: 在用户界面上显示为 "Add a note" 的可点击文本。
context="{'default_display_type': 'line_note'}":
- 含义与作用机制: 与 add_section_control 中的 context 类似。
- 'line_note': 这个值赋给 display_type 字段，通常表示新创建的行是一个备注行 (Note Line)。备注行用于在订单或发票中添加额外的文本信息或说明，它通常也不包含产品、数量或价格信息。
- 影响:
  - 新创建记录的 display_type 字段会被设置为 'line_note'。
  - 这同样会影响该行在列表中的显示和行为，通常它会提供一个较大的文本区域供用户输入备注内容，并隐藏其他不相关的字段。

`<button>` 标签详解

<button> 标签用于在视图中定义一个可点击的按钮，该按钮可以触发服务器端的Python方法或客户端的Odoo动作。

`<button name="action_add_from_catalog" string="Catalog" type="object" class="btn-link" context="{'order_id': parent.id}"/>`

name="action_add_from_catalog":
- 含义: 当 type="object" 时，这个 name 属性指的是在当前视图所关联的主模型 (或者，如果这个按钮定义在 one2many 字段的视图内，它可能指向父模型的某个方法，或者 one2many 字段模型的某个方法，具体取决于上下文的传递和方法的实现方式) 中定义的Python方法名。
- 作用机制: 点击此按钮会触发一个RPC（远程过程调用）到Odoo服务器，执行名为 action_add_from_catalog 的Python方法。
- 对应方法: 在相关的Python模型中，应该存在一个如下定义的方法：

class YourModel(models.Model):_name = 'your.model' # 或者父模型的名称，如 'sale.order'def action_add_from_catalog(self):# 方法的实现逻辑# 通常会返回一个 Odoo 动作 (action dictionary)# 例如打开一个向导 (wizard) 来选择产品pass

string="Catalog":
- 含义: 这是按钮上显示的文本标签。
- UI呈现: 用户会看到一个标签为 "Catalog" 的按钮或链接。
type="object":
- 含义: 这个属性指定了按钮的行为类型。type="object" 表示点击按钮时，会调用在 name 属性中指定的、位于服务器端Python模型上的方法。
- 与 type="action" 的区别:
  - type="object": 调用当前记录集（或通过 context 传递的记录）的Python方法。该方法可以执行任意业务逻辑，并且可以选择性地返回一个动作字典来触发进一步的UI行为（如打开新视图、向导、报表等）。
  - type="action": 点击按钮时，会执行一个在数据库中预定义的Odoo窗口动作（ir.actions.act_window）、服务器动作（ir.actions.server）、报表动作（ir.actions.report）等。此时，name 属性通常是该动作的外部ID（xml_id）或数据库ID。
class="btn-link":
- 含义: 这是一个CSS类名，用于控制按钮的视觉样式。
- 作用机制: Odoo的前端界面通常使用Bootstrap框架。btn-link 是Bootstrap提供的一个标准类，它会将按钮的样式设置为类似超链接的外观（即没有背景、边框，文本颜色通常为蓝色并带有下划线，鼠标悬停时可能会改变样式）。
- 影响: 使按钮看起来更像一个文本链接，而不是一个传统的、有立体感的按钮。这通常用于次要操作或为了使界面更简洁。
context="{'order_id': parent.id}":
- 含义: 与 <create> 标签中的 context 类似，这是一个Python字典字符串，用于向被调用的Python方法传递额外的数据。
- 作用机制:
  - parent.id: 这是一个非常关键的表达式。在 one2many 字段的上下文中（例如，销售订单表单中的订单行），parent 是一个特殊的关键字，它指向当前表单视图的主记录。因此，parent.id 解析为该主记录的ID。例如，如果这段XML位于销售订单（sale.order）表单中用于管理订单行（sale.order.line）的部分，那么 parent.id 就是当前打开的销售订单的ID。
  - 'order_id': 这是在 context 字典中定义的键。
  - 这个上下文 {'order_id': <current_order_id>} 会被传递给 action_add_from_catalog Python方法。
- 在Python方法中的使用:

Python方法 action_add_from_catalog 可以通过 self.env.context 来访问这个传递过来的上下文。

def action_add_from_catalog(self):# 'self' 通常是当前模型（可能是父模型）的记录集# 如果按钮在one2many的tree view中，self可能是空的one2many模型记录集，# 或者根据按钮定义位置是父模型记录集。# 重要的是 context 的传递。order_id_from_context = self.env.context.get('order_id')if order_id_from_context:# 现在我们有了父订单的ID# 可以基于这个 order_id 来执行操作，# 例如，打开一个产品选择向导，并将选中的产品添加到这个order_id对应的订单中order = self.env['sale.order'].browse(order_id_from_context) # 假设是sale.order# ... 进一步的逻辑 ...# 示例：返回一个动作来打开一个向导return {'name': 'Add Products from Catalog','type': 'ir.actions.act_window','res_model': 'your.product.catalog.wizard', # 假设有一个这样的向导模型'view_mode': 'form','target': 'new', # 在新窗口中打开向导'context': {'default_order_id': order_id_from_context} # 将order_id传递给向导}

通过这种方式，action_add_from_catalog 方法就能准确地知道它应该为哪个父记录（例如，哪个销售订单）执行操作。

上下文与应用场景

最常出现的视图类型:

这段XML代码片段几乎可以肯定是用于表单视图 (Form View) 中，用来管理一个**one2many 字段**的行项目。常见的应用场景包括：

- 销售订单 (Sale Order) 中的 订单行 (Sale Order Lines)
- 采购订单 (Purchase Order) 中的 订单行 (Purchase Order Lines)
- 客户发票/供应商账单 (Account Move) 中的 发票行 (Invoice Lines)
- 物料清单 (Bill of Materials) 中的 组件行 (Components)
- 任何其他需要在一个主记录下管理一个动态行项目列表的场景。
操作流程或功能集合:

这些控件组合在一起，为用户提供了一个灵活且功能丰富的界面来管理行项目：

1. Add a line: 快速添加一个标准的、通用的新行（例如，一个产品行）。这是最基本、最直接的添加方式。
2. Add a section: 允许用户在行项目中插入一个"章节"标题，用于组织和分隔不同的产品组或服务组，提高可读性。
3. Add a note: 允许用户插入纯文本备注，用于提供额外的说明、特殊指示或任何不适合放在标准产品字段中的信息。
4. Catalog (button): 提供一个更高级或专门化的添加方式。点击此按钮通常会：
  - 打开一个向导 (Wizard) 或一个新的视图。
  - 在这个向导/视图中，用户可以浏览产品目录、使用筛选器、批量选择产品、指定数量等。
  - 确认后，选中的项目会作为新的行被添加到当前的父记录中（例如，销售订单）。
  - parent.id 的传递确保了这个目录操作是针对当前正在编辑的主文档（如当前订单）。

这个组合体现了良好的用户体验设计，既提供了快速简单的操作（直接添加行、章节、备注），也支持了更复杂的、向导式的操作（从目录添加），满足了不同场景下的需求。

总结

这段Odoo XML代码定义了一组在 one2many 字段上下文中常用的用户操作控件。它通过 <create> 标签提供了不同类型的行创建选项（标准行、章节、备注），并利用 context 属性为新创建的行预设 display_type，从而影响其行为和显示。同时，通过 <button> 标签和 type="object"，它集成了一个自定义的Python方法调用，允许执行更复杂的逻辑，如通过一个目录选择器来添加项目，并通过 context 将父记录的ID传递给后端方法，确保操作的上下文准确性。

这种设计模式是Odoo中构建动态和交互式表单的常见做法，旨在提高数据录入的效率和灵活性。

希望以上详尽的分析能够帮助您全面理解这段Odoo XML代码！