Gadget API

Class: WizardStep

otris.gadget.gui. WizardStep

Constructs a wizard step

The gadget used for the wizard step should have a client function that returns
the step data (The data which should be saved in this step).
dataClientFunction must then contain the name of the client function.
If the dataClientFunction returns false the progress to the next step is aborted.
For the form gadget (otris.gadget.gui.Form) a default implementation of the data client function is used. In this
case it is not necessary to implement your own function. If you still specify a function name
you have to validate and serialize the form data by yourself.
On all other gadgets the step does not save any data if the dataClientFunction is missing.

Constructors

Name Type Description
id string optional
label string optional
gadgetConfig object | string optional

gadget config (object) or gadgetAction (string).
dataClientFunction string optional

Name of the client function that provides the step data

Methods

addInfo(info)

Add info content for the step. The content is displayed in a extra column or row.

Name Type Description
info object
Name Type Description
title string optional

Adds a title to the info content (html markup is allowed)
text string optional

Adds text to the info content (html markup is allowed)
html string optional

Adds html content to the info content