Skip to main content

Multi-Steps Wizards

Project description

This module is a base for creating multi-steps wizards. It does nothing by itself.

Example of class:

class MyWizard(models.TransientModel):
    _name = 'my.wizard'
    _inherit = ['multi.step.wizard.mixin']

    project_id = fields.Many2one(
        comodel_name='project.project',
        name="Project",
        required=True,
        ondelete='cascade',
        default=lambda self: self._default_project_id(),
    )
    name = fields.Char()
    field1 = fields.Char()
    field2 = fields.Char()
    field3 = fields.Char()

    @api.model
    def _selection_state(self):
        return [
            ('start', 'Start'),
            ('configure', 'Configure'),
            ('custom', 'Customize'),
            ('final', 'Final'),
        ]

    @api.model
    def _default_project_id(self):
        return self.env.context.get('active_id')

    def state_exit_start(self):
        self.state = 'configure'

    def state_exit_configure(self):
        self.state = 'custom'

    def state_exit_custom(self):
        self.state = 'final'

Example of view (note the mode, must be primary):

<?xml version="1.0" encoding="utf-8"?>
<odoo>

  <record id="my_wizard_form" model="ir.ui.view">
    <field name="name">my.wizard.form</field>
    <field name="model">my.wizard</field>
    <field name="mode">primary</field>
    <field name="inherit_id" ref="multi_step_wizard.multi_step_wizard_form"/>
    <field name="arch" type="xml">
      <xpath expr="//footer" position="before">
        <h1>
          <field name="name"
                attrs="{'readonly': [('state', '!=', 'start')]}"
                class="oe_inline"
                placeholder="Name"/>
        </h1>
        <group name="configure" attrs="{'invisible': [('state', '!=', 'configure')]}">
          <group>
            <field name="field1"/>
            <field name="field2"/>
          </group>
        </group>
        <group name="custom" attrs="{'invisible': [('state', '!=', 'custom')]}">
          <group>
            <field name="field3"/>
          </group>
        </group>
        <div name="final" attrs="{'invisible': [('state', '!=', 'final')]}">
          <p>The project is now configured.</p>
        </div>
      </xpath>
    </field>
  </record>

  <act_window id="open_my_wizard"
              name="My Wizard"
              res_model="my.wizard"
              src_model="project.project"
              view_mode="form" target="new" view_type="form" />
</odoo>

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file odoo11_addon_multi_step_wizard-11.0.1.1.1.99.dev1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for odoo11_addon_multi_step_wizard-11.0.1.1.1.99.dev1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 354203a099087e32f0a186d059517b1ca6f7b314dfe42c804f6933410af725c4
MD5 0881fc4525b4f8f6962825b50340a553
BLAKE2b-256 8216e31ad8ecd0abbe9b5e163dc125ceba93469dcb5ff3e43887eb643f402bd1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page