mirror of https://github.com/OCA/web.git
OCA-git-bot
commit
a7586aa628
|
|
@ -0,0 +1 @@
|
|||
../../../../web_domain_field
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
import setuptools
|
||||
|
||||
setuptools.setup(
|
||||
setup_requires=['setuptools-odoo'],
|
||||
odoo_addon=True,
|
||||
)
|
||||
|
|
@ -0,0 +1,149 @@
|
|||
================
|
||||
Web Domain Field
|
||||
================
|
||||
|
||||
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! This file is generated by oca-gen-addon-readme !!
|
||||
!! changes will be overwritten. !!
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
|
||||
.. |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/16.0/web_domain_field
|
||||
:alt: OCA/web
|
||||
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
|
||||
:target: https://translation.odoo-community.org/projects/web-16-0/web-16-0-web_domain_field
|
||||
:alt: Translate me on Weblate
|
||||
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
|
||||
:target: https://runbot.odoo-community.org/runbot/162/16.0
|
||||
:alt: Try me on Runbot
|
||||
|
||||
|badge1| |badge2| |badge3| |badge4| |badge5|
|
||||
|
||||
This technical addon allows developers to specify a field domain in a view
|
||||
using the value of another field in that view, rather than as a static
|
||||
XML attribute.
|
||||
|
||||
**Table of contents**
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
|
||||
Usage
|
||||
=====
|
||||
|
||||
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
|
||||
|
||||
<field name="product_id" domain="[('type','=','product')]"/>
|
||||
|
||||
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
|
||||
|
||||
<field name="product_id_domain" invisible="1"/>
|
||||
<field name="product_id" domain="product_id_domain"/>
|
||||
|
||||
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.depends('name')
|
||||
def _compute_product_id_domain(self):
|
||||
for rec in self:
|
||||
rec.product_id_domain = json.dumps(
|
||||
[('type', '=', 'product'), ('name', 'like', rec.name)]
|
||||
)
|
||||
|
||||
.. note::
|
||||
You do not actually need this module to craft a dynamic domain. Odoo comes
|
||||
with its own `py.js <https://github.com/odoo/odoo/tree/16.0/addons/web/static/lib/py.js>`_
|
||||
web library to parse expressions such as domains. `py.js` supports more
|
||||
complex expressions than just static lists.
|
||||
|
||||
Here is an example of a conditional domain based on the value of another
|
||||
field:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
(order_id or partner_id) and [('id', 'in', allowed_picking_ids)]
|
||||
or [('state', '=', 'done'), ('picking_type_id.code', '=', 'outgoing')]
|
||||
|
||||
For OCA modules, this method is preferred over adding this module as an
|
||||
additional dependency.
|
||||
|
||||
Bug Tracker
|
||||
===========
|
||||
|
||||
Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/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 <https://github.com/OCA/web/issues/new?body=module:%20web_domain_field%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
|
||||
|
||||
Do not contact contributors directly about support or help with technical issues.
|
||||
|
||||
Credits
|
||||
=======
|
||||
|
||||
Authors
|
||||
~~~~~~~
|
||||
|
||||
* ACSONE SA/NV
|
||||
|
||||
Contributors
|
||||
~~~~~~~~~~~~
|
||||
|
||||
* Laurent Mignon <laurent.mignon@acsone.eu>
|
||||
* Denis Roussel <denis.roussel@acsone.eu>
|
||||
* Raf Ven <raf.ven@dynapps.be>
|
||||
|
||||
Maintainers
|
||||
~~~~~~~~~~~
|
||||
|
||||
This module is maintained by the OCA.
|
||||
|
||||
.. image:: https://odoo-community.org/logo.png
|
||||
:alt: Odoo Community Association
|
||||
:target: https://odoo-community.org
|
||||
|
||||
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.
|
||||
|
||||
This module is part of the `OCA/web <https://github.com/OCA/web/tree/16.0/web_domain_field>`_ project on GitHub.
|
||||
|
||||
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
# Copyright 2017 ACSONE SA/NV
|
||||
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
|
||||
|
||||
{
|
||||
"name": "Web Domain Field",
|
||||
"summary": """
|
||||
Use computed field as domain""",
|
||||
"version": "16.0.1.0.0",
|
||||
"license": "AGPL-3",
|
||||
"author": "ACSONE SA/NV,Odoo Community Association (OCA)",
|
||||
"website": "https://github.com/OCA/web",
|
||||
"depends": ["web"],
|
||||
"data": [],
|
||||
"assets": {
|
||||
"web.assets_backend": [
|
||||
"/web_domain_field/static/lib/js/*.js",
|
||||
],
|
||||
"web.qunit_suite_tests": [
|
||||
"/web_domain_field/static/tests/**/*.js",
|
||||
],
|
||||
},
|
||||
"installable": True,
|
||||
}
|
||||
|
|
@ -0,0 +1,13 @@
|
|||
# Translation of Odoo Server.
|
||||
# This file contains the translation of the following modules:
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: Odoo Server 15.0\n"
|
||||
"Report-Msgid-Bugs-To: \n"
|
||||
"Last-Translator: \n"
|
||||
"Language-Team: \n"
|
||||
"MIME-Version: 1.0\n"
|
||||
"Content-Type: text/plain; charset=UTF-8\n"
|
||||
"Content-Transfer-Encoding: \n"
|
||||
"Plural-Forms: \n"
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
* Laurent Mignon <laurent.mignon@acsone.eu>
|
||||
* Denis Roussel <denis.roussel@acsone.eu>
|
||||
* Raf Ven <raf.ven@dynapps.be>
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
This technical addon allows developers to specify a field domain in a view
|
||||
using the value of another field in that view, rather than as a static
|
||||
XML attribute.
|
||||
|
|
@ -0,0 +1,68 @@
|
|||
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
|
||||
|
||||
<field name="product_id" domain="[('type','=','product')]"/>
|
||||
|
||||
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
|
||||
|
||||
<field name="product_id_domain" invisible="1"/>
|
||||
<field name="product_id" domain="product_id_domain"/>
|
||||
|
||||
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.depends('name')
|
||||
def _compute_product_id_domain(self):
|
||||
for rec in self:
|
||||
rec.product_id_domain = json.dumps(
|
||||
[('type', '=', 'product'), ('name', 'like', rec.name)]
|
||||
)
|
||||
|
||||
.. note::
|
||||
You do not actually need this module to craft a dynamic domain. Odoo comes
|
||||
with its own `py.js <https://github.com/odoo/odoo/tree/16.0/addons/web/static/lib/py.js>`_
|
||||
web library to parse expressions such as domains. `py.js` supports more
|
||||
complex expressions than just static lists.
|
||||
|
||||
Here is an example of a conditional domain based on the value of another
|
||||
field:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
(order_id or partner_id) and [('id', 'in', allowed_picking_ids)]
|
||||
or [('state', '=', 'done'), ('picking_type_id.code', '=', 'outgoing')]
|
||||
|
||||
For OCA modules, this method is preferred over adding this module as an
|
||||
additional dependency.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 9.2 KiB |
|
|
@ -0,0 +1,489 @@
|
|||
<?xml version="1.0" encoding="utf-8" ?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<meta name="generator" content="Docutils: http://docutils.sourceforge.net/" />
|
||||
<title>Web Domain Field</title>
|
||||
<style type="text/css">
|
||||
|
||||
/*
|
||||
:Author: David Goodger (goodger@python.org)
|
||||
:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
|
||||
:Copyright: This stylesheet has been placed in the public domain.
|
||||
|
||||
Default cascading style sheet for the HTML output of Docutils.
|
||||
|
||||
See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
|
||||
customize this style sheet.
|
||||
*/
|
||||
|
||||
/* used to remove borders from tables and images */
|
||||
.borderless, table.borderless td, table.borderless th {
|
||||
border: 0 }
|
||||
|
||||
table.borderless td, table.borderless th {
|
||||
/* Override padding for "table.docutils td" with "! important".
|
||||
The right padding separates the table cells. */
|
||||
padding: 0 0.5em 0 0 ! important }
|
||||
|
||||
.first {
|
||||
/* Override more specific margin styles with "! important". */
|
||||
margin-top: 0 ! important }
|
||||
|
||||
.last, .with-subtitle {
|
||||
margin-bottom: 0 ! important }
|
||||
|
||||
.hidden {
|
||||
display: none }
|
||||
|
||||
.subscript {
|
||||
vertical-align: sub;
|
||||
font-size: smaller }
|
||||
|
||||
.superscript {
|
||||
vertical-align: super;
|
||||
font-size: smaller }
|
||||
|
||||
a.toc-backref {
|
||||
text-decoration: none ;
|
||||
color: black }
|
||||
|
||||
blockquote.epigraph {
|
||||
margin: 2em 5em ; }
|
||||
|
||||
dl.docutils dd {
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
/* Uncomment (and remove this text!) to get bold-faced definition list terms
|
||||
dl.docutils dt {
|
||||
font-weight: bold }
|
||||
*/
|
||||
|
||||
div.abstract {
|
||||
margin: 2em 5em }
|
||||
|
||||
div.abstract p.topic-title {
|
||||
font-weight: bold ;
|
||||
text-align: center }
|
||||
|
||||
div.admonition, div.attention, div.caution, div.danger, div.error,
|
||||
div.hint, div.important, div.note, div.tip, div.warning {
|
||||
margin: 2em ;
|
||||
border: medium outset ;
|
||||
padding: 1em }
|
||||
|
||||
div.admonition p.admonition-title, div.hint p.admonition-title,
|
||||
div.important p.admonition-title, div.note p.admonition-title,
|
||||
div.tip p.admonition-title {
|
||||
font-weight: bold ;
|
||||
font-family: sans-serif }
|
||||
|
||||
div.attention p.admonition-title, div.caution p.admonition-title,
|
||||
div.danger p.admonition-title, div.error p.admonition-title,
|
||||
div.warning p.admonition-title, .code .error {
|
||||
color: red ;
|
||||
font-weight: bold ;
|
||||
font-family: sans-serif }
|
||||
|
||||
/* Uncomment (and remove this text!) to get reduced vertical space in
|
||||
compound paragraphs.
|
||||
div.compound .compound-first, div.compound .compound-middle {
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
div.compound .compound-last, div.compound .compound-middle {
|
||||
margin-top: 0.5em }
|
||||
*/
|
||||
|
||||
div.dedication {
|
||||
margin: 2em 5em ;
|
||||
text-align: center ;
|
||||
font-style: italic }
|
||||
|
||||
div.dedication p.topic-title {
|
||||
font-weight: bold ;
|
||||
font-style: normal }
|
||||
|
||||
div.figure {
|
||||
margin-left: 2em ;
|
||||
margin-right: 2em }
|
||||
|
||||
div.footer, div.header {
|
||||
clear: both;
|
||||
font-size: smaller }
|
||||
|
||||
div.line-block {
|
||||
display: block ;
|
||||
margin-top: 1em ;
|
||||
margin-bottom: 1em }
|
||||
|
||||
div.line-block div.line-block {
|
||||
margin-top: 0 ;
|
||||
margin-bottom: 0 ;
|
||||
margin-left: 1.5em }
|
||||
|
||||
div.sidebar {
|
||||
margin: 0 0 0.5em 1em ;
|
||||
border: medium outset ;
|
||||
padding: 1em ;
|
||||
background-color: #ffffee ;
|
||||
width: 40% ;
|
||||
float: right ;
|
||||
clear: right }
|
||||
|
||||
div.sidebar p.rubric {
|
||||
font-family: sans-serif ;
|
||||
font-size: medium }
|
||||
|
||||
div.system-messages {
|
||||
margin: 5em }
|
||||
|
||||
div.system-messages h1 {
|
||||
color: red }
|
||||
|
||||
div.system-message {
|
||||
border: medium outset ;
|
||||
padding: 1em }
|
||||
|
||||
div.system-message p.system-message-title {
|
||||
color: red ;
|
||||
font-weight: bold }
|
||||
|
||||
div.topic {
|
||||
margin: 2em }
|
||||
|
||||
h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
|
||||
h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
|
||||
margin-top: 0.4em }
|
||||
|
||||
h1.title {
|
||||
text-align: center }
|
||||
|
||||
h2.subtitle {
|
||||
text-align: center }
|
||||
|
||||
hr.docutils {
|
||||
width: 75% }
|
||||
|
||||
img.align-left, .figure.align-left, object.align-left, table.align-left {
|
||||
clear: left ;
|
||||
float: left ;
|
||||
margin-right: 1em }
|
||||
|
||||
img.align-right, .figure.align-right, object.align-right, table.align-right {
|
||||
clear: right ;
|
||||
float: right ;
|
||||
margin-left: 1em }
|
||||
|
||||
img.align-center, .figure.align-center, object.align-center {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
table.align-center {
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
.align-left {
|
||||
text-align: left }
|
||||
|
||||
.align-center {
|
||||
clear: both ;
|
||||
text-align: center }
|
||||
|
||||
.align-right {
|
||||
text-align: right }
|
||||
|
||||
/* reset inner alignment in figures */
|
||||
div.align-right {
|
||||
text-align: inherit }
|
||||
|
||||
/* div.align-center * { */
|
||||
/* text-align: left } */
|
||||
|
||||
.align-top {
|
||||
vertical-align: top }
|
||||
|
||||
.align-middle {
|
||||
vertical-align: middle }
|
||||
|
||||
.align-bottom {
|
||||
vertical-align: bottom }
|
||||
|
||||
ol.simple, ul.simple {
|
||||
margin-bottom: 1em }
|
||||
|
||||
ol.arabic {
|
||||
list-style: decimal }
|
||||
|
||||
ol.loweralpha {
|
||||
list-style: lower-alpha }
|
||||
|
||||
ol.upperalpha {
|
||||
list-style: upper-alpha }
|
||||
|
||||
ol.lowerroman {
|
||||
list-style: lower-roman }
|
||||
|
||||
ol.upperroman {
|
||||
list-style: upper-roman }
|
||||
|
||||
p.attribution {
|
||||
text-align: right ;
|
||||
margin-left: 50% }
|
||||
|
||||
p.caption {
|
||||
font-style: italic }
|
||||
|
||||
p.credits {
|
||||
font-style: italic ;
|
||||
font-size: smaller }
|
||||
|
||||
p.label {
|
||||
white-space: nowrap }
|
||||
|
||||
p.rubric {
|
||||
font-weight: bold ;
|
||||
font-size: larger ;
|
||||
color: maroon ;
|
||||
text-align: center }
|
||||
|
||||
p.sidebar-title {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold ;
|
||||
font-size: larger }
|
||||
|
||||
p.sidebar-subtitle {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold }
|
||||
|
||||
p.topic-title {
|
||||
font-weight: bold }
|
||||
|
||||
pre.address {
|
||||
margin-bottom: 0 ;
|
||||
margin-top: 0 ;
|
||||
font: inherit }
|
||||
|
||||
pre.literal-block, pre.doctest-block, pre.math, pre.code {
|
||||
margin-left: 2em ;
|
||||
margin-right: 2em }
|
||||
|
||||
pre.code .ln { color: grey; } /* line numbers */
|
||||
pre.code, code { background-color: #eeeeee }
|
||||
pre.code .comment, code .comment { color: #5C6576 }
|
||||
pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
|
||||
pre.code .literal.string, code .literal.string { color: #0C5404 }
|
||||
pre.code .name.builtin, code .name.builtin { color: #352B84 }
|
||||
pre.code .deleted, code .deleted { background-color: #DEB0A1}
|
||||
pre.code .inserted, code .inserted { background-color: #A3D289}
|
||||
|
||||
span.classifier {
|
||||
font-family: sans-serif ;
|
||||
font-style: oblique }
|
||||
|
||||
span.classifier-delimiter {
|
||||
font-family: sans-serif ;
|
||||
font-weight: bold }
|
||||
|
||||
span.interpreted {
|
||||
font-family: sans-serif }
|
||||
|
||||
span.option {
|
||||
white-space: nowrap }
|
||||
|
||||
span.pre {
|
||||
white-space: pre }
|
||||
|
||||
span.problematic {
|
||||
color: red }
|
||||
|
||||
span.section-subtitle {
|
||||
/* font-size relative to parent (h1..h6 element) */
|
||||
font-size: 80% }
|
||||
|
||||
table.citation {
|
||||
border-left: solid 1px gray;
|
||||
margin-left: 1px }
|
||||
|
||||
table.docinfo {
|
||||
margin: 2em 4em }
|
||||
|
||||
table.docutils {
|
||||
margin-top: 0.5em ;
|
||||
margin-bottom: 0.5em }
|
||||
|
||||
table.footnote {
|
||||
border-left: solid 1px black;
|
||||
margin-left: 1px }
|
||||
|
||||
table.docutils td, table.docutils th,
|
||||
table.docinfo td, table.docinfo th {
|
||||
padding-left: 0.5em ;
|
||||
padding-right: 0.5em ;
|
||||
vertical-align: top }
|
||||
|
||||
table.docutils th.field-name, table.docinfo th.docinfo-name {
|
||||
font-weight: bold ;
|
||||
text-align: left ;
|
||||
white-space: nowrap ;
|
||||
padding-left: 0 }
|
||||
|
||||
/* "booktabs" style (no vertical lines) */
|
||||
table.docutils.booktabs {
|
||||
border: 0px;
|
||||
border-top: 2px solid;
|
||||
border-bottom: 2px solid;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
table.docutils.booktabs * {
|
||||
border: 0px;
|
||||
}
|
||||
table.docutils.booktabs th {
|
||||
border-bottom: thin solid;
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
|
||||
h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
|
||||
font-size: 100% }
|
||||
|
||||
ul.auto-toc {
|
||||
list-style-type: none }
|
||||
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="document" id="web-domain-field">
|
||||
<h1 class="title">Web Domain Field</h1>
|
||||
|
||||
<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! This file is generated by oca-gen-addon-readme !!
|
||||
!! changes will be overwritten. !!
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
|
||||
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/web/tree/16.0/web_domain_field"><img alt="OCA/web" src="https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/web-16-0/web-16-0-web_domain_field"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/162/16.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
|
||||
<p>This technical addon allows developers to specify a field domain in a view
|
||||
using the value of another field in that view, rather than as a static
|
||||
XML attribute.</p>
|
||||
<p><strong>Table of contents</strong></p>
|
||||
<div class="contents local topic" id="contents">
|
||||
<ul class="simple">
|
||||
<li><a class="reference internal" href="#usage" id="id1">Usage</a></li>
|
||||
<li><a class="reference internal" href="#bug-tracker" id="id2">Bug Tracker</a></li>
|
||||
<li><a class="reference internal" href="#credits" id="id3">Credits</a><ul>
|
||||
<li><a class="reference internal" href="#authors" id="id4">Authors</a></li>
|
||||
<li><a class="reference internal" href="#contributors" id="id5">Contributors</a></li>
|
||||
<li><a class="reference internal" href="#maintainers" id="id6">Maintainers</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="usage">
|
||||
<h1><a class="toc-backref" href="#id1">Usage</a></h1>
|
||||
<p>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.</p>
|
||||
<pre class="code xml literal-block">
|
||||
<span class="nt"><field</span> <span class="na">name=</span><span class="s">"product_id"</span> <span class="na">domain=</span><span class="s">"[('type','=','product')]"</span><span class="nt">/></span>
|
||||
</pre>
|
||||
<p>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.</p>
|
||||
<p>In this context it’s hard to build complex domain and we are facing to some
|
||||
limitations as:</p>
|
||||
<blockquote>
|
||||
<ul class="simple">
|
||||
<li>The syntax to include in your domain a criteria involving values from a
|
||||
x2many field is complex.</li>
|
||||
<li>The right side of domain in case of x2many can involve huge amount of ids
|
||||
(performance problem).</li>
|
||||
<li>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.</li>
|
||||
<li>It’s not possible to extend an existing domain. You must completely redefine
|
||||
the domain in your specialized addon</li>
|
||||
<li>etc…</li>
|
||||
</ul>
|
||||
</blockquote>
|
||||
<p>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.</p>
|
||||
<pre class="code xml literal-block">
|
||||
<span class="nt"><field</span> <span class="na">name=</span><span class="s">"product_id_domain"</span> <span class="na">invisible=</span><span class="s">"1"</span><span class="nt">/></span>
|
||||
<span class="nt"><field</span> <span class="na">name=</span><span class="s">"product_id"</span> <span class="na">domain=</span><span class="s">"product_id_domain"</span><span class="nt">/></span>
|
||||
</pre>
|
||||
<p>The field used as domain must provide the domain as a JSON encoded string.</p>
|
||||
<pre class="code python literal-block">
|
||||
<span class="n">product_id_domain</span> <span class="o">=</span> <span class="n">fields</span><span class="o">.</span><span class="n">Char</span><span class="p">(</span>
|
||||
<span class="n">compute</span><span class="o">=</span><span class="s2">"_compute_product_id_domain"</span><span class="p">,</span>
|
||||
<span class="n">readonly</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
|
||||
<span class="n">store</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span>
|
||||
<span class="p">)</span>
|
||||
|
||||
<span class="nd">@api</span><span class="o">.</span><span class="n">depends</span><span class="p">(</span><span class="s1">'name'</span><span class="p">)</span>
|
||||
<span class="k">def</span> <span class="nf">_compute_product_id_domain</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
||||
<span class="k">for</span> <span class="n">rec</span> <span class="ow">in</span> <span class="bp">self</span><span class="p">:</span>
|
||||
<span class="n">rec</span><span class="o">.</span><span class="n">product_id_domain</span> <span class="o">=</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span>
|
||||
<span class="p">[(</span><span class="s1">'type'</span><span class="p">,</span> <span class="s1">'='</span><span class="p">,</span> <span class="s1">'product'</span><span class="p">),</span> <span class="p">(</span><span class="s1">'name'</span><span class="p">,</span> <span class="s1">'like'</span><span class="p">,</span> <span class="n">rec</span><span class="o">.</span><span class="n">name</span><span class="p">)]</span>
|
||||
<span class="p">)</span>
|
||||
</pre>
|
||||
<div class="admonition note">
|
||||
<p class="first admonition-title">Note</p>
|
||||
<p>You do not actually need this module to craft a dynamic domain. Odoo comes
|
||||
with its own <a class="reference external" href="https://github.com/odoo/odoo/tree/16.0/addons/web/static/lib/py.js">py.js</a>
|
||||
web library to parse expressions such as domains. <cite>py.js</cite> supports more
|
||||
complex expressions than just static lists.</p>
|
||||
<p>Here is an example of a conditional domain based on the value of another
|
||||
field:</p>
|
||||
<pre class="code python literal-block">
|
||||
<span class="p">(</span><span class="n">order_id</span> <span class="ow">or</span> <span class="n">partner_id</span><span class="p">)</span> <span class="ow">and</span> <span class="p">[(</span><span class="s1">'id'</span><span class="p">,</span> <span class="s1">'in'</span><span class="p">,</span> <span class="n">allowed_picking_ids</span><span class="p">)]</span>
|
||||
<span class="ow">or</span> <span class="p">[(</span><span class="s1">'state'</span><span class="p">,</span> <span class="s1">'='</span><span class="p">,</span> <span class="s1">'done'</span><span class="p">),</span> <span class="p">(</span><span class="s1">'picking_type_id.code'</span><span class="p">,</span> <span class="s1">'='</span><span class="p">,</span> <span class="s1">'outgoing'</span><span class="p">)]</span>
|
||||
</pre>
|
||||
<p class="last">For OCA modules, this method is preferred over adding this module as an
|
||||
additional dependency.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="bug-tracker">
|
||||
<h1><a class="toc-backref" href="#id2">Bug Tracker</a></h1>
|
||||
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/web/issues">GitHub Issues</a>.
|
||||
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
|
||||
<a class="reference external" href="https://github.com/OCA/web/issues/new?body=module:%20web_domain_field%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
|
||||
<p>Do not contact contributors directly about support or help with technical issues.</p>
|
||||
</div>
|
||||
<div class="section" id="credits">
|
||||
<h1><a class="toc-backref" href="#id3">Credits</a></h1>
|
||||
<div class="section" id="authors">
|
||||
<h2><a class="toc-backref" href="#id4">Authors</a></h2>
|
||||
<ul class="simple">
|
||||
<li>ACSONE SA/NV</li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="contributors">
|
||||
<h2><a class="toc-backref" href="#id5">Contributors</a></h2>
|
||||
<ul class="simple">
|
||||
<li>Laurent Mignon <<a class="reference external" href="mailto:laurent.mignon@acsone.eu">laurent.mignon@acsone.eu</a>></li>
|
||||
<li>Denis Roussel <<a class="reference external" href="mailto:denis.roussel@acsone.eu">denis.roussel@acsone.eu</a>></li>
|
||||
<li>Raf Ven <<a class="reference external" href="mailto:raf.ven@dynapps.be">raf.ven@dynapps.be</a>></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="section" id="maintainers">
|
||||
<h2><a class="toc-backref" href="#id6">Maintainers</a></h2>
|
||||
<p>This module is maintained by the OCA.</p>
|
||||
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
|
||||
<p>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.</p>
|
||||
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/web/tree/16.0/web_domain_field">OCA/web</a> project on GitHub.</p>
|
||||
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,212 @@
|
|||
odoo.define('web.domain_field', function (require) {
|
||||
"use strict";
|
||||
|
||||
var py_utils = require('web.py_utils');
|
||||
var session = require('web.session');
|
||||
|
||||
|
||||
var original_pyeval = py_utils.eval;
|
||||
var py = window.py;
|
||||
|
||||
/** Copied from py_utils and not modified but required since not publicly
|
||||
exposed by web.py_utils**/
|
||||
|
||||
// recursively wraps JS objects passed into the context to attributedicts
|
||||
// which jsonify back to JS objects
|
||||
function wrap(value) {
|
||||
if (value === null) { return py.None; }
|
||||
|
||||
switch (typeof value) {
|
||||
case 'undefined': throw new Error("No conversion for undefined");
|
||||
case 'boolean': return py.bool.fromJSON(value);
|
||||
case 'number': return py.float.fromJSON(value);
|
||||
case 'string': return py.str.fromJSON(value);
|
||||
}
|
||||
|
||||
switch(value.constructor) {
|
||||
case Object: return wrapping_dict.fromJSON(value);
|
||||
case Array: return wrapping_list.fromJSON(value);
|
||||
}
|
||||
|
||||
throw new Error("ValueError: unable to wrap " + value);
|
||||
}
|
||||
|
||||
var wrapping_dict = py.type('wrapping_dict', null, {
|
||||
__init__: function () {
|
||||
this._store = {};
|
||||
},
|
||||
__getitem__: function (key) {
|
||||
var k = key.toJSON();
|
||||
if (!(k in this._store)) {
|
||||
throw new Error("KeyError: '" + k + "'");
|
||||
}
|
||||
return wrap(this._store[k]);
|
||||
},
|
||||
__getattr__: function (key) {
|
||||
return this.__getitem__(py.str.fromJSON(key));
|
||||
},
|
||||
__len__: function () {
|
||||
return Object.keys(this._store).length;
|
||||
},
|
||||
__nonzero__: function () {
|
||||
return py.PY_size(this) > 0 ? py.True : py.False;
|
||||
},
|
||||
get: function () {
|
||||
var args = py.PY_parseArgs(arguments, ['k', ['d', py.None]]);
|
||||
|
||||
if (!(args.k.toJSON() in this._store)) { return args.d; }
|
||||
return this.__getitem__(args.k);
|
||||
},
|
||||
fromJSON: function (d) {
|
||||
var instance = py.PY_call(wrapping_dict);
|
||||
instance._store = d;
|
||||
return instance;
|
||||
},
|
||||
toJSON: function () {
|
||||
return this._store;
|
||||
},
|
||||
});
|
||||
|
||||
var wrapping_list = py.type('wrapping_list', null, {
|
||||
__init__: function () {
|
||||
this._store = [];
|
||||
},
|
||||
__getitem__: function (index) {
|
||||
return wrap(this._store[index.toJSON()]);
|
||||
},
|
||||
__len__: function () {
|
||||
return this._store.length;
|
||||
},
|
||||
__nonzero__: function () {
|
||||
return py.PY_size(this) > 0 ? py.True : py.False;
|
||||
},
|
||||
fromJSON: function (ar) {
|
||||
var instance = py.PY_call(wrapping_list);
|
||||
instance._store = ar;
|
||||
return instance;
|
||||
},
|
||||
toJSON: function () {
|
||||
return this._store;
|
||||
},
|
||||
});
|
||||
|
||||
function wrap_context(context) {
|
||||
for (var k in context) {
|
||||
if (!context.hasOwnProperty(k)) { continue; }
|
||||
var val = context[k];
|
||||
// Don't add a test case like ``val === undefined``
|
||||
// this is intended to prevent letting crap pass
|
||||
// on the context without even knowing it.
|
||||
// If you face an issue from here, try to sanitize
|
||||
// the context upstream instead
|
||||
if (val === null) { continue; }
|
||||
if (val.constructor === Array) {
|
||||
context[k] = wrapping_list.fromJSON(val);
|
||||
} else if (val.constructor === Object
|
||||
&& !py.PY_isInstance(val, py.object)) {
|
||||
context[k] = wrapping_dict.fromJSON(val);
|
||||
}
|
||||
}
|
||||
return context;
|
||||
}
|
||||
|
||||
function ensure_evaluated(args, kwargs) {
|
||||
for (var i=0; i<args.length; ++i) {
|
||||
args[i] = eval_arg(args[i]);
|
||||
}
|
||||
for (var k in kwargs) {
|
||||
if (!kwargs.hasOwnProperty(k)) { continue; }
|
||||
kwargs[k] = eval_arg(kwargs[k]);
|
||||
}
|
||||
}
|
||||
/** End of unmodified methods copied from pyeval **/
|
||||
|
||||
// We need to override the original method to be able to call our
|
||||
// Specialized version of pyeval for domain fields
|
||||
function eval_arg (arg) {
|
||||
if (typeof arg !== 'object' || !arg.__ref) {
|
||||
return arg;
|
||||
}
|
||||
switch (arg.__ref) {
|
||||
case 'domain': case 'compound_domain':
|
||||
return domain_field_pyeval('domains', [arg]);
|
||||
case 'context': case 'compound_context':
|
||||
return original_pyeval('contexts', [arg]);
|
||||
default:
|
||||
throw new Error(_t("Unknown nonliteral type ") + ' ' + arg.__ref);
|
||||
}
|
||||
}
|
||||
|
||||
// Override eval_domains to add 3 lines in order to be able to use a field
|
||||
// value as domain
|
||||
function eval_domains(domains, evaluation_context) {
|
||||
evaluation_context = _.extend(py_utils.context(), evaluation_context || {});
|
||||
var result_domain = [];
|
||||
// Normalize only if the first domain is the array ["|"] or ["!"]
|
||||
var need_normalization = (
|
||||
domains &&
|
||||
domains.length > 0 &&
|
||||
domains[0].length === 1 &&
|
||||
(domains[0][0] === "|" || domains[0][0] === "!")
|
||||
);
|
||||
_(domains).each(function (domain) {
|
||||
if (_.isString(domain)) {
|
||||
// Modified part or the original method
|
||||
if (domain in evaluation_context) {
|
||||
result_domain.push.apply(
|
||||
result_domain, $.parseJSON(evaluation_context[domain]));
|
||||
return;
|
||||
}
|
||||
// End of modifications
|
||||
|
||||
// wrap raw strings in domain
|
||||
domain = { __ref: 'domain', __debug: domain };
|
||||
}
|
||||
var domain_array_to_combine;
|
||||
switch(domain.__ref) {
|
||||
case 'domain':
|
||||
evaluation_context.context = evaluation_context;
|
||||
domain_array_to_combine = py.eval(domain.__debug, wrap_context(evaluation_context));
|
||||
break;
|
||||
default:
|
||||
domain_array_to_combine = domain;
|
||||
}
|
||||
if (need_normalization) {
|
||||
domain_array_to_combine = get_normalized_domain(domain_array_to_combine);
|
||||
}
|
||||
result_domain.push.apply(result_domain, domain_array_to_combine);
|
||||
});
|
||||
return result_domain;
|
||||
}
|
||||
|
||||
|
||||
// Override pyeval in order to call our specialized implementation of
|
||||
// eval_domains
|
||||
function domain_field_pyeval (type, object, context, options) {
|
||||
switch (type) {
|
||||
case 'domain':
|
||||
case 'domains':
|
||||
if (type === 'domain') {
|
||||
object = [object];
|
||||
}
|
||||
return eval_domains(object, context);
|
||||
default:
|
||||
return original_pyeval(type, object, context, options);
|
||||
}
|
||||
}
|
||||
|
||||
function eval_domains_and_contexts(source) {
|
||||
// see Session.eval_context in Python
|
||||
return {
|
||||
context: domain_field_pyeval('contexts', source.contexts || [], source.eval_context),
|
||||
domain: domain_field_pyeval('domains', source.domains, source.eval_context),
|
||||
group_by: domain_field_pyeval('groupbys', source.group_by_seq || [], source.eval_context),
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
py_utils.eval = domain_field_pyeval;
|
||||
py_utils.ensure_evaluated = ensure_evaluated;
|
||||
py_utils.eval_domains_and_contexts = eval_domains_and_contexts;
|
||||
|
||||
});
|
||||
|
|
@ -0,0 +1,129 @@
|
|||
odoo.define("web_domain_field.tests", function (require) {
|
||||
"use strict";
|
||||
|
||||
const FormView = require("web.FormView");
|
||||
const testUtils = require("web.test_utils");
|
||||
const {createView} = testUtils;
|
||||
const {QUnit} = window;
|
||||
|
||||
QUnit.module(
|
||||
"web_domain_field",
|
||||
{
|
||||
beforeEach: function () {
|
||||
this.data = {
|
||||
"res.partner": {
|
||||
fields: {
|
||||
name: {
|
||||
string: "Name",
|
||||
type: "char",
|
||||
searchable: true,
|
||||
},
|
||||
type: {
|
||||
string: "Type",
|
||||
type: "selection",
|
||||
selection: [
|
||||
["person", "Person"],
|
||||
["company", "Company"],
|
||||
],
|
||||
searchable: true,
|
||||
},
|
||||
parent_id: {
|
||||
string: "Parent",
|
||||
type: "many2one",
|
||||
relation: "res.partner",
|
||||
},
|
||||
parent_domain: {
|
||||
string: "Parent Domain",
|
||||
type: "char",
|
||||
},
|
||||
},
|
||||
records: [
|
||||
{
|
||||
id: 1,
|
||||
name: "John Doe",
|
||||
type: "person",
|
||||
parent_id: 2,
|
||||
parent_domain: "[]",
|
||||
},
|
||||
{
|
||||
id: 2,
|
||||
name: "ACME inc.",
|
||||
type: "company",
|
||||
parent_id: false,
|
||||
parent_domain: `[["type", "=", "company"]]`,
|
||||
},
|
||||
],
|
||||
onchanges: {},
|
||||
},
|
||||
};
|
||||
},
|
||||
},
|
||||
function () {
|
||||
QUnit.test(
|
||||
"one2many: field as domain attribute value",
|
||||
async function (assert) {
|
||||
assert.expect(2);
|
||||
|
||||
async function testPartnerFormDomain(data, resId, expectedDomain) {
|
||||
const form = await createView({
|
||||
View: FormView,
|
||||
model: "res.partner",
|
||||
data: data,
|
||||
arch: `
|
||||
<form>
|
||||
<field name="parent_domain" invisible="1" />
|
||||
<field name="parent_id" domain="parent_domain" />
|
||||
</form>
|
||||
`,
|
||||
mockRPC: function (route, args) {
|
||||
if (args.method === "name_search") {
|
||||
assert.deepEqual(args.kwargs.args, expectedDomain);
|
||||
}
|
||||
return this._super.apply(this, arguments);
|
||||
},
|
||||
res_id: resId,
|
||||
viewOptions: {mode: "edit"},
|
||||
});
|
||||
form.$el.find(".o_field_widget[name=parent_id] input").click();
|
||||
form.destroy();
|
||||
}
|
||||
|
||||
await testPartnerFormDomain(this.data, 1, []);
|
||||
await testPartnerFormDomain(this.data, 2, [
|
||||
["type", "=", "company"],
|
||||
]);
|
||||
}
|
||||
);
|
||||
|
||||
QUnit.test(
|
||||
"one2many: field with default behaviour",
|
||||
async function (assert) {
|
||||
assert.expect(1);
|
||||
const form = await createView({
|
||||
View: FormView,
|
||||
model: "res.partner",
|
||||
data: this.data,
|
||||
arch: `
|
||||
<form>
|
||||
<field name="parent_domain" invisible="1" />
|
||||
<field name="parent_id" domain="[('name', '=', 'John')]" />
|
||||
</form>
|
||||
`,
|
||||
mockRPC: function (route, args) {
|
||||
if (args.method === "name_search") {
|
||||
assert.deepEqual(args.kwargs.args, [
|
||||
["name", "=", "John"],
|
||||
]);
|
||||
}
|
||||
return this._super.apply(this, arguments);
|
||||
},
|
||||
res_id: 1,
|
||||
viewOptions: {mode: "edit"},
|
||||
});
|
||||
form.$el.find(".o_field_widget[name=parent_id] input").click();
|
||||
form.destroy();
|
||||
}
|
||||
);
|
||||
}
|
||||
);
|
||||
});
|
||||
|
|
@ -0,0 +1 @@
|
|||
from . import test_qunit
|
||||
|
|
@ -0,0 +1,16 @@
|
|||
# Copyright 2022 Camptocamp SA (https://www.camptocamp.com).
|
||||
# @author Iván Todorovich <ivan.todorovich@camptocamp.com>
|
||||
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
|
||||
|
||||
from odoo.tests import HttpCase, tagged
|
||||
|
||||
|
||||
@tagged("-at_install", "post_install")
|
||||
class TestQunit(HttpCase):
|
||||
def test_qunit(self):
|
||||
self.browser_js(
|
||||
"/web/tests?module=web_domain_field&failfast",
|
||||
"",
|
||||
"",
|
||||
login="admin",
|
||||
)
|
||||
Loading…
Reference in New Issue