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
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
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.
getAccessibilityInfo()
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.
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
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.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:
{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.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:
{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.ProgressIndicator.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.ProgressIndicator.
Returns:
{sap.ui.base.Metadata} Metadata 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:
{string} Value 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:
{boolean} Value 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).

Since:
1.15.0
Returns:
{sap.ui.core.CSSSize} Value of property height
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:
{float} Value 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:
{boolean} Value of property showValue
getState(): sap.ui.core.ValueState
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.ValueState} Value 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.

Since:
1.28.0
Returns:
{sap.ui.core.TextDirection} Value of property textDirection
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.CSSSize} Value 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:
{string}sDisplayValue New value for property displayValue
Returns:
{sap.m.ProgressIndicator} Reference 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:
{boolean}bEnabled New value for property enabled
Returns:
{sap.m.ProgressIndicator} Reference 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.CSSSize}sHeight New value for property height
Since:
1.15.0
Returns:
{sap.m.ProgressIndicator} Reference to this in order to allow method chaining
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:
{float}fPercentValue New value for property percentValue
Returns:
{sap.m.ProgressIndicator} Reference 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:
{boolean}bShowValue New value for property showValue
Returns:
{sap.m.ProgressIndicator} Reference 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.ValueState}sState New value for property state
Returns:
{sap.m.ProgressIndicator} Reference 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.TextDirection}sTextDirection New value for property textDirection
Since:
1.28.0
Returns:
{sap.m.ProgressIndicator} Reference to this in order to allow method chaining
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.CSSSize}sWidth New value for property width
Returns:
{sap.m.ProgressIndicator} Reference to this in order to allow method chaining