class sap.ui.commons.ProgressIndicator

Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/commons/ProgressIndicator
Application Component: CA-UI5-CTR

Shows the progress of a process in a graphical way. The indicator can be displayed with or without numerical values. The filling can be displayed in color only, or additionally with the percentage rate. The indicator status can be interactive.


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.ui.commons.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
barColor sap.ui.core.BarColor NEUTRAL

Determines the color of the bar which visualizes the progress. Possible values defined in the sap.ui.core.BarColor enumeration are the following: CRITICAL (yellow), NEGATIVE (red), POSITIVE (green), NEUTRAL (blue) (default value).

Visibility: public
displayValue string 0%

Determines the text value that will be displayed in the bar.

Visibility: public
enabled boolean true

Determines whether the control is enabled or not. Disabled controls have different colors, and can not be focused.

Visibility: public
percentValue int 0

Determines the numerical value for the displayed length of the progress bar.

Visibility: public
showValue boolean true

Determines whether the percent value shall be rendered inside the bar.

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

Determines the width of the control.

Visibility: public

Methods Overview

Method Description
sap.ui.commons.ProgressIndicator.extend

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

References:

  • sap.ui.core.Control#getAccessibilityInfo

getBarColor

Gets current value of property barColor.

Determines the color of the bar which visualizes the progress. Possible values defined in the sap.ui.core.BarColor enumeration are the following: CRITICAL (yellow), NEGATIVE (red), POSITIVE (green), NEUTRAL (blue) (default value).

Default value is NEUTRAL.

getDisplayValue

Gets current value of property displayValue.

Determines the text value that will be displayed in the bar.

Default value is '0%'.

getEnabled

Gets current value of property enabled.

Determines whether the control is enabled or not. Disabled controls have different colors, and can not be focused.

Default value is true.

sap.ui.commons.ProgressIndicator.getMetadata

Returns a metadata object for class sap.ui.commons.ProgressIndicator.

getPercentValue

Gets current value of property percentValue.

Determines the numerical value for the displayed length of the progress bar.

Default value is 0.

getShowValue

Gets current value of property showValue.

Determines whether the percent value shall be rendered inside the bar.

Default value is true.

getWidth

Gets current value of property width.

Determines the width of the control.

Default value is '100%'.

setBarColor

Sets a new value for property barColor.

Determines the color of the bar which visualizes the progress. Possible values defined in the sap.ui.core.BarColor enumeration are the following: CRITICAL (yellow), NEGATIVE (red), POSITIVE (green), NEUTRAL (blue) (default value).

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

Default value is NEUTRAL.

setDisplayValue

Sets a new value for property displayValue.

Determines the text value that will be displayed in the bar.

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

Default value is '0%'.

setEnabled

Sets a new value for property enabled.

Determines whether the control is enabled or not. Disabled controls have different colors, and can not be focused.

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

Default value is true.

setPercentValue

Sets the new percent value which the ProgressIndicator should display. A new rendering is not necessary, only the bar has to be moved.

setShowValue

Sets a new value for property showValue.

Determines whether the percent value shall be rendered inside the bar.

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

Default value is true.

setWidth

Sets a new value for property width.

Determines 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%'.

sap.ui.commons.ProgressIndicator.extend

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

References:

getBarColor

Gets current value of property barColor.

Determines the color of the bar which visualizes the progress. Possible values defined in the sap.ui.core.BarColor enumeration are the following: CRITICAL (yellow), NEGATIVE (red), POSITIVE (green), NEUTRAL (blue) (default value).

Default value is NEUTRAL.

getDisplayValue

Gets current value of property displayValue.

Determines the text value that will be displayed in the bar.

Default value is '0%'.

getEnabled

Gets current value of property enabled.

Determines whether the control is enabled or not. Disabled controls have different colors, and can not be focused.

Default value is true.

sap.ui.commons.ProgressIndicator.getMetadata

Returns a metadata object for class sap.ui.commons.ProgressIndicator.

getPercentValue

Gets current value of property percentValue.

Determines the numerical value for the displayed length of the progress bar.

Default value is 0.

getShowValue

Gets current value of property showValue.

Determines whether the percent value shall be rendered inside the bar.

Default value is true.

getWidth

Gets current value of property width.

Determines the width of the control.

Default value is '100%'.

setBarColor

Sets a new value for property barColor.

Determines the color of the bar which visualizes the progress. Possible values defined in the sap.ui.core.BarColor enumeration are the following: CRITICAL (yellow), NEGATIVE (red), POSITIVE (green), NEUTRAL (blue) (default value).

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

Default value is NEUTRAL.

Param Type DefaultValue Description
sBarColor sap.ui.core.BarColor NEUTRAL

New value for property barColor

setDisplayValue

Sets a new value for property displayValue.

Determines the text value that will be displayed in the bar.

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
sDisplayValue string '0%'

New value for property displayValue

setEnabled

Sets a new value for property enabled.

Determines whether the control is enabled or not. Disabled controls have different colors, and can not 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

setPercentValue

Sets the new percent value which the ProgressIndicator should display. A new rendering is not necessary, only the bar has to be moved.

Param Type DefaultValue Description
iPercentValue int

The new percent value of the ProgressIndicator.

setShowValue

Sets a new value for property showValue.

Determines whether the percent value shall be rendered inside the bar.

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

setWidth

Sets a new value for property width.

Determines 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