Class sap.ui.commons.ProgressIndicatorModule: sap/ui/commons/ProgressIndicator

extends Control

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.

Deprecated API:Since version 1.38. Instead, use the sap.m.ProgressIndicator control.

Constructor Summary
new sap.ui.commons.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.ui.commons.ProgressIndicator.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.commons.ProgressIndicator with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.commons.ProgressIndicator.getMetadata()Returns a metadata object for class sap.ui.commons.ProgressIndicator.
getAccessibilityInfo()
getBarColor()Gets current value of property barColor.
getDisplayValue()Gets current value of property displayValue.
getEnabled()Gets current value of property enabled.
getPercentValue()Gets current value of property percentValue.
getShowValue()Gets current value of property showValue.
getWidth()Gets current value of property width.
setBarColor(sBarColor)Sets a new value for property barColor.
setDisplayValue(sDisplayValue)Sets a new value for property displayValue.
setEnabled(bEnabled)Sets a new value for property enabled.
setPercentValue(iPercentValue)Sets the new percent value which the ProgressIndicator should display.
setShowValue(bShowValue)Sets a new value for property showValue.
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.ui.commons.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
Deprecated:
Since version 1.38. Instead, use the sap.m.ProgressIndicator control.
Method Detail
sap.ui.commons.ProgressIndicator.extend(sClassName, oClassInfo?, FNMetaImpl?): function
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.

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.ui.commons.ProgressIndicator.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.commons.ProgressIndicator.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getAccessibilityInfo()
See:
{sap.ui.core.Control#getAccessibilityInfo}
getBarColor(): sap.ui.core.BarColor
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.

Returns:
{sap.ui.core.BarColor} Value of property barColor
getDisplayValue(): string
Gets current value of property displayValue.

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

Default value is 0%.

Returns:
{string} Value of property displayValue
getEnabled(): boolean
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.

Returns:
{boolean} Value of property enabled
getPercentValue(): int
Gets current value of property percentValue.

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

Default value is 0.

Returns:
{int} Value of property percentValue
getShowValue(): boolean
Gets current value of property showValue.

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

Default value is true.

Returns:
{boolean} Value of property showValue
getWidth(): sap.ui.core.CSSSize
Gets current value of property width.

Determines the width of the control.

Default value is 100%.

Returns:
{sap.ui.core.CSSSize} Value of property width
setBarColor(sBarColor): sap.ui.commons.ProgressIndicator
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.

Parameters:
{sap.ui.core.BarColor}sBarColor New value for property barColor
Returns:
{sap.ui.commons.ProgressIndicator} Reference to this in order to allow method chaining
setDisplayValue(sDisplayValue): sap.ui.commons.ProgressIndicator
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%.

Parameters:
{string}sDisplayValue New value for property displayValue
Returns:
{sap.ui.commons.ProgressIndicator} Reference to this in order to allow method chaining
setEnabled(bEnabled): sap.ui.commons.ProgressIndicator
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.

Parameters:
{boolean}bEnabled New value for property enabled
Returns:
{sap.ui.commons.ProgressIndicator} Reference to this in order to allow method chaining
setPercentValue(iPercentValue): sap.ui.commons.ProgressIndicator
Sets the new percent value which the ProgressIndicator should display. A new rendering is not necessary, only the bar has to be moved.
Parameters:
{int}iPercentValue The new percent value of the ProgressIndicator.
Returns:
{sap.ui.commons.ProgressIndicator}this to allow method chaining.
setShowValue(bShowValue): sap.ui.commons.ProgressIndicator
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.

Parameters:
{boolean}bShowValue New value for property showValue
Returns:
{sap.ui.commons.ProgressIndicator} Reference to this in order to allow method chaining
setWidth(sWidth): sap.ui.commons.ProgressIndicator
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%.

Parameters:
{sap.ui.core.CSSSize}sWidth New value for property width
Returns:
{sap.ui.commons.ProgressIndicator} Reference to this in order to allow method chaining