You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

187 lines
6.4 KiB

10 years ago
10 years ago
10 years ago
10 years ago
  1. .. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
  2. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  3. :alt: License: AGPL-3
  4. ===========================
  5. 2D matrix for x2many fields
  6. ===========================
  7. This module allows to show an x2many field with 3-tuples
  8. ($x_value, $y_value, $value) in a table
  9. +-----------+-------------+-------------+
  10. | | $x_value1 | $x_value2 |
  11. +-----------+-------------+-------------+
  12. | $y_value1 | $value(1/1) | $value(2/1) |
  13. +-----------+-------------+-------------+
  14. | $y_value2 | $value(1/2) | $value(2/2) |
  15. +-----------+-------------+-------------+
  16. where `value(n/n)` is editable.
  17. An example use case would be: Select some projects and some employees so that
  18. a manager can easily fill in the planned_hours for one task per employee. The
  19. result could look like this:
  20. .. image:: /web_widget_x2many_2d_matrix/static/description/screenshot.png
  21. :alt: Screenshot
  22. The beauty of this is that you have an arbitrary amount of columns with this
  23. widget, trying to get this in standard x2many lists involves some quite ugly
  24. hacks.
  25. Usage
  26. =====
  27. Use this widget by saying::
  28. <field name="my_field" widget="x2many_2d_matrix" />
  29. This assumes that my_field refers to a model with the fields `x`, `y` and
  30. `value`. If your fields are named differently, pass the correct names as
  31. attributes::
  32. <field name="my_field" widget="x2many_2d_matrix" field_x_axis="my_field1" field_y_axis="my_field2" field_value="my_field3">
  33. <tree>
  34. <field name="my_field"/>
  35. <field name="my_field1"/>
  36. <field name="my_field2"/>
  37. <field name="my_field3"/>
  38. </tree>
  39. </field>
  40. You can pass the following parameters:
  41. field_x_axis
  42. The field that indicates the x value of a point
  43. field_y_axis
  44. The field that indicates the y value of a point
  45. field_label_x_axis
  46. Use another field to display in the table header
  47. field_label_y_axis
  48. Use another field to display in the table header
  49. x_axis_clickable
  50. It indicates if the X axis allows to be clicked for navigating to the field
  51. (if it's a many2one field). True by default
  52. y_axis_clickable
  53. It indicates if the Y axis allows to be clicked for navigating to the field
  54. (if it's a many2one field). True by default
  55. field_value
  56. Show this field as value
  57. show_row_totals
  58. If field_value is a numeric field, it indicates if you want to calculate
  59. row totals. True by default
  60. show_column_totals
  61. If field_value is a numeric field, it indicates if you want to calculate
  62. column totals. True by default
  63. field_att_<name>
  64. Declare as many options prefixed with this string as you need for binding
  65. a field value with an HTML node attribute (disabled, class, style...)
  66. called as the `<name>` passed in the option.
  67. .. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
  68. :alt: Try me on Runbot
  69. :target: https://runbot.odoo-community.org/runbot/162/8.0
  70. Example
  71. =======
  72. You need a data structure already filled with values. Let's assume we want to
  73. use this widget in a wizard that lets the user fill in planned hours for one
  74. task per project per user. In this case, we can use ``project.task`` as our
  75. data model and point to it from our wizard. The crucial part is that we fill
  76. the field in the default function::
  77. from odoo import fields, models
  78. class MyWizard(models.TransientModel):
  79. _name = 'my.wizard'
  80. def _default_task_ids(self):
  81. # your list of project should come from the context, some selection
  82. # in a previous wizard or wherever else
  83. projects = self.env['project.project'].browse([1, 2, 3])
  84. # same with users
  85. users = self.env['res.users'].browse([1, 2, 3])
  86. return [
  87. (0, 0, {
  88. 'project_id': p.id,
  89. 'user_id': u.id,
  90. 'planned_hours': 0,
  91. 'message_needaction': False,
  92. 'date_deadline': fields.Date.today(),
  93. })
  94. # if the project doesn't have a task for the user, create a new one
  95. if not p.task_ids.filtered(lambda x: x.user_id == u) else
  96. # otherwise, return the task
  97. (4, p.task_ids.filtered(lambda x: x.user_id == u)[0].id)
  98. for p in projects
  99. for u in users
  100. ]
  101. task_ids = fields.Many2many('project.task', default=_default_task_ids)
  102. Now in our wizard, we can use::
  103. <field name="task_ids" widget="x2many_2d_matrix" field_x_axis="project_id" field_y_axis="user_id" field_value="planned_hours">
  104. <tree>
  105. <field name="task_ids"/>
  106. <field name="project_id"/>
  107. <field name="user_id"/>
  108. <field name="planned_hours"/>
  109. </tree>
  110. </field>
  111. Note that all values in the matrix must exist, so you need to create them
  112. previously if not present, but you can control visually the editability of
  113. the fields in the matrix through `field_att_disabled` option with a control
  114. field.
  115. Known issues / Roadmap
  116. ======================
  117. * It would be worth trying to instantiate the proper field widget and let it render the input
  118. * Let the widget deal with the missing values of the full Cartesian product,
  119. instead of being forced to pre-fill all the possible values.
  120. * If you pass values with an onchange, you need to overwrite the model's method
  121. `onchange` for making the widget work::
  122. @api.multi
  123. def onchange(self, values, field_name, field_onchange):
  124. if "one2many_field" in field_onchange:
  125. for sub in [<field_list>]:
  126. field_onchange.setdefault("one2many_field." + sub, u"")
  127. return super(model, self).onchange(values, field_name, field_onchange)
  128. Bug Tracker
  129. ===========
  130. Bugs are tracked on `GitHub Issues
  131. <https://github.com/OCA/web/issues>`_. In case of trouble, please
  132. check there if your issue has already been reported. If you spotted it first,
  133. help us smashing it by providing a detailed and welcomed feedback.
  134. Credits
  135. =======
  136. Contributors
  137. ------------
  138. * Holger Brunn <hbrunn@therp.nl>
  139. * Pedro M. Baeza <pedro.baeza@tecnativa.com>
  140. Maintainer
  141. ----------
  142. .. image:: https://odoo-community.org/logo.png
  143. :alt: Odoo Community Association
  144. :target: https://odoo-community.org
  145. This module is maintained by the OCA.
  146. OCA, or the Odoo Community Association, is a nonprofit organization whose
  147. mission is to support the collaborative development of Odoo features and
  148. promote its widespread use.
  149. To contribute to this module, please visit https://odoo-community.org.