视图记录

视图定义了记录应如何向最终用户展示。它们以 XML 编写并作为记录本身存储,这意味着可以独立于它们所表示的模型进行编辑。视图非常灵活,可对其控制的界面进行高度自定义。存在各种 视图类型,每种类型代表一种可视化模式:form (表单)、list (列表)、kanban (看板)等。

通用结构

基础视图通常共享下文定义的通用最小结构。占位符以全大写字母表示。

<record id="ADDON.MODEL_view_TYPE" model="ir.ui.view">
  <field name="name">NAME</field>
  <field name="model">MODEL</field>
  <field name="arch" type="xml">
    <VIEW_TYPE>
      <views/>
    </VIEW_TYPE>
  </field>
</record>

视图类型

表单

显示和编辑单条记录的数据。

列表

查看和编辑多条记录。

搜索

应用筛选器并执行搜索。结果显示在当前的列表、看板等视图中。

看板

将记录显示为“卡片”,可像小模板一样进行配置。

Qweb

用于报表、网站等的模板化……

图表

以可视化方式呈现多条记录或记录分组的聚合结果。

透视表

以 数据透视表 的形式显示聚合结果。

日历

将记录作为事件显示在按日、周、月或年的日历中。

同期群 Enterprise feature

显示并了解某些数据随时间变化的方式。

甘特图 Enterprise feature

将记录显示为甘特图。

网格 Enterprise feature

在数值单元格中显示计算出的信息;几乎不可配置。

地图 Enterprise feature

在地图上显示记录以及它们之间的路线。

字段

视图记录暴露了若干字段。

Note

当前上下文和用户访问权限也可能影响视图的能力。

继承

继承允许对交付的视图进行自定义。例如,它使得在安装模块时添加内容,或根据动作交付不同的显示成为可能。

继承视图通常共享下文定义的通用结构。占位符以全大写字母表示。这个合成视图会更新一个由 XPath 定位的节点,以及另一个由其名称和属性定位的节点。

<record id="ADDON.MODEL_view_TYPE" model="ir.ui.view">
    <field name="model">MODEL</field>
    <field name="inherit_id" ref="VIEW_REFERENCE"/>
    <field name="mode">MODE</field>
    <field name="arch" type="xml">
        <xpath expr="XPATH" position="POSITION">
            <CONTENT/>
        </xpath>
        <NODE ATTRIBUTES="VALUES" position="POSITION">
            <CONTENT/>
        </NODE>
    </field>
</record>

inherit_id 和 mode 字段决定 视图解析。xpath 或 NODE 元素指示 继承规范。expr 和 position 属性指定 继承位置。

视图解析

解析按如下方式为请求/匹配到的 primary 视图生成最终的 arch:

  1. 如果视图有父视图,先完全解析父视图,然后应用当前视图的继承规范;

  2. 如果视图没有父视图,则直接使用其 arch;

  3. 查找当前视图的 mode 为 extension 的子视图,并按深度优先的方式应用它们的继承规范(先应用一个子视图,再应用其子视图,然后是它的兄弟视图)。

继承根据 inherit_id 字段应用。如果多条视图记录继承同一个视图,顺序由 priority 决定。

应用子视图后的结果即为最终的 arch。

继承规范

继承规范按顺序应用,由以下部分组成:

  1. 用于匹配父视图中被继承元素的元素定位器;

  2. 用于修改被继承元素的子元素。

元素定位器有三种类型:

  • 带 expr 属性的 xpath 元素。expr 是应用于当前 arch 的 XPath 表达式1,匹配其找到的第一个节点;

  • 带 name 属性的 field 元素,匹配第一个具有相同 name 的字段。

    Note

    所有其他属性都会被忽略。

  • 任何其他元素,匹配第一个具有相同 name 和相同属性的元素。

    Note

    属性 position 和 version 会被忽略。

1

为了在 QWeb 视图中更简单地匹配,添加了一个扩展函数:hasclass(*classes) 在上下文节点拥有所有指定类时匹配成功。

Example

<xpath expr="page[@name='pg']/group[@name='gp']/field" position="inside">
    <field name="description"/>
</xpath>

<div name="name" position="replace">
    <field name="name2"/>
</div>

继承位置

继承规范接受一个可选的 position 属性,默认值为 inside,用于指定如何修改匹配到的节点。

inside

继承规范的内容被追加到匹配到的节点中。

Example

<notebook position="inside">
    <page string="New feature">
        ...
    </page>
</notebook>
after

继承规范的内容被追加到匹配节点的父节点中、该匹配节点之后。

Example

<xpath expr="//field[@name='x_field']" position="after">
    <field name="x_other_field"/>
</xpath>
before

继承规范的内容被追加到匹配节点的父节点中、该匹配节点之前。

Example

<field name=x_field" position="before">
    <field name="x_other_field"/>
</field>
replace

继承规范的内容替换匹配到的节点。规范内容中任何仅包含 $0 的文本节点都会被匹配节点的副本替换,从而有效地包裹该匹配节点。

Example

<xpath expr="//field[@name='x_field']" position="replace">
    <div class="wrapper">
        $0
    </div>
</xpath>
attributes

继承规范的内容应仅由 attribute 元素组成,每个元素都带有 name 属性和可选的内容体。

  • 如果 attribute 元素有内容体,则会向匹配节点添加一个以该 name 命名的新属性,其值为 attribute 元素的文本。

  • 如果 attribute 元素没有内容体,则会从匹配节点中移除以该 name 命名的属性。

  • 如果 attribute 元素带有 add 属性、remove 属性或两者兼有,则匹配节点中名为 name 的属性的值会被重新计算,以纳入 add、remove 的值以及一个可选的 separator 属性(默认为 ,)。add 将其值(以 separator 分隔)加入。remove 将其值(以 separator 分隔)移除。

Example

<field name="x_field" position="attributes">
    <attribute name="invisible">True</attribute>
    <attribute name="class" add="mt-1 mb-1" remove="mt-2 mb-2" separator=" "/>
</field>
move

属性 position="move" 设置在继承规范的内容上,用于指定节点相对于继承规范的元素定位器的移动方式;元素定位器上也必须设置 position 属性,取值为 inside、replace、after 或 before。

Example

<xpath expr="//@target" position="after">
    <xpath expr="//@node" position="move"/>
</xpath>

<field name="target_field" position="after">
    <field name="my_field" position="move"/>
</field>

模型通用内容