Class: UIDialogs

UIDialogs

Contains built-in dialogs to make common dialog operations quick and easy. If the built-in dialogs are not suitable for an applications needs, custom dialogs can always be created using HTML.


Members


<readonly> calibrate :ui.UICalibDialog

Gets a dialog object that will allow the user to calibrate the touch screen. This dialog is available whether or not a touch screen is actually installed on the device.

Type:
Since:
  • 1.0

<readonly> getDouble :ui.UIDoubleDialog

Gets a dialog object that will prompt the user to enter a floating point number

Type:
Since:
  • 1.0

<readonly> getInt :ui.UIIntDialog

Gets a dialog object that will prompt the user to enter an integer number

Type:
Since:
  • 1.0

<readonly> getString :ui.UIAlphaDialog

Gets a dialog object that will prompt the user to enter a string

Type:
Since:
  • 1.0

Methods


showConfiguration( [prompt])

Launches a modal dialog that gives the user access to much of the system configuration. This is the same dialog that is available for 5 seconds before loading (when enabled).

Because the dialog is modal, this method will not return until the dialog has been closed by the user.

Parameters:
Name Type Argument Default Description
prompt string <optional>
''

The title to show at the top of the dialog

Since:
  • 1.0
Returns:

'true' if the user closes with 'OK', 'false' otherwise

Type
bool

showHardware()

Launches a non-modal dialog that gives the user read or read/write access to the I/O installed on the system.

The dialog is non-modal, so this method returns as soon as the dialog is opened.

Since:
  • 1.0

showIPSettings()

Launches a modal dialog that gives the user access to the IP settings. This dialog is also accessible from the configuration dialog.

Because the dialog is modal, this method will not return until the dialog has been closed by the user.

Since:
  • 1.0
Returns:

'true' if the user closes with 'OK', 'false' otherwise

Type
bool

showLog()

Launches a non-modal dialog that shows the user the log messages logged using ui.UI.trace and variants, or debug console logging.

The dialog is non-modal, so this method returns as soon as the dialog is opened.

Since:
  • 1.0

showVersions()

Launches a modal dialog that gives the user access to the system versions. This dialog is also accessible from the configuration dialog.

Because the dialog is modal, this method will not return until the dialog has been closed by the user.

Since:
  • 1.0
Returns:

'true' if the user closes with 'OK', 'false' otherwise

Type
bool