RMP_CustomWidget

Custom widget

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

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

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

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

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

isLoaded() → {boolean}

Returns:

true if custom widget has already been loaded

Type boolean

isVisible() → {boolean}

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

Returns: boolean

load()

this function loads custom widget (only possible once)

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

setEnabled(e)

This function allows to set a widget as active/inactive

Parameters:

Name	Type	Description
e	boolean

setTooltip(tooltip)

This function sets the tooltip text of the widget

Parameters:

Name	Type	Description
tooltip	String

setVisible(v)

This function allows to set the widget as visible/invisible

Parameters:

Name	Type	Description
v	boolean