RMP_History

History and Comments widget

new RMP_History()

Members

<static, constant> RMP_HistoryColumns :string

Available column names for History
Properties:
Name Type Default Description
STATE string state The screen of the application
AUTHOR string author The author
EMAIL string email Tje email of the author
PUBLISHED string published The publication date
UPDATED string updated The modification date

Methods

getColumnVisibility(columnIndex) → {boolean}

Determines whether or not a column is visible.
Parameters:
Name Type Description
columnIndex String the index of the column
Returns:
true if the widget is visible, false otherwise
Type
boolean

getComment() → {String}

Returns:
The comment that is now inside the widget
Type
String

getCompleteHistory() → {Array}

Returns:
The JSONArray of JSONArrays of JSONObjects representing the values [[{column : value}, ...], ...]
Type
Array

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

getHistoryRow() → {Array}

Returns:
The JSONArray of JSONObjects representing the values [{field:value}, ...]
Type
Array

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

getUrl() → {String}

Returns:
The Url where the widget gets its data.
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

isCommented() → {boolean}

Returns true if the user has added a comment, 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

isOpen() → {boolean}

Returns:
true if the widget is open.
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

setColumnVisibility(columnIndex, visible)

Shows or hides a given column
Parameters:
Name Type Description
columnIndex String the index of the column to be set visible, (columnIndex starts at '0')
visible 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