class sap.m.ProgressIndicator

Control sample: sap.m.ProgressIndicator
Visiblity: public
UX Guidelines: Progress Indicator
Implements: sap.ui.core.IFormContent
Available since: N/A
Module: sap/m/ProgressIndicator
Application Component: CA-UI5-CTR

Shows the progress of a process in a graphical way. To indicate the progress, the inside of the ProgressIndicator is filled with a color. Additionally, a user-defined string can be displayed on the ProgressIndicator.


Constructor

Constructor for a new ProgressIndicator.

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.ProgressIndicator(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
displayAnimation boolean true

Determines whether a percentage change is displayed with animation.

Since: 1.73.

Visibility: public
displayOnly boolean false

Determines whether the control is in display-only state where the control has different visualization and cannot be focused.

Since: 1.50.

Visibility: public
displayValue string

Specifies the text value to be displayed in the bar.

Visibility: public
enabled boolean true

Switches enabled state of the control. Disabled fields have different colors, and cannot be focused.

Visibility: public
height sap.ui.core.CSSSize

Specifies the height of the control. The default value depends on the theme. Suggested size for normal use is 2.5rem (40px). Suggested size for small size (like for use in ObjectHeader) is 1.375rem (22px).

Since: 1.15.0.

Visibility: public
percentValue float 0

Specifies the numerical value in percent for the length of the progress bar.

Note: If a value greater than 100 is provided, the percentValue is set to 100. In other cases of invalid value, percentValue is set to its default of 0.

Visibility: public
showValue boolean true

Indicates whether the displayValue should be shown in the ProgressIndicator.

Visibility: public
state sap.ui.core.ValueState None

Specifies the state of the bar. Enumeration sap.ui.core.ValueState provides Error, Warning, Success, Information, None (default value). The color for each state depends on the theme.

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

Specifies the element's text directionality with enumerated options (RTL or LTR). By default, the control inherits text direction from the DOM.

Since: 1.28.0.

Visibility: public
width sap.ui.core.CSSSize 100%

Specifies the width of the control.

Visibility: public

Aggregations

Default Aggregation:

Name Cardinality Type Description
_popover 0..1 sap.m.Popover

Associations

Name Cardinality Type Description
ariaDescribedBy 0..n sap.ui.core.Control

Association to controls / IDs which describe this control (see WAI-ARIA attribute aria-describedby).

Since: 1.69.

ariaLabelledBy 0..n sap.ui.core.Control

Association to controls / IDs which label this control (see WAI-ARIA attribute aria-labelledBy).

Since: 1.69.


Methods Overview

Method Description
addAriaDescribedBy

Adds some ariaDescribedBy into the association ariaDescribedBy.

addAriaLabelledBy

Adds some ariaLabelledBy into the association ariaLabelledBy.

sap.m.ProgressIndicator.extend

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

getAccessibilityInfo

Returns the sap.m.ProgressIndicator accessibility information.

References:

  • sap.ui.core.Control#getAccessibilityInfo

getAriaDescribedBy

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

getAriaLabelledBy

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

getDisplayAnimation

Gets current value of property displayAnimation.

Determines whether a percentage change is displayed with animation.

Default value is true.

getDisplayOnly

Gets current value of property displayOnly.

Determines whether the control is in display-only state where the control has different visualization and cannot be focused.

Default value is false.

getDisplayValue

Gets current value of property displayValue.

Specifies the text value to be displayed in the bar.

getEnabled

Gets current value of property enabled.

Switches enabled state of the control. Disabled fields have different colors, and cannot be focused.

Default value is true.

getHeight

Gets current value of property height.

Specifies the height of the control. The default value depends on the theme. Suggested size for normal use is 2.5rem (40px). Suggested size for small size (like for use in ObjectHeader) is 1.375rem (22px).

sap.m.ProgressIndicator.getMetadata

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

getPercentValue

Gets current value of property percentValue.

Specifies the numerical value in percent for the length of the progress bar.

Note: If a value greater than 100 is provided, the percentValue is set to 100. In other cases of invalid value, percentValue is set to its default of 0.

Default value is 0.

getShowValue

Gets current value of property showValue.

Indicates whether the displayValue should be shown in the ProgressIndicator.

Default value is true.

getState

Gets current value of property state.

Specifies the state of the bar. Enumeration sap.ui.core.ValueState provides Error, Warning, Success, Information, None (default value). The color for each state depends on the theme.

Default value is None.

getTextDirection

Gets current value of property textDirection.

Specifies the element's text directionality with enumerated options (RTL or LTR). By default, the control inherits text direction from the DOM.

Default value is Inherit.

getWidth

Gets current value of property width.

Specifies the width of the control.

Default value is '100%'.

removeAllAriaDescribedBy

Removes all the controls in the association named ariaDescribedBy.

removeAllAriaLabelledBy

Removes all the controls in the association named ariaLabelledBy.

removeAriaDescribedBy

Removes an ariaDescribedBy from the association named ariaDescribedBy.

removeAriaLabelledBy

Removes an ariaLabelledBy from the association named ariaLabelledBy.

setDisplayAnimation

Sets a new value for property displayAnimation.

Determines whether a percentage change is displayed with animation.

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

Default value is true.

setDisplayOnly

Sets a new value for property displayOnly.

Determines whether the control is in display-only state where the control has different visualization and cannot be focused.

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

Default value is false.

setDisplayValue

Sets a new value for property displayValue.

Specifies the text value to be displayed in the bar.

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

setEnabled

Sets a new value for property enabled.

Switches enabled state of the control. Disabled fields have different colors, and cannot be focused.

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

Default value is true.

setHeight

Sets a new value for property height.

Specifies the height of the control. The default value depends on the theme. Suggested size for normal use is 2.5rem (40px). Suggested size for small size (like for use in ObjectHeader) is 1.375rem (22px).

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

setPercentValue

Sets a new value for property percentValue.

Specifies the numerical value in percent for the length of the progress bar.

Note: If a value greater than 100 is provided, the percentValue is set to 100. In other cases of invalid value, percentValue is set to its default of 0.

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

Default value is 0.

setShowValue

Sets a new value for property showValue.

Indicates whether the displayValue should be shown in the ProgressIndicator.

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

Default value is true.

setState

Sets a new value for property state.

Specifies the state of the bar. Enumeration sap.ui.core.ValueState provides Error, Warning, Success, Information, None (default value). The color for each state depends on the theme.

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

Default value is None.

setTextDirection

Sets a new value for property textDirection.

Specifies the element's text directionality with enumerated options (RTL or LTR). By default, the control inherits text direction from the DOM.

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

Default value is Inherit.

setWidth

Sets a new value for property width.

Specifies the width of the control.

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

Default value is '100%'.

addAriaDescribedBy

Adds some ariaDescribedBy into the association ariaDescribedBy.

Param Type DefaultValue Description
vAriaDescribedBy sap.ui.core.ID sap.ui.core.Control

The ariaDescribedBy to add; if empty, nothing is inserted

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.ProgressIndicator.extend

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

getAccessibilityInfo

Returns the sap.m.ProgressIndicator accessibility information.

References:

getAriaDescribedBy

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

getAriaLabelledBy

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

getDisplayAnimation

Gets current value of property displayAnimation.

Determines whether a percentage change is displayed with animation.

Default value is true.

getDisplayOnly

Gets current value of property displayOnly.

Determines whether the control is in display-only state where the control has different visualization and cannot be focused.

Default value is false.

getDisplayValue

Gets current value of property displayValue.

Specifies the text value to be displayed in the bar.

getEnabled

Gets current value of property enabled.

Switches enabled state of the control. Disabled fields have different colors, and cannot be focused.

Default value is true.

getHeight

Gets current value of property height.

Specifies the height of the control. The default value depends on the theme. Suggested size for normal use is 2.5rem (40px). Suggested size for small size (like for use in ObjectHeader) is 1.375rem (22px).

sap.m.ProgressIndicator.getMetadata

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

getPercentValue

Gets current value of property percentValue.

Specifies the numerical value in percent for the length of the progress bar.

Note: If a value greater than 100 is provided, the percentValue is set to 100. In other cases of invalid value, percentValue is set to its default of 0.

Default value is 0.

getShowValue

Gets current value of property showValue.

Indicates whether the displayValue should be shown in the ProgressIndicator.

Default value is true.

getState

Gets current value of property state.

Specifies the state of the bar. Enumeration sap.ui.core.ValueState provides Error, Warning, Success, Information, None (default value). The color for each state depends on the theme.

Default value is None.

getTextDirection

Gets current value of property textDirection.

Specifies the element's text directionality with enumerated options (RTL or LTR). By default, the control inherits text direction from the DOM.

Default value is Inherit.

getWidth

Gets current value of property width.

Specifies the width of the control.

Default value is '100%'.

removeAllAriaDescribedBy

Removes all the controls in the association named ariaDescribedBy.

removeAllAriaLabelledBy

Removes all the controls in the association named ariaLabelledBy.

removeAriaDescribedBy

Removes an ariaDescribedBy from the association named ariaDescribedBy.

Param Type DefaultValue Description
vAriaDescribedBy int sap.ui.core.ID sap.ui.core.Control

The ariaDescribedBy to be removed or its index or ID

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

setDisplayAnimation

Sets a new value for property displayAnimation.

Determines whether a percentage change is displayed with animation.

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
bDisplayAnimation boolean true

New value for property displayAnimation

setDisplayOnly

Sets a new value for property displayOnly.

Determines whether the control is in display-only state where the control has different visualization and cannot be focused.

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

Default value is false.

Param Type DefaultValue Description
bDisplayOnly boolean false

New value for property displayOnly

setDisplayValue

Sets a new value for property displayValue.

Specifies the text value to be displayed in the bar.

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

Param Type DefaultValue Description
sDisplayValue string

New value for property displayValue

setEnabled

Sets a new value for property enabled.

Switches enabled state of the control. Disabled fields have different colors, and cannot be focused.

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
bEnabled boolean true

New value for property enabled

setHeight

Sets a new value for property height.

Specifies the height of the control. The default value depends on the theme. Suggested size for normal use is 2.5rem (40px). Suggested size for small size (like for use in ObjectHeader) is 1.375rem (22px).

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

Param Type DefaultValue Description
sHeight sap.ui.core.CSSSize

New value for property height

setPercentValue

Sets a new value for property percentValue.

Specifies the numerical value in percent for the length of the progress bar.

Note: If a value greater than 100 is provided, the percentValue is set to 100. In other cases of invalid value, percentValue is set to its default of 0.

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

Default value is 0.

Param Type DefaultValue Description
fPercentValue float 0

New value for property percentValue

setShowValue

Sets a new value for property showValue.

Indicates whether the displayValue should be shown in the ProgressIndicator.

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
bShowValue boolean true

New value for property showValue

setState

Sets a new value for property state.

Specifies the state of the bar. Enumeration sap.ui.core.ValueState provides Error, Warning, Success, Information, None (default value). The color for each state depends on the theme.

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

Default value is None.

Param Type DefaultValue Description
sState sap.ui.core.ValueState None

New value for property state

setTextDirection

Sets a new value for property textDirection.

Specifies the element's text directionality with enumerated options (RTL or LTR). By default, the control inherits text direction from the DOM.

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

setWidth

Sets a new value for property width.

Specifies the width of the control.

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

Default value is '100%'.

Param Type DefaultValue Description
sWidth sap.ui.core.CSSSize '100%'

New value for property width