Tool Page Horizontal and Vertical Navigation
A tool page layout with horizontal navigation (on desktop and tablet) and vertical navigation (on phone)
Z2UI5_CL_SMPC_APP_302
Controls
sap.tnt
UI5 1.121
The facts
- Repository
- abap2UI5/samples-controls
- Class
Z2UI5_CL_SMPC_APP_302- Source file
z2ui5_cl_smpc_app_302.clas.abap↗- Library
- sap.tnt
- UI5 entity
sap.tnt.ToolPage- Demo kit sample
sap.tnt.sample.ToolPageNavigation- SAP's own sample
- running at sdk.openui5.org ↗
- Minimum UI5
- 1.121
- In the playground
- runs in the browser, with no system and nothing installed
Keywords: toolpage, tool, sap.tnt, toolpagenavigation, toolheader, button, overflowtoolbarlayoutdata, image, title, text, toolbarspacer, searchfield
Controls it builds
- sap.m.Avatar
- sap.m.Button
- sap.m.IconTabFilter
- sap.m.IconTabHeader
- sap.m.Image
- sap.m.NavContainer
- sap.m.OverflowToolbarButton
- sap.m.OverflowToolbarLayoutData
- sap.m.ScrollContainer
- sap.m.SearchField
- sap.m.Text
- sap.m.Title
- sap.m.ToolbarSeparator
- sap.m.ToolbarSpacer
- sap.tnt.NavigationList
- sap.tnt.NavigationListItem
- sap.tnt.SideNavigation
- sap.tnt.ToolHeader
- sap.tnt.ToolHeaderUtilitySeparator
- sap.tnt.ToolPage
- sap.ui.core.mvc.View
Read out of the builder chain by the abap2UI5 linter, not from the category this sample is filed under — which is what makes “which samples build one of these” a question the catalogue can answer at all.
Libraries
Run it here
The sample running, in this page — the app on its own, with no editor over it.
Switch to Playground with this code
Nothing is installed and nothing is sent anywhere: the ABAP is compiled to JavaScript in this browser and runs against abap2UI5 itself.
The ABAP
z2ui5_cl_smpc_app_302.clas.abap — 438 lines
Click a number to link to a line — shift-click for a range.
Read it on GitHub ↗
" @keywords toolpage tool sap.tnt toolpagenavigation toolheader button overflowtoolbarlayoutdata image title text toolbarspacer searchfield
" @summary A tool page layout with horizontal navigation (on desktop and tablet) and vertical navigation (on phone)
CLASS z2ui5_cl_smpc_app_302 DEFINITION PUBLIC.
PUBLIC SECTION.
INTERFACES z2ui5_if_app.
DATA selectedkey TYPE string.
DATA side_expanded TYPE abap_bool.
DATA toggle_tooltip TYPE string.
TYPES: BEGIN OF ty_s_sub_item,
title TYPE string,
key TYPE string,
enabled TYPE abap_bool,
END OF ty_s_sub_item.
TYPES: BEGIN OF ty_s_nav_item,
title TYPE string,
icon TYPE string,
key TYPE string,
enabled TYPE abap_bool,
expanded TYPE abap_bool,
items TYPE STANDARD TABLE OF ty_s_sub_item WITH EMPTY KEY,
END OF ty_s_nav_item.
DATA navigation TYPE STANDARD TABLE OF ty_s_nav_item WITH EMPTY KEY.
PROTECTED SECTION.
DATA client TYPE REF TO z2ui5_if_client.
METHODS view_display.
METHODS on_event.
METHODS model_init.
PRIVATE SECTION.
ENDCLASS.
CLASS z2ui5_cl_smpc_app_302 IMPLEMENTATION.
METHOD z2ui5_if_app~main.
me->client = client.
IF client->check_on_init( ).
model_init( ).
view_display( ).
ELSEIF client->check_on_navigated( ).
view_display( ).
ELSEIF client->check_on_event( ).
on_event( ).
ENDIF.
ENDMETHOD.
METHOD view_display.
DATA(view) = z2ui5_cl_ui5_view_builder=>factory( ).
view->ele( n = `View` ns = `mvc`
)->a( n = `xmlns` v = `sap.m`
)->a( n = `xmlns:mvc` v = `sap.ui.core.mvc`
)->a( n = `xmlns:tnt` v = `sap.tnt`
)->a( n = `height` v = `100%`
)->ele( n = `ToolPage` ns = `tnt`
)->a( n = `id` v = `toolPage`
" onSideNavButtonPress toggles ToolPage.sideExpanded imperatively;
" the property is bindable, so it is two-way bound here instead
)->a( n = `sideExpanded` v = client->_bind( side_expanded )
)->ele( n = `header` ns = `tnt`
)->ele( n = `ToolHeader` ns = `tnt`
)->ele( `Button`
" the device> named model is served on every view slot, so the
" original phone branch stays a branch (CAPABILITIES.md)
)->a( n = `visible` v = `{= ${device>/system/phone}}`
)->a( n = `id` v = `sideNavigationToggleButton`
)->a( n = `icon` v = `sap-icon://menu2`
)->a( n = `type` v = `Transparent`
)->a( n = `tooltip` v = client->_bind( toggle_tooltip )
)->a( n = `press` v = client->_event( `SIDE_NAV_TOGGLE` )
)->ele( `layoutData`
)->tag( `OverflowToolbarLayoutData`
)->a( n = `priority` v = `NeverOverflow`
)->end(
)->end(
)->tag( `Image`
)->a( n = `height` v = `1.5rem`
)->a( n = `class` v = `sapUiSmallMarginBegin`
)->a( n = `src` v = `https://www.sap.com/dam/application/shared/logos/sap-logo-svg.svg`
)->ele( `Title`
)->a( n = `level` v = `H1`
)->a( n = `text` v = `Product Name`
)->a( n = `wrapping` v = `false`
)->a( n = `id` v = `productName`
)->ele( `layoutData`
)->tag( `OverflowToolbarLayoutData`
)->a( n = `priority` v = `Disappear`
)->end(
)->end(
)->ele( `Text`
)->a( n = `text` v = `Second Тitle`
)->a( n = `wrapping` v = `false`
)->a( n = `id` v = `secondTitle`
)->ele( `layoutData`
)->tag( `OverflowToolbarLayoutData`
)->a( n = `priority` v = `Disappear`
)->end(
)->end(
)->tag( `ToolbarSpacer`
)->ele( `SearchField`
)->a( n = `width` v = `25rem`
)->a( n = `id` v = `searchField`
)->ele( `layoutData`
)->tag( `OverflowToolbarLayoutData`
)->a( n = `priority` v = `Low`
)->a( n = `group` v = `1`
)->end(
)->end(
)->tag( `Button`
)->a( n = `visible` v = `false`
)->a( n = `icon` v = `sap-icon://search`
)->a( n = `type` v = `Transparent`
)->a( n = `id` v = `searchButton`
)->a( n = `tooltip` v = `Search`
)->ele( `OverflowToolbarButton`
)->a( n = `icon` v = `sap-icon://source-code`
)->a( n = `type` v = `Transparent`
)->a( n = `tooltip` v = `Action 1`
)->a( n = `text` v = `Action 1`
)->ele( `layoutData`
)->tag( `OverflowToolbarLayoutData`
)->a( n = `group` v = `2`
)->end(
)->end(
)->ele( `OverflowToolbarButton`
)->a( n = `icon` v = `sap-icon://card`
)->a( n = `type` v = `Transparent`
)->a( n = `tooltip` v = `Action 2`
)->a( n = `text` v = `Action 2`
)->ele( `layoutData`
)->tag( `OverflowToolbarLayoutData`
)->a( n = `group` v = `2`
)->end(
)->end(
)->ele( `ToolbarSeparator`
)->ele( `layoutData`
)->tag( `OverflowToolbarLayoutData`
)->a( n = `group` v = `2`
)->end(
)->end(
)->tag( `OverflowToolbarButton`
)->a( n = `icon` v = `sap-icon://action-settings`
)->a( n = `type` v = `Transparent`
)->a( n = `text` v = `Settings`
)->ele( `Button`
)->a( n = `icon` v = `sap-icon://bell`
)->a( n = `type` v = `Transparent`
)->a( n = `tooltip` v = `Notification`
)->ele( `layoutData`
)->tag( `OverflowToolbarLayoutData`
)->a( n = `priority` v = `NeverOverflow`
)->end(
)->end(
)->tag( n = `ToolHeaderUtilitySeparator` ns = `tnt`
)->tag( `ToolbarSpacer`
)->a( n = `width` v = `1.125rem`
)->ele( `Avatar`
)->a( n = `src` v = `https://sdk.openui5.org/test-resources/sap/tnt/images/Woman_avatar_01.png`
)->a( n = `displaySize` v = `XS`
)->a( n = `tooltip` v = `Profile`
)->ele( `layoutData`
)->tag( `OverflowToolbarLayoutData`
)->a( n = `priority` v = `NeverOverflow`
)->end(
)->end(
)->end(
)->end(
)->ele( n = `subHeader` ns = `tnt`
)->ele( n = `ToolHeader` ns = `tnt`
)->a( n = `visible` v = `{=! ${device>/system/phone}}`
)->ele( `IconTabHeader`
)->a( n = `selectedKey` v = client->_bind( selectedkey )
)->a( n = `items` v = |\{path: '{ client->_bind_path( navigation ) }'\}|
)->a( n = `select` v = client->_event( val = `ITEM_SELECT` arg = `${$parameters>/item}.getKey()` )
)->a( n = `mode` v = `Inline`
)->ele( `layoutData`
)->tag( `OverflowToolbarLayoutData`
)->a( n = `priority` v = `NeverOverflow`
)->a( n = `shrinkable` v = `true`
)->end(
)->ele( `items`
)->ele( `IconTabFilter`
)->a( n = `items` v = `{ITEMS}`
)->a( n = `icon` v = `{ICON}`
)->a( n = `text` v = `{TITLE}`
)->a( n = `key` v = `{KEY}`
)->a( n = `interactionMode` v = `SelectLeavesOnly`
)->ele( `items`
)->tag( `IconTabFilter`
)->a( n = `text` v = `{TITLE}`
)->a( n = `key` v = `{KEY}`
)->a( n = `enabled` v = `{ENABLED}`
)->end(
)->end(
)->end(
)->end(
)->end(
)->end(
)->ele( n = `sideContent` ns = `tnt`
)->ele( n = `SideNavigation` ns = `tnt`
)->a( n = `visible` v = `{= ${device>/system/phone}}`
)->a( n = `expanded` v = `true`
)->a( n = `selectedKey` v = client->_bind( selectedkey )
)->a( n = `itemSelect` v = client->_event( val = `ITEM_SELECT` arg = `${$parameters>/item}.getKey()` )
)->ele( n = `NavigationList` ns = `tnt`
)->a( n = `items` v = |\{path: '{ client->_bind_path( navigation ) }'\}|
)->ele( n = `NavigationListItem` ns = `tnt`
)->a( n = `text` v = `{TITLE}`
)->a( n = `icon` v = `{ICON}`
)->a( n = `enabled` v = `{ENABLED}`
)->a( n = `expanded` v = `{EXPANDED}`
)->a( n = `items` v = `{ITEMS}`
)->a( n = `key` v = `{KEY}`
)->tag( n = `NavigationListItem` ns = `tnt`
)->a( n = `text` v = `{TITLE}`
)->a( n = `key` v = `{KEY}`
)->a( n = `enabled` v = `{ENABLED}`
)->end(
)->end(
)->end(
)->end(
)->ele( n = `mainContents` ns = `tnt`
)->ele( `NavContainer`
)->a( n = `id` v = `pageContainer`
)->a( n = `initialPage` v = `page1`
)->ele( `pages`
)->ele( `ScrollContainer`
)->a( n = `id` v = `page1`
)->a( n = `horizontal` v = `false`
)->a( n = `vertical` v = `true`
)->a( n = `height` v = `100%`
)->a( n = `class` v = `sapUiContentPadding`
)->tag( `Text`
)->a( n = `text` v = `Home`
)->end(
)->ele( `ScrollContainer`
)->a( n = `id` v = `page2`
)->a( n = `horizontal` v = `false`
)->a( n = `vertical` v = `true`
)->a( n = `height` v = `100%`
)->a( n = `class` v = `sapUiContentPadding`
)->tag( `Text`
)->a( n = `text` v = `Applications`
)->end(
)->ele( `ScrollContainer`
)->a( n = `id` v = `page3`
)->a( n = `horizontal` v = `false`
)->a( n = `vertical` v = `true`
)->a( n = `height` v = `100%`
)->a( n = `class` v = `sapUiContentPadding`
)->tag( `Text`
)->a( n = `text` v = `Users and Groups`
)->end(
)->ele( `ScrollContainer`
)->a( n = `id` v = `page4`
)->a( n = `horizontal` v = `false`
)->a( n = `vertical` v = `true`
)->a( n = `height` v = `100%`
)->a( n = `class` v = `sapUiContentPadding`
)->tag( `Text`
)->a( n = `text` v = `Identity`
)->end(
)->ele( `ScrollContainer`
)->a( n = `id` v = `page5`
)->a( n = `horizontal` v = `false`
)->a( n = `vertical` v = `true`
)->a( n = `height` v = `100%`
)->a( n = `class` v = `sapUiContentPadding`
)->tag( `Text`
)->a( n = `text` v = `Provisioning`
)->end(
)->ele( `ScrollContainer`
)->a( n = `id` v = `page6`
)->a( n = `horizontal` v = `false`
)->a( n = `vertical` v = `true`
)->a( n = `height` v = `100%`
)->a( n = `class` v = `sapUiContentPadding`
)->tag( `Text`
)->a( n = `text` v = `Monitoring`
)->end(
)->ele( `ScrollContainer`
)->a( n = `id` v = `page7`
)->a( n = `horizontal` v = `false`
)->a( n = `vertical` v = `true`
)->a( n = `height` v = `100%`
)->a( n = `class` v = `sapUiContentPadding`
)->tag( `Text`
)->a( n = `text` v = `Resources` ).
client->view_display( view->stringify( ) ).
" The NavContainer's position is live control state: view_display( )
" destroys the MAIN slot and XMLView.create builds a fresh tree, so
" pageContainer comes back on its initialPage="page1" - while selectedkey is
" two-way bound class state that survives (both the IconTabHeader and the
" phone SideNavigation bind it), and the navigation then reads a page the
" main area is not showing. Re-issuing the SAME key the
" ITEM_SELECT branch last sent is the app-000 idiom. Guarded twice: an
" untouched key and the key the initialPage already shows both need no
" action at all
IF selectedkey IS NOT INITIAL AND selectedkey <> `page1`.
client->follow_up_action( val = client->cs_event-control_by_id
t_arg = VALUE #( ( `pageContainer` ) ( `to` ) ( selectedkey ) ) ).
ENDIF.
ENDMETHOD.
METHOD on_event.
CASE client->get_event( ).
WHEN `ITEM_SELECT`.
" original onItemSelect: pageContainer.to( the selected item's key )
client->follow_up_action( val = client->cs_event-control_by_id
t_arg = VALUE #( ( `pageContainer` )
( `to` )
( client->get_event_arg( ) ) ) ).
WHEN `SIDE_NAV_TOGGLE`.
" original onSideNavButtonPress: sets the toggle button's tooltip from the
" CURRENT sideExpanded state, then flips ToolPage.sideExpanded
toggle_tooltip = COND #( WHEN side_expanded = abap_true
THEN `Large Size Navigation`
ELSE `Small Size Navigation` ).
side_expanded = xsdbool( side_expanded = abap_false ).
ENDCASE.
ENDMETHOD.
METHOD model_init.
" model/data.json of the sample, inlined 1:1. ENABLED/EXPANDED are not in the
" mock - the rows carry the UI5 property default (true) explicitly so the
" flat serialization cannot override it with an empty value
selectedkey = `page1`.
side_expanded = abap_true.
" _setToggleButtonTooltip( !Device.system.desktop ) at init, read from the
" device data the framework mirrors server-side
toggle_tooltip = COND #( WHEN client->get( )-s_device-system = z2ui5_if_client=>cs_device-system-desktop
THEN `Small Size Navigation`
ELSE `Large Size Navigation` ).
navigation = VALUE #(
enabled = abap_true expanded = abap_true
( title = `Home` icon = `sap-icon://home` key = `page1` )
( title = `Applications` icon = `sap-icon://internet-browser` key = `page2` )
( title = `Users and Groups` icon = `sap-icon://family-care` key = `page3`
items = VALUE #( enabled = abap_true
( title = `User 1` key = `page3` )
( title = `User 2` key = `page3` )
( title = `User 3` key = `page3` ) ) )
( title = `Identity` icon = `sap-icon://business-card` key = `page4`
items = VALUE #( enabled = abap_true
( title = `Identity 1` key = `page4` )
( title = `Identity 2` key = `page4` )
( title = `Identity 3` key = `page4` ) ) )
( title = `Provisioning` icon = `sap-icon://generate-shortcut` key = `page5` )
( title = `Monitoring` icon = `sap-icon://unwired` key = `page6`
items = VALUE #( enabled = abap_true
( title = `Monitoring 1` key = `page6` )
( title = `Monitoring 2` key = `page6` ) ) )
( title = `Resources` icon = `sap-icon://document-text` key = `page7`
items = VALUE #( enabled = abap_true
( title = `Resource 1` key = `page7` )
( title = `Resource 2` key = `page7` )
( title = `Resource 3` key = `page7` ) ) ) ).
ENDMETHOD.
ENDCLASS.More in sap.tnt
- ToolHeader — ToolHeader that mimics the content of the Shell.
- InfoLabel in DynamicPage — InfoLabel used as subheader in DynamicPage
- Tool Page with Vertical Navigation — A tool page layout with vertical navigation
- Side Navigation - Unselectable Parent Items — SideNavigation with unselectable parent items.
- InfoLabel in Table — InfoLabel used in content of Table
- ToolHeader with IconTabHeader — ToolHeader can contain IconTabHeader. When both controls are combined, the IconTabHeader…
- Side Navigation - Press Event — SideNavigation with press event parameters and preventDefault.
- Side Navigation - Actions — SideNavigation with a quick create action button.
- Side Navigation - Wrapping of long texts — SideNavigation with long texts that wrap.
- Side Navigation - Overlay Mode — SideNavigation in a responsive popover.
- Tool Page with Horizontal Navigation — A tool page layout with horizontal navigation
- Side Navigation with Search — SideNavigation with a search field in the filter section and filterable navigation items.
On this page