namespace sap.ui.core.BusyIndicator

Control sample: sap.ui.core.BusyIndicator
Visiblity: public
Available since: N/A
Module: sap/ui/core/BusyIndicator
Application Component: CA-UI5-COR

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


Nodes Overview

Node Description

Methods Overview

Method Description
sap.ui.core.BusyIndicator.attachClose

Registers a handler for the Close event.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to sap.ui.core.BusyIndicator.

sap.ui.core.BusyIndicator.attachOpen

Registers a handler for the Open event.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to sap.ui.core.BusyIndicator.

sap.ui.core.BusyIndicator.detachClose

Unregisters a handler from the Close event.

sap.ui.core.BusyIndicator.detachOpen

Unregisters a handler from the Open event.

sap.ui.core.BusyIndicator.hide

Removes the BusyIndicator from the screen.

sap.ui.core.BusyIndicator.show

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, which can be overridden.

sap.ui.core.BusyIndicator.attachClose

Registers a handler for the Close event.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to sap.ui.core.BusyIndicator.

Param Type DefaultValue Description
fnFunction function

The function to be called, when the event occurs

oListener object

Context object to call the event handler with; defaults to sap.ui.core.BusyIndicator

sap.ui.core.BusyIndicator.attachOpen

Registers a handler for the Open event.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to sap.ui.core.BusyIndicator.

Param Type DefaultValue Description
fnFunction function

The function to be called, when the event occurs

oListener object

Context object to call the event handler with; defaults to sap.ui.core.BusyIndicator

sap.ui.core.BusyIndicator.detachClose

Unregisters a handler from the Close event.

Param Type DefaultValue Description
fnFunction function

The callback function to unregister

oListener object

Context object on which the given function had to be called

sap.ui.core.BusyIndicator.detachOpen

Unregisters a handler from the Open event.

Param Type DefaultValue Description
fnFunction function

The callback function to unregister

oListener object

Context object on which the given function had to be called

sap.ui.core.BusyIndicator.hide

Removes the BusyIndicator from the screen.

Param Type DefaultValue Description

sap.ui.core.BusyIndicator.show

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, which can be overridden.

Param Type DefaultValue Description
iDelay int 1000

The delay in milliseconds before opening the BusyIndicator; It is not opened if hide() is called before the delay ends. If no delay (or no valid delay) is given, a delay of 1000 milliseconds is used.