Namespace sap.ca.ui.utils.busydialogModule: sap/ca/ui/utils/busydialog


Provides methods to show/remove the waiting/blocking screen in the Fiori style.

sap.ca.ui.utils.busydialog is a static class, the statement jQuery.sap.require("sap.ca.ui.utils.busydialog") needs to be called before the function can be used. Example:

   jQuery.sap.require("sap.ca.ui.utils.busydialog");

   // request the BusyDialog to show the waiting/blocking screen
   sap.ca.ui.utils.busydialog.requireBusyDialog({
       text:"Loading..." //text is optional
   });

   // release the BusyDialog to remove the waiting/blocking screen
   sap.ca.ui.utils.busydialog.releaseBusyDialog();

Note

  • this BusyDialog will be shown with 1.5 seconds delay at the moment;
  • in a possible embedded function calls, you can require this BusyDialog more than once, but you need to take care to release the BusyDialog correspondingly in pair. (The text will be overwritten.)

Deprecated API:This control is deprecated since 1.26 as per central UX requirements. Please use sap.m.BusyDialog instead.

Method Summary
destroyBusyDialog()Destroys the waiting/blocking screen (this method is only recommended if the App developer or the "Unified Shell" has a clean-up strategy and want to release the memory on purpose)
releaseBusyDialog()Removes the waiting/blocking screen, and is used in pair with the method "requireBusyDialog"
requireBusyDialog(oSettings?)Shows the waiting/blocking screen
Method Detail
destroyBusyDialog()
Destroys the waiting/blocking screen (this method is only recommended if the App developer or the "Unified Shell" has a clean-up strategy and want to release the memory on purpose)
releaseBusyDialog()
Removes the waiting/blocking screen, and is used in pair with the method "requireBusyDialog"
requireBusyDialog(oSettings?)
Shows the waiting/blocking screen
Parameters:
{object}oSettings? settings for the busy dialog:

text : {string} (optional) loading text