diff --git a/web_domain_field/README.rst b/web_domain_field/README.rst index 30fc9decc..8c35a22f8 100644 --- a/web_domain_field/README.rst +++ b/web_domain_field/README.rst @@ -1,108 +1,73 @@ -.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg - :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html - :alt: License: AGPL-3 - ================ Web Domain Field ================ -When you define a view you can specify on the relational fields a domain -attribute. This attribute is evaluated as filter to apply when displaying -existing records for selection. +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -.. code-block:: xml +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github + :target: https://github.com/OCA/web/tree/11.0/web_domain_field + :alt: OCA/web +.. |badge4| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/162/11.0 + :alt: Try me on Runbot - +|badge1| |badge2| |badge3| |badge4| -The value provided for the domain attribute must be a string representing a -valid Odoo domain. This string is evaluated on the client side in a -restricted context where we can reference as right operand the values of -fields present into the form and a limited set of functions. - -In this context it's hard to build complex domain and we are facing to some -limitations as: - - * The syntax to include in your domain a criteria involving values from a - x2many field is complex. - * The right side of domain in case of x2many can involve huge amount of ids - (performance problem). - * Domains computed by an onchange on an other field are not recomputed when - you modify the form and don't modify the field triggering the onchange. - * It's not possible to extend an existing domain. You must completely redefine - the domain in your specialized addon - * etc... - -In order to mitigate these limitations this new addon allows you to use the -value of a field as domain of an other field in the xml definition of your -view. - -.. code-block:: xml - - - - -The field used as domain must provide the domain as a JSON encoded string. - -.. code-block:: python - - product_id_domain = fields.Char( - compute="_compute_product_id_domain", - readonly=True, - store=False, - ) - - @api.multi - @api.depends('name') - def _compute_product_id_domain(self): - for rec in self: - rec.product_id_domain = json.dumps( - [('type', '=', 'product'), ('name', 'like', rec.name)] - ) - - -Usage -===== - -.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas - :alt: Try me on Runbot - :target: https://runbot.odoo-community.org/runbot/162/11.0 +In order to mitigate limitations with domains in views, now you can define +a computed field in a domain attribute and It's related method will return +the domain to apply. +**Table of contents** +.. contents:: + :local: Bug Tracker =========== -Bugs are tracked on `GitHub Issues -`_. In case of trouble, please -check there if your issue has already been reported. If you spotted it first, -help us smashing it by providing a detailed and welcomed feedback. +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed feedback. + +Do not contact contributors directly about support or help with technical issues. Credits ======= -Images ------- +Authors +~~~~~~~ -* Odoo Community Association: `Icon `_. +* ACSONE SA/NV Contributors ------------- +~~~~~~~~~~~~ * Laurent Mignon * Denis Roussel * Martín Nicolás Cuesta -Maintainer ----------- +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. .. image:: https://odoo-community.org/logo.png :alt: Odoo Community Association :target: https://odoo-community.org -This module is maintained by the OCA. - OCA, or the Odoo Community Association, is a nonprofit organization whose mission is to support the collaborative development of Odoo features and promote its widespread use. -To contribute to this module, please visit https://odoo-community.org. +This module is part of the `OCA/web `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/web_domain_field/readme/USAGE.rst b/web_domain_field/readme/USAGE.rst new file mode 100644 index 000000000..9c3f8d275 --- /dev/null +++ b/web_domain_field/readme/USAGE.rst @@ -0,0 +1,52 @@ +When you define a view you can specify on the relational fields a domain +attribute. This attribute is evaluated as filter to apply when displaying +existing records for selection. + +.. code-block:: xml + + + +The value provided for the domain attribute must be a string representing a +valid Odoo domain. This string is evaluated on the client side in a +restricted context where we can reference as right operand the values of +fields present into the form and a limited set of functions. + +In this context it's hard to build complex domain and we are facing to some +limitations as: + + * The syntax to include in your domain a criteria involving values from a + x2many field is complex. + * The right side of domain in case of x2many can involve huge amount of ids + (performance problem). + * Domains computed by an onchange on an other field are not recomputed when + you modify the form and don't modify the field triggering the onchange. + * It's not possible to extend an existing domain. You must completely redefine + the domain in your specialized addon + * etc... + +In order to mitigate these limitations this new addon allows you to use the +value of a field as domain of an other field in the xml definition of your +view. + +.. code-block:: xml + + + + +The field used as domain must provide the domain as a JSON encoded string. + +.. code-block:: python + + product_id_domain = fields.Char( + compute="_compute_product_id_domain", + readonly=True, + store=False, + ) + + @api.multi + @api.depends('name') + def _compute_product_id_domain(self): + for rec in self: + rec.product_id_domain = json.dumps( + [('type', '=', 'product'), ('name', 'like', rec.name)] + )