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.14. This control is replaced by sap.m.ProgressIndicator

Constructor Summary

new sap.me.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.me.ProgressIndicator.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.me.ProgressIndicator with name sClassName and enriches it with the information contained in oClassInfo.

sap.me.ProgressIndicator.getMetadata()Returns a metadata object for class sap.me.ProgressIndicator.

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.

getVisible()Gets current value of property visible.

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)Property setter for the PercentValue A new rendering is not necessary, only the bar has to be moved.

setShowValue(bShowValue)Sets a new value for property showValue.

setVisible(bVisible)Sets a new value for property visible.

setWidth(sWidth)Sets a new value for property width.

Methods borrowed from class sap.ui.core.Control

Methods borrowed from class sap.ui.core.Element

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.me.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:

Properties
- visible : boolean (default: true)
- enabled : boolean (default: true)
- barColor : sap.ui.core.BarColor (default: NEUTRAL)
- displayValue : string (default: 0%)
- percentValue : int (default: 0)
- showValue : boolean (default: true)
- width : sap.ui.core.CSSSize (default: 100%)

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.14. This control is replaced by sap.m.ProgressIndicator

Method Detail

sap.me.ProgressIndicator.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.me.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.me.ProgressIndicator.getMetadata(): sap.ui.base.Metadata

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

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

getBarColor(): sap.ui.core.BarColor

Gets current value of property barColor.

The color of the bar. Enumeration sap.ui.core.BarColor provides 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.

The text value to be displayed in the bar.

Default value is 0%.

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

getPercentValue(): int

Gets current value of property percentValue.

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.

Specifies whether the current value shall be rendered inside the bar.

Default value is true.

Returns:

{boolean} Value of property showValue

getVisible(): boolean

Gets current value of property visible.

Invisible controls are not rendered

Default value is true.

Returns:

{boolean} Value of property visible

getWidth(): sap.ui.core.CSSSize

Gets current value of property width.

The width of the control.

Default value is 100%.

Returns:

{sap.ui.core.CSSSize} Value of property width

setBarColor(sBarColor): sap.me.ProgressIndicator

Sets a new value for property barColor.

The color of the bar. Enumeration sap.ui.core.BarColor provides 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.me.ProgressIndicator} Reference to this in order to allow method chaining

setDisplayValue(sDisplayValue): sap.me.ProgressIndicator

Sets a new value for property displayValue.

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.

Default value is 0%.

Parameters:

{string} sDisplayValue New value for property displayValue

Returns:

{sap.me.ProgressIndicator} Reference to this in order to allow method chaining

setEnabled(bEnabled): sap.me.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.me.ProgressIndicator} Reference to this in order to allow method chaining

setPercentValue(iPercentValue): sap.me.ProgressIndicator

Property setter for the PercentValue A new rendering is not necessary, only the bar has to be moved.

Parameters:

iPercentValue

Returns:

{sap.me.ProgressIndicator} this to allow method chaining

setShowValue(bShowValue): sap.me.ProgressIndicator

Sets a new value for property showValue.

Specifies whether the current 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.me.ProgressIndicator} Reference to this in order to allow method chaining

setVisible(bVisible): sap.me.ProgressIndicator

Sets a new value for property visible.

Invisible controls are not rendered

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

Default value is true.

Parameters:

{boolean} bVisible New value for property visible

Returns:

{sap.me.ProgressIndicator} Reference to this in order to allow method chaining

setWidth(sWidth): sap.me.ProgressIndicator

Sets a new value for property width.

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.me.ProgressIndicator} Reference to this in order to allow method chaining