Class sap.m.ProgressIndicatorModule: sap/m/ProgressIndicator

extends Control

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.
Since: 1.13.1.
Constructor Summary
new sap.m.ProgressIndicator(sId?, mSettings?)Constructor for a new ProgressIndicator.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.m.ProgressIndicator.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.ProgressIndicator with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.ProgressIndicator.getMetadata()Returns a metadata object for class sap.m.ProgressIndicator.
getDisplayValue()Gets current value of property displayValue.
getEnabled()Gets current value of property enabled.
getHeight()Gets current value of property height.
getPercentValue()Gets current value of property percentValue.
getShowValue()Gets current value of property showValue.
getState()Gets current value of property state.
getTextDirection()Gets current value of property textDirection.
getWidth()Gets current value of property width.
setDisplayValue(sDisplayValue)Sets a new value for property displayValue.
setEnabled(bEnabled)Sets a new value for property enabled.
setHeight(sHeight)Sets a new value for property height.
setPercentValue(fPercentValue)Sets a new value for property percentValue.
setShowValue(bShowValue)Sets a new value for property showValue.
setState(sState)Sets a new value for property state.
setTextDirection(sTextDirection)Sets a new value for property textDirection.
setWidth(sWidth)Sets a new value for property width.
Constructor Detail
new sap.m.ProgressIndicator(sId?, mSettings?)

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 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.ProgressIndicator.extend(sClassName, oClassInfo?, FNMetaImpl?): function

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.

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.ProgressIndicator.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.ProgressIndicator.
Returns:
sap.ui.base.MetadataMetadata object describing this class
getAccessibilityInfo()
See:
sap.ui.core.Control#getAccessibilityInfo
getDisplayValue(): string

Gets current value of property displayValue.

Specifies the text value to be displayed in the bar.

Returns:
stringValue of property displayValue
getEnabled(): boolean

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.

Returns:
booleanValue of property enabled
getHeight(): sap.ui.core.CSSSize

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

Returns:
sap.ui.core.CSSSizeValue of property height
Since:
1.15.0
getPercentValue(): float

Gets current value of property percentValue.

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

Default value is 0.

Returns:
floatValue of property percentValue
getShowValue(): boolean

Gets current value of property showValue.

Indicates whether the displayValue should be shown in the ProgressIndicator.

Default value is true.

Returns:
booleanValue of property showValue

Gets current value of property state.

Specifies the state of the bar. Enumeration sap.ui.core.ValueState provides Error (red), Warning (yellow), Success (green), None (blue) (default value).

Default value is None.

Returns:
sap.ui.core.ValueStateValue of property state
getTextDirection(): sap.ui.core.TextDirection

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.

Returns:
sap.ui.core.TextDirectionValue of property textDirection
Since:
1.28.0
getWidth(): sap.ui.core.CSSSize

Gets current value of property width.

Specifies the width of the control.

Default value is 100%.

Returns:
sap.ui.core.CSSSizeValue of property width
setDisplayValue(sDisplayValue): sap.m.ProgressIndicator

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.

Parameters:
stringsDisplayValueNew value for property displayValue
Returns:
sap.m.ProgressIndicatorReference to this in order to allow method chaining
setEnabled(bEnabled): sap.m.ProgressIndicator

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.

Parameters:
booleanbEnabledNew value for property enabled
Returns:
sap.m.ProgressIndicatorReference to this in order to allow method chaining
setHeight(sHeight): sap.m.ProgressIndicator

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.

Parameters:
sap.ui.core.CSSSizesHeightNew value for property height
Returns:
sap.m.ProgressIndicatorReference to this in order to allow method chaining
Since:
1.15.0
setPercentValue(fPercentValue): sap.m.ProgressIndicator

Sets a new value for property percentValue.

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

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

Default value is 0.

Parameters:
floatfPercentValueNew value for property percentValue
Returns:
sap.m.ProgressIndicatorReference to this in order to allow method chaining
setShowValue(bShowValue): sap.m.ProgressIndicator

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.

Parameters:
booleanbShowValueNew value for property showValue
Returns:
sap.m.ProgressIndicatorReference to this in order to allow method chaining
setState(sState): sap.m.ProgressIndicator

Sets a new value for property state.

Specifies the state of the bar. Enumeration sap.ui.core.ValueState provides Error (red), Warning (yellow), Success (green), None (blue) (default value).

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

Default value is None.

Parameters:
sap.ui.core.ValueStatesStateNew value for property state
Returns:
sap.m.ProgressIndicatorReference to this in order to allow method chaining
setTextDirection(sTextDirection): sap.m.ProgressIndicator

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.

Parameters:
sap.ui.core.TextDirectionsTextDirectionNew value for property textDirection
Returns:
sap.m.ProgressIndicatorReference to this in order to allow method chaining
Since:
1.28.0
setWidth(sWidth): sap.m.ProgressIndicator

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

Parameters:
sap.ui.core.CSSSizesWidthNew value for property width
Returns:
sap.m.ProgressIndicatorReference to this in order to allow method chaining