PageHeader

Use

With the PageHeader, you can create a heading for a page. Any number of UI elements can be displayed below the heading in the PageHeaderArea. TextViews are displayed in the example below.

Example of the Visual Display

PageHeader and SAP NetWeaver Business Client (NWBC)

The application can create a PageHeader as described below (irrespective of the Help Center). If the application is then called in NWBCv1, the PageHeader is not rendered. The title is displayed in the NWBC instead.

To do this, the following conditions must be met:

The SAP NetWeaver Business Client is active

PageHeader.id = 'PAGE_HEADER'

PageHeader.titleContent = titleContent (TransparentContainer)

titleContent.id = 'PAGE_HEADER_LINKS'

titleContent.children = { helpLink (LinkToAction), persLink (LinkToAction))

Note that helpLink and persLink are both optional.

helpLink.id = 'PAGE_HEADER_HELP_LINK'
helpLink.menu = { }
persLink.id = 'PAGE_HEADER_PERS_LINK'
persLink.menu = { }

More information: Help Texts in and for Web Dynpro Applications.

PageHeader in Embedded View

In addition, an NWBC PageHeader may be contained in an embedded view. This allows you to implement a PageHeader in a reusable component or view.

To do this, the following prerequisites must be met:

This function can only be used to embed a view in the main view of the application.
The ViewContainerUIElement must be a direct child element of the ROOTUIELEMENTCONTAINER.

ViewContainerUIElement.id = 'PAGE_HEADER'
The rules specified above are valid for the embedded view.

Details

Runtime Class

CL_WD_PAGE_HEADER

Properties in View Designer

Name	Type	Initial Value	Bindable
id	STRING	(automatic)	No
contextMenuBehaviour	WDUI_CONTEXT_MENU_BEHAVIOUR	inherit	No
contextMenuId	WDY_MD_UI_ELEMENT_REFERENCE		No
design	WDUI_PAGE_HEADER_DESIGN	standard	Yes
enabled	WDY_BOOLEAN	true	Yes
hideTitle	WDY_BOOLEAN	false	Yes
styleClassName	STRING		Yes
textDirection	WDUI_TEXT_DIRECTION	inherit	Yes
title	Translatable text		Yes
tooltip	Translatable text		Yes
visible	WDUI_VISIBILITY	visible	Yes

Aggregations in the View Designer

Name	Cardinality	Type
Area	0..n	PageHeaderArea
Title content	0..1	UIElement

Dynamic Programming

For dynamic programming, the same properties, events, and aggregations as in the View Designer are available. But note that the spelling format and use of upper/lower case is different.

Dynamic Programming of Properties

View Designer Name	Runtime Name	Type
contextMenuBehaviour	CONTEXT_MENU_BEHAVIOUR	WDUI_CONTEXT_MENU_BEHAVIOUR
contextMenuBehaviour: inherit	CL_WD_PAGE_HEADER=>E_CONTEXT_MENU_BEHAVIOUR-INHERIT
contextMenuBehaviour: provide	CL_WD_PAGE_HEADER=>E_CONTEXT_MENU_BEHAVIOUR-PROVIDE
contextMenuBehaviour: suppress	CL_WD_PAGE_HEADER=>E_CONTEXT_MENU_BEHAVIOUR-SUPPRESS
contextMenuBehaviour	CONTEXT_MENU_ID	WDY_MD_UI_ELEMENT_REFERENCE
design	DESIGN	WDUI_PAGE_HEADER_DESIGN
design: small	CL_WD_PAGE_HEADER=>E_DESIGN-SMALL
design: standard	CL_WD_PAGE_HEADER=>E_DESIGN-STANDARD
enabled	ENABLED	WDY_BOOLEAN
hideTitle	HIDE_TITLE	WDY_BOOLEAN
styleClassName	STYLE_CLASS_NAME	STRING
textDirection	TEXT_DIRECTION	WDUI_TEXT_DIRECTION
textDirection inherit	CL_WD_PAGE_HEADER=>E_TEXT_DIRECTION-INHERIT
textDirection ltr	CL_WD_PAGE_HEADER=>E_TEXT_DIRECTION-LTR
textDirection rtl	CL_WD_PAGE_HEADER=>E_TEXT_DIRECTION-RTL
title	TITLE	WDY_MD_TRANSLATABLE_TEXT
tooltip	TOOLTIP	WDY_MD_TRANSLATABLE_TEXT
visible	VISIBLE	WDUI_VISIBILITY
visible: none	CL_WD_PAGE_HEADER=>E_VISIBLE-NONE
visible: visible	CL_WD_PAGE_HEADER=>E_VISIBLE-VISIBLE

Dynamic Programming of Aggregations

View Designer Name	Runtime Name	Cardinality
Area	AREAS	0..n
Title content	TITLE_CONTENT	0..1

View Designer Name

Runtime Name

Cardinality

Area

AREAS

0..n

Title content

TITLE_CONTENT

0..1

Example

You can find an example of this UI element in the system in the WDR_TEST_UI_ELEMENTS Web Dynpro application.