pengyuthon/odoo_source
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[FIX] doc: formatting/rendering issues

Browse Source 
This commits solves different rendering issues in the javascript reference
documentation, following the work done in #57270, but for issues added in
further versions and missed in the forward-port.

Forward-port of #57758
Forward-port of #57775

closes odoo/odoo#57835

X-original-commit: 8885cf578468d34e740bada95440f092f10c6268
Signed-off-by: Victor Feyens (vfe) <vfe@odoo.com>
This commit is contained in:
Raf Geens
2020-09-16 11:47:15 +00:00
committed by Victor Feyens
parent 9d8ed8d001
commit 3380ea7964
1 changed files with 58 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/reference/javascript_reference.rst
+58 -58
View File
@@ -2305,10 +2305,10 @@ menu bar. It can have a control panel, if necessary. Defining a client action
can be done in two steps: implementing a new widget, and registering the widget
in the action registry.
- Implementing a new client action:
This is done by creating a widget:
Implementing a new client action.
This is done by creating a widget:
.. code-block:: javascript
.. code-block:: javascript
var AbstractAction = require('web.AbstractAction');
@@ -2317,27 +2317,27 @@ in the action registry.
...
});
- Registering the client action:
As usual, we need to make the web client aware of the mapping between
client actions and the actual class:
Registering the client action:
As usual, we need to make the web client aware of the mapping between
client actions and the actual class:
.. code-block:: javascript
.. code-block:: javascript
var core = require('web.core');
var core = require('web.core');
core.action_registry.add('my-custom-action', ClientAction);
core.action_registry.add('my-custom-action', ClientAction);
Then, to use the client action in the web client, we need to create a client
action record (a record of the model ``ir.actions.client``) with the proper
``tag`` attribute:
Then, to use the client action in the web client, we need to create a client
action record (a record of the model ``ir.actions.client``) with the proper
``tag`` attribute:
.. code-block:: xml
.. code-block:: xml
<record id="my_client_action" model="ir.actions.client">
<field name="name">Some Name</field>
<field name="tag">my-custom-action</field>
</record>
<record id="my_client_action" model="ir.actions.client">
<field name="name">Some Name</field>
<field name="tag">my-custom-action</field>
</record>
Using the control panel
@@ -2347,56 +2347,56 @@ By default, the client action does not display a control panel. In order to
do that, several steps should be done.
- Set the *hasControlPanel* to *true*.
In the widget code:
In the widget code:
.. code-block:: javascript
.. code-block:: javascript
var MyClientAction = AbstractAction.extend({
hasControlPanel: true,
loadControlPanel: true, // default: false
...
});
var MyClientAction = AbstractAction.extend({
hasControlPanel: true,
loadControlPanel: true, // default: false
...
});
.. warning::
when the ``loadControlPanel`` is set to true, the client action will automatically get the content of a search view or a control panel view.
In this case, a model name should be specified like this:
.. warning::
when the ``loadControlPanel`` is set to true, the client action will automatically get the content of a search view or a control panel view.
In this case, a model name should be specified like this:
.. code-block:: javascript
.. code-block:: javascript
init: function (parent, action, options) {
...
this.controlPanelParams.modelName = 'model.name';
...
}
init: function (parent, action, options) {
...
this.controlPanelParams.modelName = 'model.name';
...
}
- Call the method *updateControlPanel* whenever we need to update the control panel.
For example:
For example:
.. code-block:: javascript
.. code-block:: javascript
var SomeClientAction = Widget.extend({
hasControlPanel: true,
...
start: function () {
this._renderButtons();
this._update_control_panel();
...
},
do_show: function () {
...
this._update_control_panel();
},
_renderButtons: function () {
this.$buttons = $(QWeb.render('SomeTemplate.Buttons'));
this.$buttons.on('click', ...);
},
_update_control_panel: function () {
this.updateControlPanel({
cp_content: {
$buttons: this.$buttons,
},
});
}
var SomeClientAction = Widget.extend({
hasControlPanel: true,
...
start: function () {
this._renderButtons();
this._update_control_panel();
...
},
do_show: function () {
...
this._update_control_panel();
},
_renderButtons: function () {
this.$buttons = $(QWeb.render('SomeTemplate.Buttons'));
this.$buttons.on('click', ...);
},
_update_control_panel: function () {
this.updateControlPanel({
cp_content: {
$buttons: this.$buttons,
},
});
}
The ``updateControlPanel`` is the main method to customize the content in controlpanel.
For more information, look into the `control_panel_renderer.js <https://github.com/odoo/odoo/blob/13.0/addons/web/static/src/js/views/control_panel/control_panel_renderer.js#L130>`_ file.