eLABSDK V1.0

API Docs for: 1.0.0
Show:

eLabSDK.Wizard.Panel

Extends eLabSDK.Wizard
Module: eLabSDK

Summary

Class that allows the creation of panels within a wizard

Constructor

eLabSDK.Wizard.Panel

Syntax

eLabSDK.Wizard.Panel

(
  • object
)
async

Summary

Parameters:

  • object Object
    • onRender Function
      • Include your code here due to the aSync nature of this class

Example:

Methods

_checkForRequiredData

Inherited from eLabSDK.Wizard:

Syntax

_checkForRequiredData

(
  • panel
)

Summary

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

Parameters:

  • panel Object

_createMainContainer

Inherited from eLabSDK.Wizard:

Syntax

_createMainContainer

(
  • panel
)

Summary

Create the main container

Parameters:

  • panel Object

_handleNavigationButtonDisplay

Inherited from eLabSDK.Wizard:

Syntax

_handleNavigationButtonDisplay

(
  • panel
)

Summary

Display or hide buttons depending on which panel index is active

Parameters:

  • panel Object

_render

Syntax

_render

(
  • _panelBody
)
Obj

Summary

Create a new panel - runs only once unless the panel to activate does not excist

Parameters:

  • _panelBody Obj

Returns:

Obj:

_panelBody

activate

Syntax

activate

()

Summary

Check if the panel excists, if so unhide it, otherwise create it through the _render() method

activateMenuItem

Inherited from eLabSDK.Wizard:

Syntax

activateMenuItem

(
  • panel
)

Summary

Activate the triggered side menu item

Parameters:

  • panel Object

addHTML

Syntax

addHTML

(
  • config
)

Summary

Add html to the panel

Parameters:

  • config Obj

addPanel

Inherited from eLabSDK.Wizard:

Syntax

addPanel

(
  • panel
)

Summary

Adds a panel to the wizard

Parameters:

  • panel Object

close

Inherited from eLabSDK.Wizard:

Syntax

close

()

Summary

Close the wizard, closes the dialog

createSideMenu

Inherited from eLabSDK.Wizard:

Syntax

createSideMenu

(
  • panel
)

Summary

Create the navigation tree

Parameters:

  • panel Object

getData

Syntax

getData

(
  • data
)

Summary

return the data for the given panel

Parameters:

  • data Object

insert

Inherited from eLabSDK.Wizard:

Syntax

insert

(
  • config
)

Summary

Insert a new panel to the currently active wizard

Parameters:

  • config Obj

lockNavigation

Inherited from eLabSDK.Wizard:

Syntax

lockNavigation

(
  • config
)

Summary

Prevent the user from moving to a previous/next panel

Parameters:

  • config Obj

nextPanel

Inherited from eLabSDK.Wizard:

Syntax

nextPanel

(
  • panel
)

Summary

Displays the next panel

Parameters:

  • panel Object

remove

Inherited from eLabSDK.Wizard

Syntax

remove

(
  • object
)
Obj

Summary

Remove the object from the panel(Body)

Parameters:

  • object Obj

Returns:

Obj:

_panelBody

setData

Syntax

setData

(
  • data
)

Summary

Save the current formdata for the active panel to the _data[] array

Parameters:

  • data Object

start

Inherited from eLabSDK.Wizard:

Syntax

start

()

Summary

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

unLockNavigation

Inherited from eLabSDK.Wizard:

Syntax

unLockNavigation

(
  • config
)

Summary

Re-enable navigation

Parameters:

  • config Obj

Properties

_currentPanel

Inherited from eLabSDK.Wizard:

Syntax

_currentPanel

Object

Summary

_data

Syntax

_data

Object

Summary

_panelBody

Syntax

_panelBody

Array

Summary

_previousPanel

Inherited from eLabSDK.Wizard:

Syntax

_previousPanel

Object

Summary

_wizardContent

Inherited from eLabSDK.Wizard:

Syntax

_wizardContent

Object

Summary

Stores the wizard panels

Events

onRender

Syntax

onRender

Summary

Method triggered after the panel has been rendered

Example:

  var pn = panel1.onRender(function () { 
                          alert('Panel onRender'); 
                      });

onRender

Syntax

onRender

Summary

Method triggered after the panel has been turned hidden

Example:

  var pn = panel1.onExit(function () { 
                          alert('Panel onExit'); 
                      });