class sap.m.BusyIndicator

Control sample: sap.m.BusyIndicator
Visiblity: public
UX Guidelines: Busy Indicator
Implements:
Available since: N/A
Module: sap/m/BusyIndicator
Application Component: CA-UI5-CTR

Informs the user about an ongoing operation.

Overview

The busy indicator implies that an action is taking place within a single control. You can set the size of the icon, the text, but also define a custom icon to be used instead.

Usage

When to use

When not to use


Constructor

Constructor for a new BusyIndicator.

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.BusyIndicator(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


Properties

Name Type Default Value Description
customIcon sap.ui.core.URI empty string

Icon URL if an icon is used as the busy indicator.

Visibility: public
customIconDensityAware boolean true

If this is set to false, the src image will be loaded directly without attempting to fetch the density perfect image for high density device. By default, this is set to true but then one or more requests are sent to the server, trying to get the density perfect version of the specified image. If bandwidth is the key for the application, set this value to false.

Visibility: public
customIconHeight sap.ui.core.CSSSize 44px

Height of the provided icon. By default 44px are used.

Visibility: public
customIconRotationSpeed int 1000

Defines the rotation speed of the given image. If a .gif is used, the speed has to be set to 0. The unit is in ms. Note: Values are considered valid when greater than or equal to 0. If invalid value is provided the speed defaults to 0.

Visibility: public
customIconWidth sap.ui.core.CSSSize 44px

Width of the provided icon. By default 44px are used.

Visibility: public
design string auto

Setting this property will not have any effect on the appearance of the BusyIndicator in versions greater than or equal to 1.32.1

Visibility: public
size sap.ui.core.CSSSize 1rem

Defines the size of the busy indicator. The animation consists of three circles, each of which will be this size. Therefore the total width of the control amounts to three times the given size.

Visibility: public
text string empty string

Defines text to be displayed below the busy indicator. It can be used to inform the user of the current operation.

Visibility: public
textDirection sap.ui.core.TextDirection Inherit

Options for the text direction are RTL and LTR. Alternatively, the control can inherit the text direction from its parent container.

Visibility: public

Associations

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).

Since: 1.27.0.


Methods Overview

Method Description
addAriaLabelledBy

Adds some ariaLabelledBy into the association ariaLabelledBy.

sap.m.BusyIndicator.extend

Creates a new subclass of class sap.m.BusyIndicator 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.

getAriaLabelledBy

Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.

getCustomIcon

Gets current value of property customIcon.

Icon URL if an icon is used as the busy indicator.

Default value is empty string.

getCustomIconDensityAware

Gets current value of property customIconDensityAware.

If this is set to false, the src image will be loaded directly without attempting to fetch the density perfect image for high density device. By default, this is set to true but then one or more requests are sent to the server, trying to get the density perfect version of the specified image. If bandwidth is the key for the application, set this value to false.

Default value is true.

getCustomIconHeight

Gets current value of property customIconHeight.

Height of the provided icon. By default 44px are used.

Default value is "44px".

getCustomIconRotationSpeed

Gets current value of property customIconRotationSpeed.

Defines the rotation speed of the given image. If a .gif is used, the speed has to be set to 0. The unit is in ms. Note: Values are considered valid when greater than or equal to 0. If invalid value is provided the speed defaults to 0.

Default value is 1000.

getCustomIconWidth

Gets current value of property customIconWidth.

Width of the provided icon. By default 44px are used.

Default value is "44px".

getDesign

Gets current value of property design.

Setting this property will not have any effect on the appearance of the BusyIndicator in versions greater than or equal to 1.32.1

Default value is "auto".

sap.m.BusyIndicator.getMetadata

Returns a metadata object for class sap.m.BusyIndicator.

getSize

Gets current value of property size.

Defines the size of the busy indicator. The animation consists of three circles, each of which will be this size. Therefore the total width of the control amounts to three times the given size.

Default value is "1rem".

getText

Gets current value of property text.

Defines text to be displayed below the busy indicator. It can be used to inform the user of the current operation.

Default value is empty string.

getTextDirection

Gets current value of property textDirection.

Options for the text direction are RTL and LTR. Alternatively, the control can inherit the text direction from its parent container.

Default value is Inherit.

removeAllAriaLabelledBy

Removes all the controls in the association named ariaLabelledBy.

removeAriaLabelledBy

Removes an ariaLabelledBy from the association named ariaLabelledBy.

setCustomIcon

Sets a new value for property customIcon.

Icon URL if an icon is used as the busy indicator.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is empty string.

setCustomIconDensityAware

Sets a new value for property customIconDensityAware.

If this is set to false, the src image will be loaded directly without attempting to fetch the density perfect image for high density device. By default, this is set to true but then one or more requests are sent to the server, trying to get the density perfect version of the specified image. If bandwidth is the key for the application, set this value to false.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

setCustomIconHeight

Sets a new value for property customIconHeight.

Height of the provided icon. By default 44px are used.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "44px".

setCustomIconRotationSpeed

Sets a new value for property customIconRotationSpeed.

Defines the rotation speed of the given image. If a .gif is used, the speed has to be set to 0. The unit is in ms. Note: Values are considered valid when greater than or equal to 0. If invalid value is provided the speed defaults to 0.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 1000.

setCustomIconWidth

Sets a new value for property customIconWidth.

Width of the provided icon. By default 44px are used.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "44px".

setDesign

Sets a new value for property design.

Setting this property will not have any effect on the appearance of the BusyIndicator in versions greater than or equal to 1.32.1

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "auto".

setSize

Sets a new value for property size.

Defines the size of the busy indicator. The animation consists of three circles, each of which will be this size. Therefore the total width of the control amounts to three times the given size.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "1rem".

setText

Sets a new value for property text.

Defines text to be displayed below the busy indicator. It can be used to inform the user of the current operation.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is empty string.

setTextDirection

Sets a new value for property textDirection.

Options for the text direction are RTL and LTR. Alternatively, the control can inherit the text direction from its parent container.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is Inherit.

addAriaLabelledBy

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

sap.m.BusyIndicator.extend

Creates a new subclass of class sap.m.BusyIndicator 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

getAriaLabelledBy

Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.

getCustomIcon

Gets current value of property customIcon.

Icon URL if an icon is used as the busy indicator.

Default value is empty string.

getCustomIconDensityAware

Gets current value of property customIconDensityAware.

If this is set to false, the src image will be loaded directly without attempting to fetch the density perfect image for high density device. By default, this is set to true but then one or more requests are sent to the server, trying to get the density perfect version of the specified image. If bandwidth is the key for the application, set this value to false.

Default value is true.

getCustomIconHeight

Gets current value of property customIconHeight.

Height of the provided icon. By default 44px are used.

Default value is "44px".

getCustomIconRotationSpeed

Gets current value of property customIconRotationSpeed.

Defines the rotation speed of the given image. If a .gif is used, the speed has to be set to 0. The unit is in ms. Note: Values are considered valid when greater than or equal to 0. If invalid value is provided the speed defaults to 0.

Default value is 1000.

getCustomIconWidth

Gets current value of property customIconWidth.

Width of the provided icon. By default 44px are used.

Default value is "44px".

getDesign

Gets current value of property design.

Setting this property will not have any effect on the appearance of the BusyIndicator in versions greater than or equal to 1.32.1

Default value is "auto".

sap.m.BusyIndicator.getMetadata

Returns a metadata object for class sap.m.BusyIndicator.

getSize

Gets current value of property size.

Defines the size of the busy indicator. The animation consists of three circles, each of which will be this size. Therefore the total width of the control amounts to three times the given size.

Default value is "1rem".

getText

Gets current value of property text.

Defines text to be displayed below the busy indicator. It can be used to inform the user of the current operation.

Default value is empty string.

getTextDirection

Gets current value of property textDirection.

Options for the text direction are RTL and LTR. Alternatively, the control can inherit the text direction from its parent container.

Default value is Inherit.

removeAllAriaLabelledBy

Removes all the controls in the association named ariaLabelledBy.

removeAriaLabelledBy

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

setCustomIcon

Sets a new value for property customIcon.

Icon URL if an icon is used as the busy indicator.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is empty string.

Param Type DefaultValue Description
sCustomIcon sap.ui.core.URI ""

New value for property customIcon

setCustomIconDensityAware

Sets a new value for property customIconDensityAware.

If this is set to false, the src image will be loaded directly without attempting to fetch the density perfect image for high density device. By default, this is set to true but then one or more requests are sent to the server, trying to get the density perfect version of the specified image. If bandwidth is the key for the application, set this value to false.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Param Type DefaultValue Description
bCustomIconDensityAware boolean true

New value for property customIconDensityAware

setCustomIconHeight

Sets a new value for property customIconHeight.

Height of the provided icon. By default 44px are used.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "44px".

Param Type DefaultValue Description
sCustomIconHeight sap.ui.core.CSSSize "44px"

New value for property customIconHeight

setCustomIconRotationSpeed

Sets a new value for property customIconRotationSpeed.

Defines the rotation speed of the given image. If a .gif is used, the speed has to be set to 0. The unit is in ms. Note: Values are considered valid when greater than or equal to 0. If invalid value is provided the speed defaults to 0.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is 1000.

Param Type DefaultValue Description
iCustomIconRotationSpeed int 1000

New value for property customIconRotationSpeed

setCustomIconWidth

Sets a new value for property customIconWidth.

Width of the provided icon. By default 44px are used.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "44px".

Param Type DefaultValue Description
sCustomIconWidth sap.ui.core.CSSSize "44px"

New value for property customIconWidth

setDesign

Sets a new value for property design.

Setting this property will not have any effect on the appearance of the BusyIndicator in versions greater than or equal to 1.32.1

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
sDesign string "auto"

New value for property design

setSize

Sets a new value for property size.

Defines the size of the busy indicator. The animation consists of three circles, each of which will be this size. Therefore the total width of the control amounts to three times the given size.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is "1rem".

Param Type DefaultValue Description
sSize sap.ui.core.CSSSize "1rem"

New value for property size

setText

Sets a new value for property text.

Defines text to be displayed below the busy indicator. It can be used to inform the user of the current operation.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is empty string.

Param Type DefaultValue Description
sText string ""

New value for property text

setTextDirection

Sets a new value for property textDirection.

Options for the text direction are RTL and LTR. Alternatively, the control can inherit the text direction from its parent container.

When called with a value of null or undefined, the default value of the property will be restored.

Default value is Inherit.

Param Type DefaultValue Description
sTextDirection sap.ui.core.TextDirection Inherit

New value for property textDirection