l.a.b.m.MultiStepView(LaunchpadView) : class documentation

Part of lp.app.browser.multistep View In Hierarchy

Known subclasses: lp.bugs.browser.bugalsoaffects.BugAlsoAffectsDistroMetaView, lp.bugs.browser.bugalsoaffects.BugAlsoAffectsProductMetaView, lp.registry.browser.product.ProductAddView, lp.registry.browser.sourcepackage.SourcePackageChangeUpstreamView

Meta-view for implementing wizard-like multiple step views.

This view implements a wizard-like workflow in which the controller specifies the first step, and each step is responsible for specifying the next_step. A step should normally start with None as its next_step (the default) to post back to itself, then set next_step to the appropriate view class in its main_action() method. The last step should leave next_step as None to end the wizard.

Any views used as steps here must inherit from StepView. The views are responsible for injecting state information into the request, for anything that subsequent views will need.

Method first_step Return the view class for the first step in the wizard.
Method page_title Must override in subclasses for breadcrumbs to work.
Method getIsStepDict Return a dict of step numbers with the current step set to True.
Method initialize Initialize the view and handle stepping through sub-views.
Method render Undocumented
@property
def first_step(self):
Return the view class for the first step in the wizard.
ReturnsA subclass of StepView (type: StepView)
@property
def page_title(self):
Must override in subclasses for breadcrumbs to work.
def getIsStepDict(self):
Return a dict of step numbers with the current step set to True.

This is a path traversal friendly mechanism to ask: <tal:x condition="view/is_step/2">

def initialize(self):
Initialize the view and handle stepping through sub-views.
def render(self):
Undocumented
API Documentation for Launchpad, generated by pydoctor at 2019-08-20 00:00:04.