Namespace RapidContext.UI

UI

Provides functions for managing the app user interface.

Method Summary
(static)
Creates a tree of widgets from a parsed XML document.
(static)
Connects the default UI signals for a procedure.
(static)
Displays an error message for the user.

Methods

(static) buildUI(node, idsopt) → {Array|Object}

Creates a tree of widgets from a parsed XML document. This function will call createWidget() for any XML element node found, performing some basic adjustments on the element attributes before sending them as attributes to the widget constructor. Text nodes with non-whitespace content will be mapped to HTML DOM text nodes.

Parameters:
Name Type Attributes Description
node {Object} the XML document or node
ids {Object} <optional>
the optional node id mappings
Returns:
{Array|Object} an array or an object with the root widget(s) created
Source:
RapidContext_UI.js, line 86

(static) connectProc(proc, loadingIconopt, reloadIconopt)

Connects the default UI signals for a procedure. This includes a default error handler, a loading icon with cancellation handler and a reload icon with the appropriate click handler.

Parameters:
Name Type Attributes Description
proc {Procedure} the RapidContext.Procedure instance
loadingIcon {Icon} <optional>
the loading icon, or null
reloadIcon {Icon} <optional>
the reload icon, or null
See:
RapidContext.Procedure
Source:
RapidContext_UI.js, line 190

(static) showError(…argopt)

Displays an error message for the user. This operation may or may not block the user interface, while the message is being displayed (depending on implementation). All arguments will be concatenated and displayed.

Parameters:
Name Type Attributes Description
arg {String|Error} <optional>
<repeatable>
the messages or errors to display
Source:
RapidContext_UI.js, line 34