Tree Widget

This widget allows you to display tree-like hierarchical references, making it easier to organize and navigate complex structures. It works seamlessly on both forms and tree views, allowing users to select and manage hierarchical data directly within Odoo.

Ideal for creating structured references such as categories, departments, or multi-level directories.

Examples

Usage

    # foreign model
    class YourReferenceModel(models.Model):
      _name = "your_reference_model"
      _description = "YourReferenceModel"
      _inherit = ["tree_widget.mixin"]

    # main model
    class YourMainModel(models.Model):
      _name = "your_main_model"
      _description = "YourMainModel"

      name = fields.Char(string="Name")
      reference_id = fields.Many2one(
          "your_reference_model",
          string="Reference",
          context={"display_full_name": True}, # Set display_full_name=True if you want
          # the full path of the reference to be displayed.
      )

    # view form
    <form>
      ....
      <field name="reference_id" widget="many2one_tree" />
      ....
    </form>

    # view tree
    <tree>
      ....
      <field name="reference_id" widget="many2one_tree" />
      ....
    </tree>
    

Additional features

1. Ability to create, edit, delete directly in the tree

By default, buttons are displayed if you have the rights. You can also force them to be hidden via options in xml.

      # view form
      <form>
        ....
        <field name="reference_id" widget="many2one_tree" options="{'no_create': True, 'no_write': True}" />
        ....
      </form>
    

2. Ability to make fields unselectable based on a condition

      # foreign model. Add function with your condition of selectable item
      def _compute_selectable(self):
        for rec in self:
            rec.selectable = "Ref" in rec.name
    

3. Ability to display HTML fields with item descriptions

      # foreign model. Add html field with description
      description = fields.Html()

      # view form
      <form>
        ....
        <field name="reference_id" widget="many2one_tree" options="{'extra_fields': ['description']}" />
        ....
      </form>
    

4. Ability to display this tree instead of the standard search panel in the reference tree view.

      # foreign model. Add html field with description
      description = fields.Html()

      # view reference list
      <record id="your_reference_model_tree" model="ir.ui.view">
        <field name="name">your_reference_model.tree</field>
        <field name="model">your_reference_model</field>
        <field name="arch" type="xml">
            <tree string="YourReferenceModel" js_class="tree_list_js">
                <field name="name"/>
                <field name="full_path"/>
            </tree>
        </field>
      </record>

      <record id="your_reference_model_search" model="ir.ui.view">
        <field name="name">your_reference_model.search</field>
        <field name="model">your_reference_model</field>
        <field name="arch" type="xml">
            <search string="YourReferenceModel">
                <searchpanel>
                    <field name="parent_id"/>
                </searchpanel>
            </search>
        </field>
      </record>

      <record id="your_reference_model_action" model="ir.actions.act_window">
        <field name="name">YourReferenceModel</field>
        <field name="res_model">your_reference_model</field>
        <field name="view_mode">tree,form</field>
        <field name="search_view_id" ref="your_reference_model_search"/>
        <field name="view_id" ref="your_reference_model_tree"/>
      </record>
    

Good to know

To enable the Tree Widget, you need to add the tree_widget.mixin mixin to the reference model. Here you will find information about the fields in this mixin.

      It defines two stored fields:
      name – the record name
      parent_id – a link to the parent record

      In addition, the mixin provides several useful computed fields that can be used when building extra functionality:
      full_path – the record’s name including the full path from the root
      root_id – the root record of the hierarchy
      subordinate_ids – all dependent (child) records