RMP_TabPanel

Tab widget

new RMP_TabPanel(conf)

This constructor allows you to create a tab widget that can be inserted dynamically in your web interface
Parameters:
Name Type Description
conf Object JSON structure which contains the configuration of the tab
Example
var conf = {"id":"id_tab","js-type":"RMP_TabPanel","first-tab":"0","tabpos":"bottom","min-height":"200",tab:
	  [{"visible":"true","active":"true","label":"TmV3IHRhYiAx","onclick":"Y29uc29sZS5sb2coInNlbGVjdGVkIik7","active-condition":"dHJ1ZQ==","visible-condition":"dHJ1ZQ=="},
	  {"visible":"true","active":"true","label":"TmV3IHRhYiAy"}]};
	  
var id_tab = new RMP_TabPanel(conf);
id_widget.insertBefore(id_tab); 

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:
Type
object

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

getSelectedTabIndex() → {String}

This function returns "name" and "index" of tab (index starts at '0')
Returns:
  • Type
    String
  • Type
    String

getTabLabel(tabIndex) → {String}

Parameters:
Name Type Description
tabIndex String
Returns:
returns the name of a tab according to its index (index starts at '0')
Type
String

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

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

insertInsideTab(tabIndex, widget)

Insert a dynamic widget inside a tab
Parameters:
Name Type Description
tabIndex String index of the tab that will wrap the widget
widget object the inserted widget

isActive() → {boolean}

This function returns true if the widget is active and false otherwise
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

isTabActive(tabIndex) → {boolean}

Parameters:
Name Type Description
tabIndex String
Returns:
returns true if the tab is active and false otherwise (index starts at '0')
Type
boolean

isTabVisible(tabIndex) → {boolean}

Parameters:
Name Type Description
tabIndex String
Returns:
returns true if the tab is invisible and false otherwise (index starts at '0')
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

setEnabled(e)

This function allows to set a widget as active/inactive
Parameters:
Name Type Description
e boolean

setSelectedTabIndex(tabIndex)

Sets a selected tab according to its index (index starts at '0')
Parameters:
Name Type Description
tabIndex String

setTabActive(tabIndex, active)

Sets a tab as active or not according to its index (index starts at '0')
Parameters:
Name Type Description
tabIndex String
active boolean

setTabLabel(tabIndex, label)

Sets the name of a tab according to its index (index starts at '0')
Parameters:
Name Type Description
tabIndex String
label String

setTabVisible(tabIndex, visible)

Sets a tab as visible or not according to its index (index starts at '0')
Parameters:
Name Type Description
tabIndex String
visible 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