Odoo 9. How to override form widgets?

Danila Ganchar picture Danila Ganchar · Jan 5, 2016 · Viewed 9.5k times · Source

I work with odoo 9. In the system exists render_value method for each type of field:

/odoo/addons/web/static/src/js/views/form_widgets.js
/odoo/addons/web/static/src/js/views/form_relational_widgets.js

How I can use my custom method render_value(for example in FieldChar) for all forms? And how I can use specific render_value for one form or one module?

I created form_widgets.js in my module, but I not understand how properly override Field.

odoo.define('my_module.form_widgets', function (require) {
"use strict";

// what I should do here???

});

Can you provide small example? Thank in advance.

Answer

Danila Ganchar picture Danila Ganchar · Feb 11, 2016

I found the solution.

The first thing you need to do it is create static for frontend. JS:

// path_to_your_module/static/src/js/form_widgets.js
odoo.define('your_module.form_widgets', function (require) {
    "use strict";

    var core = require('web.core');
    var form_common = require('web.form_common');
    var FieldChar = core.form_widget_registry.get('char');

    FieldChar.include({
        // this is will be work for all FieldChar in the system
        template: 'MyChar', // my template for char fields
        // we can create here any logic for render
        //render_value: function() {
        //}
    });
    // this is widget for unique CharField
    var MyModuleFieldChar = FieldChar.extend({
        template: 'MyUniqueChar' // my custom template for unique char field
    });
    // register unique widget, because Odoo does not know anything about it
    core.form_widget_registry.add('my_unique_char', MyModuleFieldChar);

});

Templates for qWeb:

<?xml version="1.0" encoding="UTF-8"?>
<templates xml:space="preserve">
<!-- path_to_your_module/static/src/xml/form_widgets.xml -->
<t t-name="MyChar">
    <!-- for example I just added new <span> to all FieldChar -->
    <span>my_val</span>
    <!-- this is original content for CharField from path_to_odoo/addons/web/static/src/xml/base.xml -->
    <span t-att-class="'oe_form_field '+widget.widget_class" t-att-style="widget.node.attrs.style">
        <t t-if="!widget.get('effective_readonly')">
            <input t-att-type="widget.password ? 'password' : 'text'"
                t-att-barcode_events="widget.options.barcode_events"
                t-att-id="widget.id_for_label"
                t-att-tabindex="widget.node.attrs.tabindex"
                t-att-autofocus="widget.node.attrs.autofocus"
                t-att-placeholder="widget.node.attrs.placeholder"
                t-att-maxlength="widget.field.size"
            /><img class="oe_field_translate oe_input_icon" t-if="widget.field.translate" t-att-src='_s + "/web/static/src/img/icons/terp-translate.png"' width="16" height="16" border="0"/>
        </t>
        <t t-if="widget.get('effective_readonly')">
            <span class="oe_form_char_content"></span>
        </t>
    </span>
</t>
<!-- This is example template for my unique field -->
<t t-name="MyUniqueChar">
    <span>unique_char</span>
</t>

</templates>

Second step - include our static files.

Create new view which will be add assets:

<?xml version="1.0" encoding="utf-8"?>
<!-- path_to_your_module/views/assets.xml -->
<openerp>
    <data>
        <template id="assets_backend" name="mail assets" inherit_id="web.assets_backend">
            <xpath expr="." position="inside">
                <script type="text/javascript" src="/your_module/static/src/js/form_widgets.js"></script>
            </xpath>
        </template>
    </data>
</openerp>

In openerp.py of your module add next sections:

'data': [
    'views/assets.xml',
    # other files
],
'qweb': [
    'static/src/xml/*.xml',
],

After this will be work our FieldChar for all CHAR fields in the system. If we need to use my_unique_char we need just add attribute widget to field of our from like this:

<field name="name" widget="my_unique_char"/>

I hope it will help someone.