Common_Functions_AllWidgets

# inner getContainerIndex() → {number}

Returns the index of the container of the widget. This may be the index of a column if the widget is in an array, or the index of a tab if the widget is in a tab panel.

Returns:

Type: number

# inner getElement() → {Object}

Returns the HTML object of a widget.

Returns:

Type: Object

# inner getLabel() → {string}

Returns the label of a widget (if it has one).

Returns:

Type: string

# inner getListOfMyVariables() → {Array.<string>}

Returns the list of variables of a widget.

Returns:

Type: Array.<string>

# inner getMissingVariableMessage() → {string}

Returns the message which is displayed when a mandatory widget variable is missing.

Returns:

Type: string

# inner getName() → {string}

Returns the ID of the widget as a string.

Returns:

Type: string

# inner getParent() → {object}

Returns the parent widget of a widget.

Returns:

Type: object

# inner getTooltip() → {string}

Returns the tooltip text of the widget.

Returns:

Type: string

# inner getValidationVariableMessage() → {string}

Returns the message which is displayed when a validation rule is not met.

Returns:

Type: string

# inner getValue() → {string}

Returns the value of a widget on the current web page (e.g. text input).

Returns:

Value of the variable

Type: string

# inner getVariableValue(varName) → {string}

Returns the value of a given variable of the widget.

Parameters:

Name	Type	Description
`varName`	string	Variable name

Returns:

Type: string

# inner insertAbove(newWidget)

Allows you to insert above widgetID, the new widget created thanks to new RMP_xxx() function.

Parameters:

Name	Type	Description
`newWidget`	Object	the new widget

# inner insertAfter(newWidget)

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

Parameters:

Name	Type	Description
`newWidget`	Object	the new widget

# inner insertBefore(newWidget)

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

Parameters:

Name	Type	Description
`newWidget`	Object	the new widget

# inner insertBelow(newWidget)

Allows you to insert bellow widgetID, the new widget created thanks to new RMP_xxx() function.

Parameters:

Name	Type	Description
`newWidget`	Object	the new widget

# inner isActive() → {boolean}

Returns true if the widget is active, otherwise false. Be aware that this method does not return the value of the Editable option as it was defined in the WebModeler, since this value can change at runtime with setActive.

Returns:

Type: boolean

# inner isEmptyVariable(varName) → {boolean}

Returns true if the given variable is empty, otherwise false.

Parameters:

Name	Type	Description
`varName`	string	Variable name

Returns:

Type: boolean

# inner isEnabled() → {boolean}

Returns true if the widget is active, otherwise false (same as isActive). Be aware that this method does not return the value of the Editable option as it was defined in the WebModeler, since this value can change at runtime with setEnabled.

Returns:

Type: boolean

# inner isIndexed() → {boolean}

Returns true if the widget variable is an array, otherwise false.

Returns:

Type: boolean

# inner isIndexedVariable(varName) → {boolean}

Returns true if the given variable is an array, otherwise false.

Parameters:

Name	Type	Description
`varName`	string	Variable name

Returns:

Type: boolean

# inner isRequired() → {boolean}

Returns true if the widget variable is required, otherwise false.

Returns:

Type: boolean

# inner isValid() → {boolean}

Returns true if the widget variable is valid, otherwise false.

Returns:

Type: boolean

# inner isValidVariable(varName) → {boolean}

Returns true if the given variable is valid, otherwise false.

Parameters:

Name	Type	Description
`varName`	string	Variable name

Returns:

Type: boolean

# inner isVisible() → {boolean}

Returns true if the widget is visible, otherwise false.

Returns:

Type: boolean

# inner moveAfter(insertedWidget)

Allows you to move inserted widget after (on the right) widgetID.

Parameters:

Name	Type	Description
`insertedWidget`	Object	the inserted widget

# inner moveBefore(insertedWidget)

Allows you to move inserted widget before (on the left) widgetID.

Parameters:

Name	Type	Description
`insertedWidget`	Object	the inserted widget

# inner remove(insertedWidget)

Allows you to remove insertedWidget.

Parameters:

Name	Type	Description
`insertedWidget`	Object	the inserted widget

# inner setActive(active)

Sets the widget as active (true) or inactive (false).

Parameters:

Name	Type	Description
`active`	boolean	true: active, false: inactive

# inner setActiveRule(condCallback, listenedVariablesopt, defaultValueopt)

Executes the condCallback script and sets the active state of the widget according to the execution result.

Parameters:

Name	Type	Attributes	Default	Description
`condCallback`	module:Common_Functions_AllWidgets~callbackCondition			Callback function which handles the active state condition
`listenedVariables`	Array.<string>	<optional>	[]	Variables that should be replaced by their values inside the `condCallback` function
`defaultValue`	boolean	<optional>	true	Default value of the widget's active state

# inner setEnabled(boolean)

Sets the widget as active (true) or inactive (false).

Parameters:

Name	Type	Description
`boolean`	bool	true: active, false: inactive

# inner setLabel(text)

Sets the label of a widget (except for HTML, image, array, and static text widgets which do not have a label field).

Parameters:

Name	Type	Description
`text`	string	Label

# inner setMissingVariableMessage(msg)

Sets the message which is displayed when a mandatory widget variable is missing.

Parameters:

Name	Type	Description
`msg`	string	Missing variable message

# inner setRequired(required)

Sets the mandatory status of the widget variable.

Parameters:

Name	Type	Description
`required`	boolean	true: required, false: optional

# inner setRequiredRule(condCallback, listenedVariablesopt, defaultValueopt)

Executes the condCallback script and sets the required state of the widget according to the execution result.

Parameters:

Name	Type	Attributes	Default	Description
`condCallback`	module:Common_Functions_AllWidgets~callbackCondition			Callback function that handles the required condition
`listenedVariables`	Array.<string>	<optional>	[]	Variables that should be replaced by their values inside the `condCallback` function
`defaultValue`	boolean	<optional>	true	Default value of the widget's required state

# inner setTooltip(tooltip)

Sets the tooltip text of a widget.

Parameters:

Name	Type	Description
`tooltip`	string	Tooltip text value

# inner setValidationVariableMessage(msg)

Sets the message which is displayed when a validation rule is not met.

Parameters:

Name	Type	Description
`msg`	string	Message to display

# inner setValideRule(condCallback, listenedVariablesopt, defaultValueopt)

Executes the condCallback script and sets the valid state of the widget according to the execution result.

Parameters:

Name	Type	Attributes	Default	Description
`condCallback`	module:Common_Functions_AllWidgets~callbackCondition			Callback function that handles the valid condition
`listenedVariables`	Array.<string>	<optional>	[]	Variables that should be replaced by their values inside the `condCallback` function
`defaultValue`	boolean	<optional>	true	Default value of the widget's valid state

# inner setValue(value)

Sets the value of the widget variable. This does not work for list widgets (list, check box list, radio button list), where you should use widgetID.setSelectedValue instead.

Parameters:

Name	Type	Description
`value`	string	Value to set

# inner setVariableValue(varName, value)

Sets the value of a given variable of the widget.

Parameters:

Name	Type	Description
`varName`	string	Variable name
`value`	string	Variable value

# inner setVisible(visible)

Sets the widget as visible (true) or invisible (false).

Parameters:

Name	Type	Description
`visible`	boolean	true: visible, false: invisible

# inner setVisibleRule(condCallback, listenedVariablesopt, defaultValueopt)

Executes the condCallback script and sets the visible state of the widget according to the execution result.

Parameters:

Name	Type	Attributes	Default	Description
`condCallback`	module:Common_Functions_AllWidgets~callbackCondition			Callback function that handles the visible state condition
`listenedVariables`	Array.<string>	<optional>	[]	Variables that should be replaced by their values inside the `condCallback` function
`defaultValue`	boolean	<optional>	true	Default value of the widget's visible state

Docs

Methods

# inner getContainerIndex() → {number}

# inner getElement() → {Object}

# inner getLabel() → {string}

# inner getListOfMyVariables() → {Array.<string>}

# inner getMissingVariableMessage() → {string}

# inner getName() → {string}

# inner getParent() → {object}

# inner getTooltip() → {string}

# inner getValidationVariableMessage() → {string}

# inner getValue() → {string}

# inner getVariableValue(varName) → {string}

Parameters:

# inner insertAbove(newWidget)

Parameters:

# inner insertAfter(newWidget)

Parameters:

# inner insertBefore(newWidget)

Parameters:

# inner insertBelow(newWidget)

Parameters:

# inner isActive() → {boolean}

# inner isEmptyVariable(varName) → {boolean}

Parameters:

# inner isEnabled() → {boolean}

# inner isIndexed() → {boolean}

# inner isIndexedVariable(varName) → {boolean}

Parameters:

# inner isRequired() → {boolean}

# inner isValid() → {boolean}

# inner isValidVariable(varName) → {boolean}

Parameters:

# inner isVisible() → {boolean}

# inner moveAfter(insertedWidget)

Parameters:

# inner moveBefore(insertedWidget)

Parameters:

# inner remove(insertedWidget)

Parameters:

# inner setActive(active)

Parameters:

# inner setActiveRule(condCallback, listenedVariablesopt, defaultValueopt)

Parameters:

# inner setEnabled(boolean)

Parameters:

# inner setLabel(text)

Parameters:

# inner setMissingVariableMessage(msg)

Parameters:

# inner setRequired(required)

Parameters:

# inner setRequiredRule(condCallback, listenedVariablesopt, defaultValueopt)

Parameters:

# inner setTooltip(tooltip)

Parameters:

# inner setValidationVariableMessage(msg)

Parameters:

# inner setValideRule(condCallback, listenedVariablesopt, defaultValueopt)

Parameters:

# inner setValue(value)

Parameters:

# inner setVariableValue(varName, value)

Parameters:

# inner setVisible(visible)

Parameters:

# inner setVisibleRule(condCallback, listenedVariablesopt, defaultValueopt)

Parameters:

Type Definitions

# callbackCondition() → {boolean}