Namespace sap.ui.core.BusyIndicatorModule: sap/ui/core/BusyIndicator


Provides methods to show or hide a waiting animation covering the whole page and blocking user interaction.

Method Summary
sap.ui.core.BusyIndicator.attachClose(fnFunction, oListener?)Registers a handler for the "close" event
sap.ui.core.BusyIndicator.attachOpen(fnFunction, oListener?)Registers a handler for the "open" event.
sap.ui.core.BusyIndicator.detachClose(fnFunction, oListener)Unregisters a handler for the "close" event
sap.ui.core.BusyIndicator.detachOpen(fnFunction, oListener)Unregisters a handler for the "open" event
sap.ui.core.BusyIndicator.hide()Removes the BusyIndicator from the screen
sap.ui.core.BusyIndicator.show(iDelay?)Displays the BusyIndicator and starts blocking all user input.
Method Detail
sap.ui.core.BusyIndicator.attachClose(fnFunction, oListener?): sap.ui.core.BusyIndicator
Registers a handler for the "close" event
Parameters:
{function}fnFunction The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
{object}oListener? Object on which to call the given function.
Returns:
{sap.ui.core.BusyIndicator}this to allow method chaining
sap.ui.core.BusyIndicator.attachOpen(fnFunction, oListener?): sap.ui.core.BusyIndicator
Registers a handler for the "open" event.
Parameters:
{function}fnFunction The function to call, when the event occurs. This function will be called on the oListener-instance (if present) or in a 'static way'.
{object}oListener? Object on which to call the given function.
Returns:
{sap.ui.core.BusyIndicator}this to allow method chaining
sap.ui.core.BusyIndicator.detachClose(fnFunction, oListener): sap.ui.core.BusyIndicator
Unregisters a handler for the "close" event
Parameters:
{function}fnFunction The callback function to unregister
{object}oListener Object on which the given function had to be called.
Returns:
{sap.ui.core.BusyIndicator}this to allow method chaining
sap.ui.core.BusyIndicator.detachOpen(fnFunction, oListener): sap.ui.core.BusyIndicator
Unregisters a handler for the "open" event
Parameters:
{function}fnFunction The callback function to unregister
{object}oListener Object on which the given function had to be called.
Returns:
{sap.ui.core.BusyIndicator}this to allow method chaining
sap.ui.core.BusyIndicator.hide()
Removes the BusyIndicator from the screen
sap.ui.core.BusyIndicator.show(iDelay?)
Displays the BusyIndicator and starts blocking all user input. This only happens after some delay and if after that delay the BusyIndicator.hide() has not yet been called in the meantime. There is a certain default value for the delay, but that one can be overridden.
Parameters:
{int}iDelay? The delay in milliseconds before opening the BusyIndicator. It is not opened if hide() is called before end of the delay. If no delay (or no valid delay) is given, the default value is used.