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

validateFieldGroup

Events borrowed from class sap.ui.base.ManagedObject

formatError, modelContextChange, parseError, validationError, validationSuccess

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.

Methods borrowed from class sap.ui.core.Control

Methods borrowed from class sap.ui.core.Element

Methods borrowed from class sap.ui.base.ManagedObject

addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty

Methods borrowed from class sap.ui.base.EventProvider

attachEvent, attachEventOnce, detachEvent, hasListeners

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:

Properties
- text : string (default: )
- textDirection : sap.ui.core.TextDirection (default: Inherit)
- customIcon : sap.ui.core.URI (default: )
- customIconRotationSpeed : int (default: 1000)
- customIconDensityAware : boolean (default: true)
- customIconWidth : sap.ui.core.CSSSize (default: 44px)
- customIconHeight : sap.ui.core.CSSSize (default: 44px)
- size : sap.ui.core.CSSSize (default: 1rem)
- design : string (default: auto)

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

Parameters:

{string}	sId?	id for the new control, generated automatically if no id is given
{object}	mSettings?	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:

{string}	sClassName	Name of the class being created
{object}	oClassInfo?	Object literal with information about the class
{function}	FNMetaImpl?	Constructor function for the metadata object; if not given, it defaults to `sap.ui.core.ElementMetadata`

Returns:

{function}

Created class / constructor function

sap.m.BusyIndicator.getMetadata(): sap.ui.base.Metadata

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

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

addAriaLabelledBy(vAriaLabelledBy): sap.m.BusyIndicator

Adds some ariaLabelledBy into the association ariaLabelledBy.

Parameters:

{string|sap.ui.core.Control}

vAriaLabelledBy

the ariaLabelledBy to add; if empty, nothing is inserted

Since:: 1.27.0

Returns:

{sap.m.BusyIndicator} Reference to this in order to allow method chaining

getAriaLabelledBy(): sap.ui.core.Control[]

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

Since:: 1.27.0

Returns:

{sap.ui.core.Control[]}

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.URI} Value 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:

{boolean} Value 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.CSSSize} Value 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:

{int} Value 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.CSSSize} Value of property customIconWidth

getSize(): sap.ui.core.CSSSize

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.CSSSize} Value 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:

{string} Value 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.TextDirection} Value of property textDirection

removeAllAriaLabelledBy(): sap.ui.core.Control[]

Removes all the controls in the association named ariaLabelledBy.

Since:: 1.27.0

Returns:

{sap.ui.core.Control[]}

An array of the removed elements (might be empty)

removeAriaLabelledBy(vAriaLabelledBy): sap.ui.core.Control

Removes an ariaLabelledBy from the association named ariaLabelledBy.

Parameters:

{int|string|sap.ui.core.Control}

vAriaLabelledBy

The ariaLabelledByto be removed or its index or ID

Since:: 1.27.0

Returns:

{sap.ui.core.Control} the removed ariaLabelledBy or null

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.URI} sCustomIcon New value for property customIcon

Returns:

{sap.m.BusyIndicator} Reference to this in order to allow method chaining

setCustomIconDensityAware(bCustomIconDensityAware): sap.m.BusyIndicator

Sets a new value for property customIconDensityAware.

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

Default value is true.

Parameters:

{boolean} bCustomIconDensityAware New value for property customIconDensityAware

Returns:

{sap.m.BusyIndicator} Reference 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.CSSSize} sCustomIconHeight New value for property customIconHeight

Returns:

{sap.m.BusyIndicator} Reference to this in order to allow method chaining

setCustomIconRotationSpeed(iCustomIconRotationSpeed): sap.m.BusyIndicator

Sets a new value for property customIconRotationSpeed.

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

Default value is 1000.

Parameters:

{int} iCustomIconRotationSpeed New value for property customIconRotationSpeed

Returns:

{sap.m.BusyIndicator} Reference 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.CSSSize} sCustomIconWidth New value for property customIconWidth

Returns:

{sap.m.BusyIndicator} Reference 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.CSSSize} sSize New value for property size

Returns:

{sap.m.BusyIndicator} Reference 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:

{string} sText New value for property text

Returns:

{sap.m.BusyIndicator} Reference 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.TextDirection} sTextDirection New value for property textDirection

Returns:

{sap.m.BusyIndicator} Reference 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.

Deprecated:
Since version 1.32.1

Returns:

{string} Value of property design

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:

{string} sDesign New value for property design

Deprecated:
Since version 1.32.1

Returns:

{sap.m.BusyIndicator} Reference to this in order to allow method chaining