eLabSDK.Wizard

Classes

Name	Description
initialize

Members

Name	Description
_currentPanel
_previousPanel
_wizardContent	Stores the wizard panels

Functions

Name	Description
addPanel(panel)	Adds a panel to the wizard
nextPanel(panel)	Displays the next panel
insert(config)	Insert a new panel to the currently active wizard
remove(config)	Remove a panel from the currently active wizard
lockNavigation(config)	Prevent the user from moving to a previous/next panel
unLockNavigation(config)	Re-enable navigation
start()	Starts the wizard, creates the dialog and adds the contents stored in _wizardContent
close()	Close the wizard, closes the dialog
_checkForRequiredData(panel)	Check if required data is availale to launch the wizard panel, display a log if logging enabled
_createMainContainer(panel)	Create the main container
createSideMenu(panel)	Create the navigation tree
activateMenuItem(panel)	Activate the triggered side menu item
_handleNavigationButtonDisplay(panel)	Display or hide buttons depending on which panel index is active

initialize

Kind: global class

new initialize(config)

Param	Type
config	`object`

_currentPanel

Kind: global variable
Properties

Name	Type
_currentPanel	`object`

_previousPanel

Kind: global variable
Properties

Name	Type
_previousPanel	`object`

_wizardContent

Stores the wizard panels

Kind: global variable
Properties

Name	Type
_wizardContent	`object`

addPanel(panel)

Adds a panel to the wizard

Kind: global function

Param	Type
panel	`object`

nextPanel(panel)

Displays the next panel

Kind: global function

Param	Type
panel	`object`

insert(config)

Insert a new panel to the currently active wizard

Kind: global function

Param	Type
config	`obj`

remove(config)

Remove a panel from the currently active wizard

Kind: global function

Param	Type
config	`obj`

lockNavigation(config)

Prevent the user from moving to a previous/next panel

Kind: global function

Param	Type
config	`obj`

unLockNavigation(config)

Re-enable navigation

Kind: global function

Param	Type
config	`obj`

start()

Starts the wizard, creates the dialog and adds the contents stored in _wizardContent

Kind: global function

close()

Close the wizard, closes the dialog

Kind: global function

_checkForRequiredData(panel)

Check if required data is availale to launch the wizard panel, display a log if logging enabled

Kind: global function

Param	Type
panel	`object`

_createMainContainer(panel)

Create the main container

Kind: global function

Param	Type
panel	`object`

createSideMenu(panel)

Create the navigation tree

Kind: global function

Param	Type
panel	`object`

activateMenuItem(panel)

Activate the triggered side menu item

Kind: global function

Param	Type
panel	`object`

_handleNavigationButtonDisplay(panel)

Display or hide buttons depending on which panel index is active

Kind: global function

Param	Type
panel	`object`