BusyDialog is used to indicate that the system is busy.
When the busy dialog is displayed, the whole application is blocked.
The busy dialog can hold several elements, most of which are optional.
title
- A title for the dialog. By default, there is no title.text
- A text displayed above the busy animation.showCancelButton
- An optional Cancel button to stop the execution.customIcon
- An optional alternative icon to use as a busy animation.
text
.Constructor for a new BusyDialog.
Accepts an object literal mSettings
that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject#constructor for a general description of the syntax of the settings object.
new sap.m.BusyDialog(sId?, mSettings?)
Param | Type | Default Value | Description |
---|---|---|---|
sId? | string | ID for the new control, generated automatically if no ID is given. |
|
mSettings? | object | Initial settings for the new control. |
Name | Type | Default Value | Description |
---|---|---|---|
cancelButtonText | string | empty string | The text of the cancel button. The default text is "Cancel" (translated to the respective language). Visibility: public |
customIcon | sap.ui.core.URI | empty string | Icon, used from the BusyIndicator. This icon is invisible in iOS platform and it is density aware. You can use the density convention (@2, @1.5, etc.) to provide higher resolution image for higher density screens. Visibility: public |
customIconDensityAware | boolean | true | If this is set to If bandwidth is the key for the application, set this value to |
customIconHeight | sap.ui.core.CSSSize | 44px | Height of the provided icon with default value "44px". Visibility: public |
customIconRotationSpeed | int | 1000 | Defines the rotation speed of the given image. If GIF file is used, the speed has to be set to 0. The value is in milliseconds. Visibility: public |
customIconWidth | sap.ui.core.CSSSize | 44px | Width of the provided icon with default value "44px". Visibility: public |
showCancelButton | boolean | false | Indicates if the cancel button will be rendered inside the busy dialog. The default value is set to |
text | string | empty string | Optional text displayed inside the dialog. Visibility: public |
title | string | empty string | Sets the title of the BusyDialog. The default value is an empty string. Visibility: public |
titleAlignment | sap.m.TitleAlignment | Auto | Specifies the Title alignment (theme specific). If set to |
Name | Cardinality | Type | Description |
---|---|---|---|
ariaLabelledBy | 0..n | sap.ui.core.Control |
Association to controls / IDs which label this control (see WAI-ARIA attribute aria-labelledby). |
Event | Description |
---|---|
close |
Fires when the busy dialog is closed. Note: the BusyDialog will not be closed by the InstanceManager.closeAllDialogs method |
Fires when the busy dialog is closed. Note: the BusyDialog will not be closed by the InstanceManager.closeAllDialogs method
Param | Type | Description |
---|---|---|
oControlEvent | sap.ui.base.Event | |
getSource | sap.ui.base.EventProvider | |
getParameters | object | |
cancelPressed | boolean |
Indicates if the close events are triggered by a user, pressing a cancel button or because the operation was terminated. This parameter is set to true if the close event is fired by user interaction. |
Method | Description |
---|---|
addAriaLabelledBy |
Adds some ariaLabelledBy into the association ariaLabelledBy. |
attachClose |
Attaches event handler When called, the context of the event handler (its Fires when the busy dialog is closed. Note: the BusyDialog will not be closed by the InstanceManager.closeAllDialogs method |
close |
Closes the BusyDialog. |
detachClose |
Detaches event handler The passed function and listener object must match the ones used for event registration. |
sap.m.BusyDialog.extend |
Creates a new subclass of class sap.m.BusyDialog with name
|
fireClose |
Fires event close to attached listeners. |
getAriaLabelledBy |
Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy. |
getCancelButtonText |
Gets current value of property cancelButtonText. The text of the cancel button. The default text is "Cancel" (translated to the respective language). Default value is |
getCustomIcon |
Gets current value of property customIcon. Icon, used from the BusyIndicator. This icon is invisible in iOS platform and it is density aware. You can use the density convention (@2, @1.5, etc.) to provide higher resolution image for higher density screens. Default value is |
getCustomIconDensityAware |
Gets current value of property customIconDensityAware. If this is set to If bandwidth is the key for the application, set this value to Default value is |
getCustomIconHeight |
Gets current value of property customIconHeight. Height of the provided icon with default value "44px". Default value is |
getCustomIconRotationSpeed |
Gets current value of property customIconRotationSpeed. Defines the rotation speed of the given image. If GIF file is used, the speed has to be set to 0. The value is in milliseconds. Default value is |
getCustomIconWidth |
Gets current value of property customIconWidth. Width of the provided icon with default value "44px". Default value is |
getDomRef |
Gets the DOM reference for the BusyDialog. |
sap.m.BusyDialog.getMetadata |
Returns a metadata object for class sap.m.BusyDialog. |
getShowCancelButton |
Gets current value of property showCancelButton. Indicates if the cancel button will be rendered inside the busy dialog. The default value is set to Default value is |
getText |
Gets current value of property text. Optional text displayed inside the dialog. Default value is |
getTitle |
Gets current value of property title. Sets the title of the BusyDialog. The default value is an empty string. Default value is |
getTitleAlignment |
Gets current value of property titleAlignment. Specifies the Title alignment (theme specific). If set to Default value is |
getTooltip |
Gets the tooltip of the BusyDialog. |
open |
Opens the BusyDialog. |
removeAllAriaLabelledBy |
Removes all the controls in the association named ariaLabelledBy. |
removeAriaLabelledBy |
Removes an ariaLabelledBy from the association named ariaLabelledBy. |
setCancelButtonText |
Shows the text for the cancel button. |
setCustomIcon |
Sets custom icon. |
setCustomIconDensityAware |
Sets the density of the custom icon. |
setCustomIconHeight |
Sets the height of the custom icon. |
setCustomIconRotationSpeed |
Sets the rotation speed of the custom icon. |
setCustomIconWidth |
Sets the width of the custom icon. |
setShowCancelButton |
Shows the cancel button. |
setText |
Sets the text for the BusyDialog. |
setTitle |
Sets the title for the BusyDialog. |
setTitleAlignment |
Sets a new value for property titleAlignment. Specifies the Title alignment (theme specific). If set to When called with a value of Default value is |
setTooltip |
Sets the tooltip for the BusyDialog. |
Adds some ariaLabelledBy into the association ariaLabelledBy.
Param | Type | DefaultValue | Description |
---|---|---|---|
vAriaLabelledBy | sap.ui.core.ID sap.ui.core.Control |
The ariaLabelledBy to add; if empty, nothing is inserted |
Attaches event handler fnFunction
to the close event of this sap.m.BusyDialog
.
When called, the context of the event handler (its this
) will be bound to oListener
if specified, otherwise it will be bound to this sap.m.BusyDialog
itself.
Fires when the busy dialog is closed. Note: the BusyDialog will not be closed by the InstanceManager.closeAllDialogs method
Param | Type | DefaultValue | Description |
---|---|---|---|
oData | object |
An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called when the event occurs |
|
oListener | object |
Context object to call the event handler with. Defaults to this |
Closes the BusyDialog.
Param | Type | DefaultValue | Description |
---|---|---|---|
isClosedFromUserInteraction | boolean |
Indicates if the BusyDialog is closed from a user interaction. |
Detaches event handler fnFunction
from the close event of this sap.m.BusyDialog
.
The passed function and listener object must match the ones used for event registration.
Param | Type | DefaultValue | Description |
---|---|---|---|
fnFunction | function(sap.ui.base.Event) : void |
The function to be called, when the event occurs |
|
oListener | object |
Context object on which the given function had to be called |
Creates a new subclass of class sap.m.BusyDialog with name sClassName
and enriches it with the information contained in oClassInfo
.
oClassInfo
might contain the same kind of information as described in sap.ui.core.Control.extend.
Param | Type | DefaultValue | Description |
---|---|---|---|
sClassName | string |
Name of the class being created |
|
oClassInfo | object |
Object literal with information about the class |
|
FNMetaImpl | function |
Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class |
Fires event close to attached listeners.
Param | Type | DefaultValue | Description |
---|---|---|---|
mParameters | object |
Parameters to pass along with the event |
|
cancelPressed | boolean |
Indicates if the close events are triggered by a user, pressing a cancel button or because the operation was terminated. This parameter is set to true if the close event is fired by user interaction. |
Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.
Gets current value of property cancelButtonText.
The text of the cancel button. The default text is "Cancel" (translated to the respective language).
Default value is empty string
.
Gets current value of property customIcon.
Icon, used from the BusyIndicator. This icon is invisible in iOS platform and it is density aware. You can use the density convention (@2, @1.5, etc.) to provide higher resolution image for higher density screens.
Default value is empty string
.
Gets current value of property customIconDensityAware.
If this is set to false
, the source image will be loaded directly without attempting to fetch the density perfect image for high density devices. By default, this is set to true
but then one or more requests are sent trying to get the density perfect version of the image.
If bandwidth is the key for the application, set this value to false
.
Default value is true
.
Gets current value of property customIconHeight.
Height of the provided icon with default value "44px".
Default value is "44px"
.
Gets current value of property customIconRotationSpeed.
Defines the rotation speed of the given image. If GIF file is used, the speed has to be set to 0. The value is in milliseconds.
Default value is 1000
.
Gets current value of property customIconWidth.
Width of the provided icon with default value "44px".
Default value is "44px"
.
Gets current value of property showCancelButton.
Indicates if the cancel button will be rendered inside the busy dialog. The default value is set to false
.
Default value is false
.
Gets current value of property text.
Optional text displayed inside the dialog.
Default value is empty string
.
Gets current value of property title.
Sets the title of the BusyDialog. The default value is an empty string.
Default value is empty string
.
Gets current value of property titleAlignment.
Specifies the Title alignment (theme specific). If set to TitleAlignment.Auto
, the Title will be aligned as it is set in the theme (if not set, the default value is center
); Other possible values are TitleAlignment.Start
(left or right depending on LTR/RTL), and TitleAlignment.Center
(centered)
Default value is Auto
.
Removes an ariaLabelledBy from the association named ariaLabelledBy.
Param | Type | DefaultValue | Description |
---|---|---|---|
vAriaLabelledBy | int sap.ui.core.ID sap.ui.core.Control |
The ariaLabelledBy to be removed or its index or ID |
Shows the text for the cancel button.
Param | Type | DefaultValue | Description |
---|---|---|---|
sText | string |
Text for the cancel button. |
Sets custom icon.
Param | Type | DefaultValue | Description |
---|---|---|---|
sIcon | string |
Icon to use as a busy animation. |
Sets the density of the custom icon.
Param | Type | DefaultValue | Description |
---|---|---|---|
bIsDensityAware | boolean |
Determines if the source image will be loaded directly without attempting to fetch the density for high density devices. |
Sets the height of the custom icon.
Param | Type | DefaultValue | Description |
---|---|---|---|
sHeight | string |
Height of the provided icon in CSSSize. |
Sets the rotation speed of the custom icon.
Param | Type | DefaultValue | Description |
---|---|---|---|
iSpeed | int |
Defines the rotation speed of the given image. |
Sets the width of the custom icon.
Param | Type | DefaultValue | Description |
---|---|---|---|
sWidth | string |
Width of the provided icon in CSSSize. |
Shows the cancel button.
Param | Type | DefaultValue | Description |
---|---|---|---|
bIsCancelButtonShown | boolean |
Determines if the Cancel button is shown. |
Sets the text for the BusyDialog.
Param | Type | DefaultValue | Description |
---|---|---|---|
sText | string |
The text for the BusyDialog. |
Sets the title for the BusyDialog.
Param | Type | DefaultValue | Description |
---|---|---|---|
sTitle | string |
The title for the BusyDialog. |
Sets a new value for property titleAlignment.
Specifies the Title alignment (theme specific). If set to TitleAlignment.Auto
, the Title will be aligned as it is set in the theme (if not set, the default value is center
); Other possible values are TitleAlignment.Start
(left or right depending on LTR/RTL), and TitleAlignment.Center
(centered)
When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is Auto
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sTitleAlignment | sap.m.TitleAlignment | Auto |
New value for property |