Start of Content Area

Background documentation PhaseIndicator  Locate the document in its SAP Library structure

Similar to the RoadMap UI element, the PhaseIndicator UI element displays the steps in a wizard. Each step is represented by a separate Phase object. In contrast to the RoadMap UI element, the application development can display larger steps using the PhaseIndicator UI element, which can be more time consuming for the user.

Example of the Visual Display

This graphic is explained in the accompanying text

Note

To enable the development of accessible applications, the accessibilityDescription property is checked during the syntax check if the tooltip property is not set.

 

Runtime Class

CL_WD_PHASE_INDICATOR

 

Properties in the View Designer

Name

Type

Initial Value

Bindable

id

STRING

(automatic)

No

accessibilityDescription

Translatable text

 

Yes

backgroundDesign

WDUI_PHASE_IND_BGD_DESIGN

emphasized

Yes

contextMenuBehaviour

WDUI_CONTEXT_MENU_BEHAVIOUR

inherit

No

contextMenuId

WDY_MD_UI_ELEMENT_REFERENCE

 

No

enabled

WDY_BOOLEAN

true

Yes

firstVisiblePhase

STRING

 

Yes

selectedPhase

STRING

 

Yes

tooltip

Translatable text

 

Yes

visible

WDUI_VISIBILITY

visible

Yes

 

Aggregations in the View Designer

Name

Cardinality

Type

Phase

0..n

Phase

 

Events in the View Designer

Name

onSelect

Note

Other properties that can be inherited are defined in the associated higher-level classes. The associated UI elements are:

        UIElement

        ContextMenuProvider

        ViewElement

Dynamic Programming

For dynamic programming, the same properties, events, and aggregations as in the View Designer are available. Bear in mind the different spellings.

Dynamic Programming of Properties

View Designer Name

Runtime Name

Type

accessibilityDescription

ACCESSIBILITY_DESCR

WDY_MD_TRANSLATABLE_TEXT

backgroundDesign

BACKGROUND_DESIGN

WDUI_PHASE_IND_BGD_DESIGN

 backgroundDesign: emphasized

CL_WD_PHASE_INDICATOR=>E_BACKGROUND_DESIGN-EMPHASIZED

 backgroundDesign: transparent

CL_WD_PHASE_INDICATOR=>E_BACKGROUND_DESIGN-TRANSPARENT

contextMenuBehaviour

CONTEXT_MENU_BEHAVIOUR

WDUI_CONTEXT_MENU_BEHAVIOUR

 contextMenuBehaviour: inherit

CL_WD_PHASE_INDICATOR=>E_CONTEXT_MENU_BEHAVIOUR-INHERIT

 contextMenuBehaviour: provide

CL_WD_PHASE_INDICATOR=>E_CONTEXT_MENU_BEHAVIOUR-PROVIDE

 contextMenuBehaviour: suppress

CL_WD_PHASE_INDICATOR=>E_CONTEXT_MENU_BEHAVIOUR-SUPPRESS

contextMenuId

CONTEXT_MENU_ID

WDY_MD_UI_ELEMENT_REFERENCE

enabled

ENABLED

WDY_BOOLEAN

firstVisiblePhase

FIRST_VISIBLE_PHASE

STRING

selectedPhase

SELECTED_PHASE

STRING

tooltip

TOOLTIP

WDY_MD_TRANSLATABLE_TEXT

visible

VISIBLE

WDUI_VISIBILITY

visible: none

CL_WD_PHASE_INDICATOR=>E_VISIBLE-NONE

visible: visible

CL_WD_PHASE_INDICATOR=>E_VISIBLE-VISIBLE

 

Dynamic Programming of Events

View Designer Name

Runtime Name

onSelect

ON_SELECT

 

Dynamic Programming of Aggregations

View Designer Name

Runtime Name

Cardinality

Phase

PHASES

0..n

Example

You can find examples of this interface element in the system in the component DEMO_UIEL_STD_COMPLEX in the Web Dynpro application demo_uiel_phase_indicator.

 

 

End of Content Area