Odoo 模块推荐 Multi-Steps Wizards

模块信息

使用体验

class DemoMultiStepWizard(models.TransientModel):
    _name = 'demo.multi.step.wizard'
    _inherit = ['multi.step.wizard.mixin']
    _description = 'Multi Step Wizard Demo'

    step1 = fields.Char('Step 1')
    step2 = fields.Char('Step 2')
    step3 = fields.Char('Step 3')

    @api.model
    def _selection_state(self):
        return [
            ('start', 'Start'),
            ('step2', 'Step 2'),
            ('step3', 'Step 3'),
            ('final', 'Final'),
        ]

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

    def state_exit_step2(self):
        self.state = 'step3'

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

<odoo>
  <data>
    <record model="ir.ui.view" id="multi_step_wizard_demo_form">
      <field name="name">demo.multi.step.wizard.form</field>
      <field name="model">demo.multi.step.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">
          <group name="Start" attrs="{'invisible': [('state', '!=', 'start')]}">
            <group>
              <field name="step1"/>
            </group>
          </group>
          <group name="Step 2" attrs="{'invisible': [('state', '!=', 'step2')]}">
            <group>
              <field name="step2"/>
            </group>
          </group>
          <group name="Step 3" attrs="{'invisible': [('state', '!=', 'step3')]}">
            <group>
              <field name="step3"/>
            </group>
          </group>
          <div name="Final" attrs="{'invisible': [('state', '!=', 'final')]}">
            <p>Done.</p>
          </div>
        </xpath>
      </field>
    </record>

    <record model="ir.actions.act_window" id="action_multi_wizard_demo">
      <field name="name">Multi Step Wizard Demo</field>
      <field name="res_model">demo.multi.step.wizard</field>
      <field name="view_mode">form</field>
      <field name="target">new</field>
    </record>

    <record model="ir.ui.view" id="multi_step_wizard_demo_user_form">
      <field name="name">demo.multi.step.wizard.user.form</field>
      <field name="model">res.users</field>
      <field name="inherit_id" ref="base.view_users_form"/>
      <field name="arch" type="xml">
        <header position="inside">
          <button type="action" name="%(action_multi_wizard_demo)d" string="Multi Wizard" class="oe_highlight"/>
        </header>
      </field>
    </record>
  </data>
</odoo>

适用场景

1. 选择报销类型

2. 填写报销金额

3. 根据报销类型和金额判断是否超过一定数额，是则下一步，否则跳到 5

4. 填写报销超额说明

5. 提交

实现浅析

Mixin to ease the creation of multisteps wizards

_selection_state must return all possible step of
the wizard.

For each state but final, there must be a method named
"state_exit_X" where X is the name of the state. Each
of these method must set the next state in self.state.

The final state has no related method because the view
should only display a button to close the wizard.

open_next and _reopen_self should not need to be
overidden, but _selection_state and state_exit_start
likely will need to.

state = fields.Selection(
    selection='_selection_state',
    default='start',
    required=True,
)

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

def open_next(self):
    state_method = getattr(self, 'state_exit_%s' % (self.state,), None)
    if state_method is None:
        raise NotImplementedError(
            'No method defined for state %s' % (self.state,)
        )
    state_method()
    return self._reopen_self()

def _reopen_self(self):
    return {
        'type': 'ir.actions.act_window',
        'res_model': self._name,
        'res_id': self.id,
        'view_mode': 'form',
        'target': 'new',
    }

<record id="multi_step_wizard_form" model="ir.ui.view">
  <field name="name">multi.step.wizard.form</field>
  <field name="model">multi.step.wizard.mixin</field>
  <field name="arch" type="xml">
    <form>
      <field name="state" invisible="1"/>
      <footer>
        <div name="states_buttons" attrs="{'invisible': [('state', '=', 'final')]}">
          <button name="open_next" string="Next" type="object" class="btn-primary"/>
          <button string="Cancel" class="btn btn-default" special="cancel" />
        </div>
        <div name="final_buttons" attrs="{'invisible': [('state', '!=', 'final')]}">
          <button string="Close" class="btn btn-primary" special="cancel" />
        </div>
      </footer>
    </form>
  </field>
</record>

<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">
    <field name="..."/>
  </xpath>
</field>

Only applies if this view inherits from an other one (inherit_id is not False/Null).

* if extension (default), if this view is requested the closest primary view
is looked up (via inherit_id), then all views inheriting from it with this
view's model are applied

* if primary, the closest primary view is fully resolved (even if it uses a
different model than this one), then this view's inheritance specs
(<xpath/>) are applied, and the result is used as if it were this view's
actual arch.