Side Panel
Demonstrates the basic usage of Side Panel.
Z2UI5_CL_SMPC_APP_663
Controls
sap.f
UI5 1.146
The facts
- Repository
- abap2UI5/samples-controls
- Class
Z2UI5_CL_SMPC_APP_663- Source file
z2ui5_cl_smpc_app_663.clas.abap↗- Library
- sap.f
- UI5 entity
sap.f.SidePanel- Demo kit sample
sap.f.sample.SidePanel- SAP's own sample
- running at sdk.openui5.org ↗
- Minimum UI5
- 1.146
- In the playground
- runs in the browser, with no system and nothing installed
Keywords: sidepanel, side, panel, sap.f, button, vbox, label, switch, select, listitem, text, sidepanelitem
Controls it builds
- sap.f.SidePanel
- sap.f.SidePanelItem
- sap.m.Button
- sap.m.Input
- sap.m.Label
- sap.m.Page
- sap.m.Select
- sap.m.Switch
- sap.m.Text
- sap.m.Title
- sap.m.VBox
- sap.ui.core.ListItem
- 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_663.clas.abap — 248 lines
Click a number to link to a line — shift-click for a range.
Read it on GitHub ↗
" @keywords sidepanel side panel sap.f button vbox label switch select listitem text sidepanelitem
" @summary Demonstrates the basic usage of Side Panel.
" @origin sap.f.sample.SidePanel - https://sdk.openui5.org/entity/sap.f.SidePanel/sample/sap.f.sample.SidePanel (status: generated - machine-written, not yet reviewed)
CLASS z2ui5_cl_smpc_app_663 DEFINITION PUBLIC.
PUBLIC SECTION.
INTERFACES z2ui5_if_app.
DATA prevent_expand TYPE abap_bool.
DATA prevent_collapse TYPE abap_bool.
DATA sidepanelposition TYPE string.
PROTECTED SECTION.
DATA client TYPE REF TO z2ui5_if_client.
METHODS view_display.
METHODS on_event.
PRIVATE SECTION.
ENDCLASS.
CLASS z2ui5_cl_smpc_app_663 IMPLEMENTATION.
METHOD z2ui5_if_app~main.
me->client = client.
IF client->check_on_init( ).
" onInit reads the SidePanel's own sidePanelPosition default into the
" settings model, which the Select then edits
sidepanelposition = `Right`.
view_display( ).
ELSEIF client->check_on_navigated( ).
view_display( ).
ELSEIF client->check_on_event( ).
on_event( ).
ENDIF.
ENDMETHOD.
METHOD view_display.
" onToggle vetoes the firing (preventDefault) when the Switch for its
" direction is on - decided per firing on the client, reading the two
" two-way bound Switch states: (!expanded && collapse) || (expanded && expand)
DATA(veto_expr) = `(!${$parameters>/expanded} && $` && client->_bind( prevent_collapse ) &&
`) || (${$parameters>/expanded} && $` && client->_bind( prevent_expand ) && `)`.
DATA(view) = z2ui5_cl_ui5_view_builder=>factory( ).
view->ele( n = `View` ns = `mvc`
)->a( n = `xmlns` v = `sap.m`
)->a( n = `xmlns:f` v = `sap.f`
)->a( n = `xmlns:mvc` v = `sap.ui.core.mvc`
)->a( n = `xmlns:core` v = `sap.ui.core`
)->a( n = `height` v = `100%`
)->ele( `Page`
)->ele( `content`
)->ele( n = `SidePanel` ns = `f`
)->a( n = `id` v = `mySidePanel`
)->a( n = `sidePanelPosition` v = client->_bind( sidepanelposition )
)->a( n = `toggle` v = client->_event( val = `TOGGLE`
arg = `${$parameters>/expanded}`
s_ctrl = VALUE #( prevent_default_expr = veto_expr check_queue_last = abap_true ) )
)->ele( n = `mainContent` ns = `f`
)->tag( `Button`
)->a( n = `text` v = `Button 1`
)->tag( `Button`
)->a( n = `text` v = `Button 2`
)->ele( `VBox`
)->a( n = `class` v = `sapUiSmallMarginTopBottom`
)->tag( `Label`
)->a( n = `text` v = `Prevent next toggle (expand) event`
)->tag( `Switch`
)->a( n = `id` v = `preventExpand`
)->a( n = `state` v = client->_bind( prevent_expand )
)->a( n = `type` v = `AcceptReject`
)->a( n = `class` v = `sapUiSmallMarginBottom`
)->tag( `Label`
)->a( n = `text` v = `Prevent next toggle (collapse) event`
)->tag( `Switch`
)->a( n = `id` v = `preventCollapse`
)->a( n = `state` v = client->_bind( prevent_collapse )
)->a( n = `type` v = `AcceptReject`
)->a( n = `class` v = `sapUiSmallMarginBottom`
)->tag( `Label`
)->a( n = `text` v = `Select Flex content position`
)->a( n = `labelFor` v = `flexPanelPosition`
)->ele( `Select`
)->a( n = `id` v = `flexPanelPosition`
" onChangePosition is the two-way binding SidePanel.sidePanelPosition shares
)->a( n = `selectedKey` v = client->_bind( sidepanelposition )
)->tag( n = `ListItem` ns = `core`
)->a( n = `text` v = `Left`
)->a( n = `key` v = `Left`
)->tag( n = `ListItem` ns = `core`
)->a( n = `text` v = `Right`
)->a( n = `key` v = `Right`
)->end(
)->end(
)->tag( `Text`
)->a( n = `text` v = `Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ` &&
`ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint ` &&
`occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum`
)->tag( `Text`
)->a( n = `text` v = `Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ` &&
`ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint ` &&
`occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum`
)->tag( `Text`
)->a( n = `text` v = `Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ` &&
`ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint ` &&
`occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum`
)->tag( `Text`
)->a( n = `text` v = `Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ` &&
`ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint ` &&
`occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum`
)->tag( `Text`
)->a( n = `text` v = `Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ` &&
`ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint ` &&
`occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum`
)->tag( `Text`
)->a( n = `text` v = `Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ` &&
`ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint ` &&
`occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum`
)->tag( `Text`
)->a( n = `text` v = `Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ` &&
`ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint ` &&
`occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum`
)->tag( `Text`
)->a( n = `text` v = `Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ` &&
`ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint ` &&
`occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum`
)->tag( `Text`
)->a( n = `text` v = `Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ` &&
`ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint ` &&
`occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum`
)->tag( `Text`
)->a( n = `text` v = `Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ` &&
`ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint ` &&
`occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum`
)->end(
)->ele( n = `items` ns = `f`
)->ele( n = `SidePanelItem` ns = `f`
)->a( n = `icon` v = `sap-icon://physical-activity`
)->a( n = `text` v = `Run`
)->ele( n = `title` ns = `f`
)->tag( `Title`
)->a( n = `text` v = `Run`
)->a( n = `level` v = `H2`
)->end(
)->ele( `VBox`
)->tag( `Text`
)->a( n = `text` v = `Static Content`
)->a( n = `class` v = `sapUiSmallMarginBottom`
)->tag( `Text`
)->a( n = `text` v = `Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.`
)->tag( `Switch`
)->tag( `Button`
)->a( n = `text` v = `Press me`
)->end(
)->end(
)->ele( n = `SidePanelItem` ns = `f`
)->a( n = `icon` v = `sap-icon://addresses`
)->a( n = `text` v = `Go home`
)->ele( `VBox`
)->tag( `Text`
)->a( n = `text` v = `Static Content`
)->a( n = `class` v = `sapUiSmallMarginBottom`
)->tag( `Button`
)->a( n = `text` v = `Press me`
)->tag( `Button`
)->a( n = `text` v = `Hit me`
)->tag( `Button`
)->a( n = `text` v = `Touch me`
)->end(
)->end(
)->ele( n = `SidePanelItem` ns = `f`
)->a( n = `icon` v = `sap-icon://building`
)->a( n = `text` v = `Go to office`
" onToggle builds this VBox into the third item when it expands (destroyContent +
" addContent) - declared here up front, it is only ever seen expanded
)->ele( `VBox`
)->tag( `Text`
)->a( n = `text` v = `Dynamically added content`
)->a( n = `class` v = `sapUiSmallMarginBottom`
)->tag( `Label`
)->a( n = `text` v = `Label 1`
)->tag( `Input`
)->tag( `Label`
)->a( n = `text` v = `Label 2`
)->tag( `Input`
)->tag( `Label`
)->a( n = `text` v = `Label 3`
)->tag( `Input`
)->end(
)->end(
)->tag( n = `SidePanelItem` ns = `f`
)->a( n = `icon` v = `sap-icon://flight`
)->a( n = `text` v = `Fly abroad`
)->a( n = `enabled` v = `false` ).
client->view_display( view->stringify( ) ).
ENDMETHOD.
METHOD on_event.
IF client->get_event( ) = `TOGGLE`.
" the event reaches the backend whether or not the veto fired; on a
" vetoed direction the original toasts and resets that Switch, otherwise
" the control has already toggled itself. No view_display( ): the
" expanded item lives in the control, a re-render would collapse it
DATA(expanded) = xsdbool( client->get_event_arg( ) = abap_true ).
IF expanded = abap_false AND prevent_collapse = abap_true.
prevent_collapse = abap_false.
client->message_toast_display( `I am prevented COLLAPSE event` ).
ELSEIF expanded = abap_true AND prevent_expand = abap_true.
prevent_expand = abap_false.
client->message_toast_display( `I am prevented EXPAND event` ).
ENDIF.
ENDIF.
ENDMETHOD.
ENDCLASS.More in sap.f
- Grid List - Item Designs — This is a sample for GridList item templates representing a typical tools page dashboard…
- Navigation with keyboard arrows between multiple GridLists — This sample demonstrates the keyboard navigation between multiple grids
- Shell Bar with Product Switch — Shell Bar example with enabled Product Switch, configurable by the app developer. The Pro…
- Shell Bar with Flexible Column Layout — Example of Shell Bar in combination with Flexible Column Layout.
- Shell Bar with Split App — Example of Shell Bar in combination with Split App.
- Avatar Group — This sample demonstrates the different group types and item sizes of the AvatarGroup cont…
- Side Panel with overflow menu — Demonstrates the usage of Side Panel with overflow menu on desktop and tablet devices.
- Resizable Side Panel — Demonstrates the usage of resizable Side Panel.
- Product Switch with imageSrc — This sample demonstrates the usage of Product Switch Item with imageSrc, configurable by…
- Hero Banner - Basic — A basic Hero Banner with a header text and overline text.
- Hero Banner - Columns Ratio — Demonstrates the three columnsRatio options: single column (no endContent), Equal, and Fi…
- Hero Banner - Header Block and Actions Placement — Demonstrates actionsPlacement and headerBlockPlacement properties for controlling the pos…
On this page