Web Dynpro ProgressIndicator API -
IWDProgressIndicator 
Definition
The ProgressIndicator UI element shows the progress of an activity in the form of a horizontal bar, along with the value of the percentValue property. You can use the displayValue property to display a text in the progress bar on the left side of the UI element. This makes it possible to provide descriptions with specific percentage values. You can hide the DisplayValue value using the showValue property. You can display the ProgessIndicator in different colors using the barColor property. See the barColor property below.
Use
The ProgressIndicator can, for example, be used to display the completion status of a project as a percentage.
Description of the UI Element Properties
·
barColor
Specifies the logical color of the UI element. The default value of this
property is neutral. The designproperty can be filled with the following values and
is represented by the enumeration type WDProgressIndicatorBarColor.
Value |
Appearance of UI element ((width = 100 Pixel; displayValue = no value) |
Short Description |
critical |
|
Bar shown in orange. |
negative |
|
Bar shown in red. |
neutral |
|
Bar shown in blue. |
positive |
|
Bar shown in green. |
·
displayValue
Used to display a text in the
progress bar. You can set a value in the application to display a text such as
“done” or “critical” for a specified percentage value.
If you do not assign a value to this property, it takes by default the value
you have assigned to percentValue, displayed as a text with a percentage sign –
for example, 42%.
·
percentValue
Specifies the progress made as a percentage.
·
showValue
Specifies whether the value of the property displayValue – a text on the progress bar – is
displayed or hidden.
·
width
Specifies the width of the ProgressIndicator. You can specify the width
in CSS units like em, ex, pixels, or percentage.
Overview of Inherited and Additional Properties
Name |
Interface |
Type |
Initial Value |
Bindable |
Value Required |
barColor |
IWDProgressIndicator |
WDProgressIndicatorBarColor |
neutral |
bindable |
No |
displayValue |
IWDProgressIndicator |
String |
|
bindable |
No |
IWDUIElement |
boolean |
true |
bindable |
No |
|
percentValue |
IWDProgressIndicator |
int |
0 |
bindable |
No |
showValue |
IWDProgressIndicator |
boolean |
true |
bindable |
No |
IWDUIElement |
String (TranslatableText) |
|
bindable |
No |
|
IWDUIElement |
WDVisibility |
visible |
bindable |
No |
|
width |
IWDProgressIndicator |
String |
|
bindable |
No |
The inherited enabled property is ignored and does not affect the browser.
Methods in the Web Dynpro IWDProgressIndicator API
Method Name |
Parameter |
Return Value |
Short Description |
bindBarColor |
(String path) |
|
Binds the value of the barColor property to the context element specified by the path. |
bindDisplayValue |
(String path) |
|
Binds the value of the displayValue property to the context element specified by the path. |
bindingOfBarColor |
|
String |
Returns the path of the context element to which the barColor property is bound. Returns NULL if no binding exists. |
bindingOfDisplayValue |
|
String |
Returns the path of the context element to which the displayValue property is bound. Returns NULL if no binding exists. |
bindingOfPercentValue |
|
String |
Returns the path of the context element to which the percentValue property is bound. Returns NULL if no binding exists. |
bindingOfShowValue |
|
String |
Returns the path of the context element to which the showValue property is bound. Returns NULL if no binding exists. |
bindingOfWidth |
|
String |
Returns the path of the context element to which the width property is bound. Returns NULL if no binding exists. |
bindPercentValue |
(String path) |
|
Binds the value of the percentValue property to the context element specified by the path. |
bindShowValue |
(String path) |
|
Binds the value of the showValue property to the context element specified by the path. |
bindWidth |
(String path) |
|
Binds the value of the width property to the context element specified by the path. |
getBarColor |
|
WDProgressIndicatorBarColor |
Returns the value of the barColor property. |
getDisplayValue |
|
String |
Returns the value of the displayValue property. |
getPercentValue |
|
int |
Returns the value of percentValue property. |
getShowValue |
|
boolean |
Returns the value of the showValue property. |
getWidth |
|
String |
Returns the value of the width property. |
setBarColor |
(WDProgressIndicatorBarColor value) |
|
Sets the value of the barColor property. |
setDisplayValue |
(String value) |
|
Sets the value of the displayValue property. |
setPercentValue |
(int value) |
|
Sets the value of percentValue property. |
setShowValue |
(boolean value) |
|
Sets the value of the showValue property. |
setWidth |
(String value) |
|
Sets the value of the width property. |
Additional methods described in the following APIs are available using inheritance:
IWDTableCellEditor
(see
Data Binding of a
Table), IWDUIElement, IWDViewElement.
For detailed documentation of all inherited methods, see the documentation for the relevant APIs.