Class sap.m.BusyIndicatorModule: sap/m/BusyIndicator

extends Control

Control to indicate that the system is busy with some task and the user has to wait.
Constructor Summary
new sap.m.BusyIndicator(sId?, mSettings?)Constructor for a new BusyIndicator.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.m.BusyIndicator.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.BusyIndicator with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.BusyIndicator.getMetadata()Returns a metadata object for class sap.m.BusyIndicator.
addAriaLabelledBy(vAriaLabelledBy)Adds some ariaLabelledBy into the association ariaLabelledBy.
getAriaLabelledBy()Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.
getCustomIcon()Gets current value of property customIcon.
getCustomIconDensityAware()Gets current value of property customIconDensityAware.
getCustomIconHeight()Gets current value of property customIconHeight.
getCustomIconRotationSpeed()Gets current value of property customIconRotationSpeed.
getCustomIconWidth()Gets current value of property customIconWidth.
getSize()Gets current value of property size.
getText()Gets current value of property text.
getTextDirection()Gets current value of property textDirection.
removeAllAriaLabelledBy()Removes all the controls in the association named ariaLabelledBy.
removeAriaLabelledBy(vAriaLabelledBy)Removes an ariaLabelledBy from the association named ariaLabelledBy.
setCustomIcon(sCustomIcon)Sets a new value for property customIcon.
setCustomIconDensityAware(bCustomIconDensityAware)Sets a new value for property customIconDensityAware.
setCustomIconHeight(sCustomIconHeight)Sets a new value for property customIconHeight.
setCustomIconRotationSpeed(iCustomIconRotationSpeed)Sets a new value for property customIconRotationSpeed.
setCustomIconWidth(sCustomIconWidth)Sets a new value for property customIconWidth.
setSize(sSize)Sets a new value for property size.
setText(sText)Sets a new value for property text.
setTextDirection(sTextDirection)Sets a new value for property textDirection.
getDesign()Gets current value of property design.
setDesign(sDesign)Sets a new value for property design.
Constructor Detail
new sap.m.BusyIndicator(sId?, mSettings?)

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 for a general description of the syntax of the settings object.

The supported settings are:

In addition, all settings applicable to the base type sap.ui.core.Control can be used as well.

Parameters:
stringsId?id for the new control, generated automatically if no id is given
objectmSettings?initial settings for the new control
Method Detail
sap.m.BusyIndicator.extend(sClassName, oClassInfo?, FNMetaImpl?): function

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.

Parameters:
stringsClassNameName of the class being created
objectoClassInfo?Object literal with information about the class
functionFNMetaImpl?Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
functionCreated class / constructor function
sap.m.BusyIndicator.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.BusyIndicator.
Returns:
sap.ui.base.MetadataMetadata object describing this class
addAriaLabelledBy(vAriaLabelledBy): sap.m.BusyIndicator
Adds some ariaLabelledBy into the association ariaLabelledBy.
Parameters:
sap.ui.core.ID|sap.ui.core.ControlvAriaLabelledBythe ariaLabelledBy to add; if empty, nothing is inserted
Returns:
sap.m.BusyIndicatorReference to this in order to allow method chaining
Since:
1.27.0
getAriaLabelledBy(): sap.ui.core.ID[]
Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.
Returns:
sap.ui.core.ID[]
Since:
1.27.0
getCustomIcon(): sap.ui.core.URI

Gets current value of property customIcon.

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

Default value is .

Returns:
sap.ui.core.URIValue of property customIcon
getCustomIconDensityAware(): boolean

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.

Returns:
booleanValue of property customIconDensityAware
getCustomIconHeight(): sap.ui.core.CSSSize

Gets current value of property customIconHeight.

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

Default value is 44px.

Returns:
sap.ui.core.CSSSizeValue of property customIconHeight
getCustomIconRotationSpeed(): int

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.

Returns:
intValue of property customIconRotationSpeed
getCustomIconWidth(): sap.ui.core.CSSSize

Gets current value of property customIconWidth.

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

Default value is 44px.

Returns:
sap.ui.core.CSSSizeValue of property customIconWidth

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.

Returns:
sap.ui.core.CSSSizeValue of property size
getText(): string

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 .

Returns:
stringValue of property text
getTextDirection(): sap.ui.core.TextDirection

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.

Returns:
sap.ui.core.TextDirectionValue of property textDirection
removeAllAriaLabelledBy(): sap.ui.core.ID[]
Removes all the controls in the association named ariaLabelledBy.
Returns:
sap.ui.core.ID[]An array of the removed elements (might be empty)
Since:
1.27.0
removeAriaLabelledBy(vAriaLabelledBy): sap.ui.core.ID
Removes an ariaLabelledBy from the association named ariaLabelledBy.
Parameters:
int|sap.ui.core.ID|sap.ui.core.ControlvAriaLabelledByThe ariaLabelledBy to be removed or its index or ID
Returns:
sap.ui.core.IDThe removed ariaLabelledBy or null
Since:
1.27.0
setCustomIcon(sCustomIcon): sap.m.BusyIndicator

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 .

Parameters:
sap.ui.core.URIsCustomIconNew value for property customIcon
Returns:
sap.m.BusyIndicatorReference to this in order to allow method chaining
setCustomIconDensityAware(bCustomIconDensityAware): sap.m.BusyIndicator

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.

Parameters:
booleanbCustomIconDensityAwareNew value for property customIconDensityAware
Returns:
sap.m.BusyIndicatorReference to this in order to allow method chaining
setCustomIconHeight(sCustomIconHeight): sap.m.BusyIndicator

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.

Parameters:
sap.ui.core.CSSSizesCustomIconHeightNew value for property customIconHeight
Returns:
sap.m.BusyIndicatorReference to this in order to allow method chaining
setCustomIconRotationSpeed(iCustomIconRotationSpeed): sap.m.BusyIndicator

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.

Parameters:
intiCustomIconRotationSpeedNew value for property customIconRotationSpeed
Returns:
sap.m.BusyIndicatorReference to this in order to allow method chaining
setCustomIconWidth(sCustomIconWidth): sap.m.BusyIndicator

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.

Parameters:
sap.ui.core.CSSSizesCustomIconWidthNew value for property customIconWidth
Returns:
sap.m.BusyIndicatorReference to this in order to allow method chaining
setSize(sSize): sap.m.BusyIndicator

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.

Parameters:
sap.ui.core.CSSSizesSizeNew value for property size
Returns:
sap.m.BusyIndicatorReference to this in order to allow method chaining
setText(sText): sap.m.BusyIndicator

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 .

Parameters:
stringsTextNew value for property text
Returns:
sap.m.BusyIndicatorReference to this in order to allow method chaining
setTextDirection(sTextDirection): sap.m.BusyIndicator

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.

Parameters:
sap.ui.core.TextDirectionsTextDirectionNew value for property textDirection
Returns:
sap.m.BusyIndicatorReference to this in order to allow method chaining
getDesign(): string

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.

Returns:
stringValue of property design
Deprecated API:
Since version 1.32.1
setDesign(sDesign): sap.m.BusyIndicator

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.

Parameters:
stringsDesignNew value for property design
Returns:
sap.m.BusyIndicatorReference to this in order to allow method chaining
Deprecated API:
Since version 1.32.1