RMP_MultiSelectionCheckBox

Multi-selection checkbox widget

new RMP_MultiSelectionCheckBox(conf)

This constructor allows you to create a multi-selection checkbox widget that can be inserted dynamically in your web interface

Parameters:

Name	Type	Description
conf	Object	JSON structure which contains the configuration of the multi-selection checkbox

Example

var conf = {"id":"id_list","label":"My List","variable":[{"name":"my_list_label","ref":"label"},{"name":"my_list_value","ref":"value"}],"url":"live/1/data/6fb67310-5307-11e1-a3cc-f0bf97e1b068?P_version=${P_version}&P_mode=${P_mode}","list_type":"custom_list","label-field":{"tagname":"json:label"},"value-field":{"tagname":"json:value"},"visible-items":"1","label":{"text":"My List"}};
var id_list= new RMP_MultiSelectionCheckBox(conf); 
id_widget.insertBefore(id_list);

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

getElement() → {object}

This function returns the html object of the widget

Returns: object

getLabel() → {String}

This function returns the label of a widget (if he has one)

Returns: String

getList() → {RMP_List}

Returns the content of a list

See: RMP_List to know more about the "RunMyProcess List" structure

Returns: RMP_List

Example

The content of a list is returned with the following structure
[{"label":"label1","value":"value1"},{"label":"label2","value":"value2"},{"label":"label3","value":"value3"}]

getListOfMyVariables() → {object}

This function returns the list of variables of the widget

Returns: object

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

getListVariableName() → {String}

Returns:

returns the variable name of a variable based list widget

Type String

getMissingVariableMessage() → {String}

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

Returns: String

getName() → {String}

This function returns the id as string of the widget

Returns: String

getParent() → {object}

Returns:

the parent widget of a widget

Type object

getSelectedLabel() → {String}

Returns:

returns the label selected by the connected user

Type String

getSelectedValue() → {String}

Returns:

returns the value selected by the connected user. It does not work with multi selection list.

Type String

getTooltip() → {String}

This function returns the tooltip text of the widget

Returns: 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: String

getValidationVariableMessage() → {String}

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

Returns: 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: String

getVariableValue(varName) → {String}

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

Parameters:

Name	Type	Description
varName	String

Returns: 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: 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: boolean

isEnabled() → {boolean}

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

Returns: boolean

isIndexed() → {boolean}

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

Returns: 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: boolean

isRequired() → {boolean}

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

Returns: 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: 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: boolean

isVisible() → {boolean}

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

Returns: boolean

loadList(url)

Set URL field of your list widget

Parameters:

Name	Type	Description
url	String

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

reset()

reset a list selection to empty

setActive(active)

This function allows to set the widget as active/inactive

Parameters:

Name	Type	Description
active	boolean	the inserted widget

setEnabled(e)

This function allows to set a widget as active/inactive

Parameters:

Name	Type	Description
e	boolean

setLabel(text)

This function sets the label of a widget (except for html, image, array and static text widgets which don't have label field)

Parameters:

Name	Type	Description
text	String

setListVariableName(name)

Sets the variable name of a variable based list widget

Parameters:

Name	Type	Description
name	String

setMissingVariableMessage(msg)

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

Parameters:

Name	Type	Description
msg	String

setPicked(label, value)

Set the picked item

Parameters:

Name	Type	Description
label	String
value	String

setPostLoadedScript(script)

Sets the post loaded script of a list

Parameters:

Name	Type	Description
script	String

setRequired(req)

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

Parameters:

Name	Type	Description
req	boolean

setSelectedLabel(label)

Sets label (value) displayed to the connected user

Parameters:

Name	Type	Description
label	String

setSelectedValue(value)

Sets value (label) displayed to the connected user

Parameters:

Name	Type	Description
value	String

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