Web Dynpro Phase API –
IWDPhase 
Definition
The phase element is a step in a PhaseIndicator UI element.
Description of UI Element Properties
·
description
Allows you to display a text on a phase.
·
enabled
Specifies whether or not the
phase is activated.
·
state
Describes the status of the
phase. The status property can be filled with the following values and is
represented by the enumeration type WDPhaseStatus.
normal |
Describes the normal state of the phase. |
completed |
Indicates that the phase is complete. |
warning |
Describes a warning state of the phase. |
unavailable |
Indicates that the phase is not available. |
·
tooltip
Describes a note for the UI
element that is displayed when the user places the cursor on the
phase.
Overview of Inherited and Additional Properties
Name |
Interface |
Type |
Initial Value |
Bindable |
Value Required |
description |
IWDPhase |
String |
|
bindable |
No |
enabled |
IWDPhase |
boolean |
true |
bindable |
No |
status |
IWDPhase |
WDPhaseStatus |
normal |
bindable |
No |
tooltip |
IWDPhase |
String |
|
bindable |
No |
Methods in the Web Dynpro IWDPhase API
Method Name |
Parameter |
Return Value |
Description |
bindDescription |
(String path) |
|
Binds the value of the description property to the context element specified by the path. |
bindEnabled |
(String path) |
|
Binds the value of the enabled property to the context element specified by the path. |
bindingOfDescription |
|
String |
Returns the path of the context element to which the description property is bound. Returns NULL if no binding exists. |
bindingOfEnabled |
|
String |
Returns the path of the context element to which the enabled property is bound. Returns NULL if no binding exists. |
bindingOfStatus |
|
String |
Returns the path of the context element to which the status property is bound. Returns NULL if no binding exists. |
bindingOfTooltip |
|
String |
Returns the path of the context element to which the tooltip property is bound. Returns NULL if no binding exists. |
bindStatus |
(String path) |
|
Binds the status property to the context node specified by a path. |
bindTooltip |
(String path) |
|
Binds the value of the tooltip property to the context element specified by the path. |
getDescription |
|
String |
Returns the value of the description property. |
getEnabled |
|
boolean |
Returns the value of the enabled property. |
getPhaseIndicator |
|
IWDPhaseIndicator |
Returns the PhaseIndicator element that contains this phase element. |
getStatus |
|
WDPhaseStatus |
Returns the value of the status property. |
getTooltip |
|
String |
Returns the value of the tooltip property. |
setDescription |
(String description) |
|
Sets the value of the description property. |
setEnabled |
(Boolean enabled) |
|
Sets the value of the enabled property. |
setStatus |
(WDPhaseStatus status) |
|
Sets the value of the status property. |
setTooltip |
(String tooltip) |
|
Sets the value of the tooltip property. |
Additional methods are available using inheritance: IWDViewElement.