RMP_ProgressBar

Methods

getContainerIndex() → {String}

Returns:

the index of the container of the widget, it might be the index of the column if the widget is in an array or the index of the tab if it's in a tab panel

Type

String

getListOfMyVariables() → {object}

This function returns the list of variables of the widget

Returns:

Type

object

Example

   ["id8.label","id8.value"] for list or ["textvar"] for a text input
 

getMissingVariableMessage() → {String}

This function returns the message displayed if a mandatory widget's variable is missing

Returns:

Type

String

getName() → {String}

This function returns the id as string of the widget

Returns:

Type

String

getParent() → {object}

Returns:

the parent widget of a widget

Type

object

getTooltip() → {String}

This function returns the tooltip text of the widget

Returns:

Type

String

getType() → {String}

This function returns the type of the widget(RMP_Image, RMP_Html, RMP_Scripter, RMP_StaticTextwidget, RMP_Button, RMP_TextInput, RMP_ListBox, RMP_MultiSelectionCheckBox, RMP_RadioButton, RMP_Array, RMP_FileUpload... )

Returns:

Type

String

getValidationVariableMessage() → {String}

This function returns the message displayed if a validation rule is not met

Returns:

Type

String

getValue() → {String}

This function returns the value of the widget's variable. It does not work for list's widgets (check box list, radio button list and list) where you should use widgetID.getSelectedValue.

Returns:

Type

String

getVariableValue(varName) → {String}

This function returns the value of a given variable of the widget

Parameters:

Name	Type	Description
varName	String

Returns:

Type

String

insertAbove(widget)

This function allows you to insert above widgetID, the new widget created thanks to new RMP_xxx() function

Parameters:

Name	Type	Description
widget	object	the inserted widget

insertAfter(widget)

This function allows you to insert on the left of widgetID, the new widget created thanks to new RMP_xxx() function

Parameters:

Name	Type	Description
widget	object	the inserted widget

insertBefore(widget)

This function allows you to insert on the right of widgetID, the new widget created thanks to new RMP_xxx() function

Parameters:

Name	Type	Description
widget	object	the inserted widget

insertBelow(widget)

This function allows you to insert below widgetID, the new widget created thanks to new RMP_xxx() function

Parameters:

Name	Type	Description
widget	object	the inserted widget

isActive() → {boolean}

This function returns true if the widget is active and false otherwise

Returns:

Type

boolean

isEmptyVariable(variable) → {boolean}

This function returns true if the the widget's variable is empty and false otherwise

Parameters:

Name	Type	Description
variable	String

Returns:

Type

boolean

isEnabled() → {boolean}

This function returns true if a widget is active and false otherwise

Returns:

Type

boolean

isIndexed() → {boolean}

This function returns true if the the widget's variable is an array and false otherwise

Returns:

Type

boolean

isIndexedVariable(name) → {boolean}

This function returns true if the the widget's variable is an array and false otherwise

Parameters:

Name	Type	Description
name	String

Returns:

Type

boolean

isRequired() → {boolean}

This function returns true if the the widget's variable is required and false otherwise

Returns:

Type

boolean

isValid(checkRules) → {boolean}

This function returns true if the the widget's variable is valid and false otherwise

Parameters:

Name	Type	Description
checkRules	boolean

Returns:

Type

boolean

isValidVariable(varName) → {boolean}

This function returns true if the the widget's variable is valid and false otherwise

Parameters:

Name	Type	Description
varName	String

Returns:

Type

boolean

isVisible() → {boolean}

This function returns true if the widget is visible and false otherwise

Returns:

Type

boolean

moveAfter(widget)

This function allows you to move widgetID2 after (on the the right) widgetID1

Parameters:

Name	Type	Description
widget	object	the inserted widget

moveBefore(widget)

This function allows you to move widgetID2 before (on the left) widgetID1

Parameters:

Name	Type	Description
widget	object	the inserted widget

remove(widget)

This function allows you to remove widgetID. If removeVariable is set to true, it will also deleted content of variable attached to widget

Parameters:

Name	Type	Description
widget	object	the inserted widget

setActive(active)

This function allows to set the widget as active/inactive

Parameters:

Name	Type	Description
active	boolean

setConfig(object)

Change the configuration of the Progress Bar. The new configuration will be reflected dynamically in the web interface

Parameters:

Name	Type	Description
object	Array.<RMP_ProgressBar~RMP_ProgressBarStep>	steps configuration as an array of RMP_ProgressBar~RMP_ProgressBarStep

Example

   id_bar.setConfig([{"reference":1,"title":"Task1","screen":[1]},{"reference":2,"title":"Task2","state":"active","number":"2","screen":[2,4]},{"reference":3,"title":"Task3"}]);
 

setEnabled(e)

This function allows to set a widget as active/inactive

Parameters:

Name	Type	Description
e	boolean

setMissingVariableMessage(msg)

This function sets the message displayed if a mandatory widget's variable is missing

Parameters:

Name	Type	Description
msg	String

setNumber(reference, state)

Change the number of the step

Parameters:

Name	Type	Description
reference	string	reference of the step
state	string	new number of the step (can be 'auto' to have an automatic incremental number)

setRequired(req)

This function sets the mandatory status of the widget's variable

Parameters:

Name	Type	Description
req	boolean

setState(reference, state)

Change the state of the step

Parameters:

Name	Type	Description
reference	string	reference of the step
state	string	new state of the step (can be 'previous', 'active', 'hidden' or 'next')

setSubTitle(reference, subtitle)

Change the subtitle of the step

Parameters:

Name	Type	Description
reference	string	reference of the step
subtitle	string	new subtitle of the step

setTitle(reference, title)

Change the title of the step

Parameters:

Name	Type	Description
reference	string	reference of the step
title	string	new title of the step

setTooltip(tooltip)

This function sets the tooltip text of the widget

Parameters:

Name	Type	Description
tooltip	String

setValidationVariableMessage(msg)

This function sets the message displayed if a validation rule is not met

Parameters:

Name	Type	Description
msg	String

setValue(value)

This function sets the value of the widget's variable. It does not work for list's widgets (check box list, radio button list and list) where you should use widgetID.setSelectedValue.

Parameters:

Name	Type	Description
value	String

setVariableValue(varName, value)

This function sets the value of a given variable of the widget

Parameters:

Name	Type	Description
varName	String
value	String

setVisible(v)

This function allows to set the widget as visible/invisible

Parameters:

Name	Type	Description
v	boolean

Type Definitions

RMP_ProgressBarStep

Progress Bar step

Properties:

Name	Type	Argument	Default	Description
reference	integer			The ordered number of the step
title	String			Title of the step
subtitle	String	<optional>		Subtitle of the step
number	String	<optional>		Indicator inside the circle of the step (you can ignore it or use auto value to have an automatic, incremental number)
state	String	<optional>	"next"	The state of the step, it can take the values: active, previous, hidden, next
screen	String	<optional>		The list of the reference of the manual task