Object Page built entirely in XML
An ObjectPageLayout declared in one XML view - header title, header content and five sections whose blocks come from four different block namespaces - rather than assembled in a controller.
Z2UI5_CL_SMPC_APP_597
Controls
sap.uxap
UI5 1.71
The facts
- Repository
- abap2UI5/samples-controls
- Class
Z2UI5_CL_SMPC_APP_597- Source file
z2ui5_cl_smpc_app_597.clas.abap↗- Library
- sap.uxap
- UI5 entity
sap.uxap.ObjectPageLayout- Demo kit sample
sap.uxap.sample.ObjectPageXML- SAP's own sample
- running at sdk.openui5.org ↗
- Minimum UI5
- 1.71 — the floor abap2UI5 holds its samples to
- In the playground
- runs in the browser, with no system and nothing installed
Keywords: objectpagelayout, object, layout, sap.uxap, objectpagexml, objectpageheader, button, verticallayout, link, horizontallayout, label, objectpagesection
Controls it builds
- sap.m.Button
- sap.m.Input
- sap.m.Label
- sap.m.Link
- sap.m.Text
- sap.ui.core.Title
- sap.ui.core.mvc.View
- sap.ui.layout.HorizontalLayout
- sap.ui.layout.VerticalLayout
- sap.ui.layout.form.SimpleForm
- sap.uxap.ObjectPageHeader
- sap.uxap.ObjectPageLayout
- sap.uxap.ObjectPageSection
- sap.uxap.ObjectPageSubSection
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_597.clas.abap — 410 lines
Click a number to link to a line — shift-click for a range.
Read it on GitHub ↗
" @keywords objectpagelayout object layout sap.uxap objectpagexml objectpageheader button verticallayout link horizontallayout label objectpagesection
" @summary An ObjectPageLayout declared in one XML view - header title, header content and five sections whose blocks come from four different block namespaces - rather than assembled in a controller.
CLASS z2ui5_cl_smpc_app_597 DEFINITION PUBLIC.
PUBLIC SECTION.
INTERFACES z2ui5_if_app.
" the ObjectPageState model, folded onto root fields: the two section titles
" and the four subsection title / mode pairs the view binds
DATA sec0_title TYPE string.
DATA sec0_sub0_title TYPE string.
DATA sec0_sub0_mode TYPE string.
DATA sec0_sub1_title TYPE string.
DATA sec0_sub1_mode TYPE string.
DATA sec1_title TYPE string.
DATA sec1_sub0_title TYPE string.
DATA sec1_sub0_mode TYPE string.
DATA sec1_sub1_title TYPE string.
DATA sec1_sub1_mode TYPE string.
" the MyEmployee record the GeneralInfo blocks map onto
DATA emp_name TYPE string.
DATA emp_job TYPE string.
DATA emp_location TYPE string.
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_597 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( ).
" Block->content inlining (app 401/416 precedent). Four of this sample's block
" types are NOT in the demo kit archive - they live in UI5's test resources
" (sap.uxap.testblocks.*) or in a Headers sample that is not published - so
" their content is improvised; see the sidecar, which says exactly which
view->ele( n = `View` ns = `mvc`
)->a( n = `height` v = `100%`
)->a( n = `xmlns` v = `sap.uxap`
)->a( n = `xmlns:mvc` v = `sap.ui.core.mvc`
)->a( n = `xmlns:m` v = `sap.m`
)->a( n = `xmlns:core` v = `sap.ui.core`
)->a( n = `xmlns:layout` v = `sap.ui.layout`
)->a( n = `xmlns:forms` v = `sap.ui.layout.form`
)->ele( `ObjectPageLayout`
)->a( n = `id` v = `ObjectPageLayout`
)->a( n = `upperCaseAnchorBar` v = `false`
)->ele( `headerTitle`
)->ele( `ObjectPageHeader`
)->a( n = `objectImageURI` v = `https://sdk.openui5.org/test-resources/sap/uxap/images/imageID_275314.png`
)->a( n = `objectTitle` v = `Denise Smith`
)->a( n = `objectSubtitle` v = `Senior UI Developer`
)->ele( `actions`
)->tag( n = `Button` ns = `m`
)->a( n = `icon` v = `sap-icon://pull-down`
)->a( n = `type` v = `Emphasized`
)->a( n = `tooltip` v = `show section`
)->a( n = `press` v = client->_event( `SHOW_CURRENT_SECTION` )
)->tag( n = `Button` ns = `m`
)->a( n = `icon` v = `sap-icon://show`
)->a( n = `type` v = `Emphasized`
)->a( n = `tooltip` v = `show state`
)->a( n = `press` v = client->_event( `SHOW_STATE` )
)->end(
)->end(
)->end(
)->ele( `headerContent`
)->ele( n = `VerticalLayout` ns = `layout`
)->tag( n = `Link` ns = `m`
)->a( n = `text` v = `+33 6 4512 5158`
)->tag( n = `Link` ns = `m`
)->a( n = `text` v = `DeniseSmith@sap.com`
)->ele( n = `HorizontalLayout` ns = `layout`
)->tag( n = `Link` ns = `m`
)->a( n = `text` v = `twitter`
)->a( n = `target` v = `_blank`
)->tag( n = `Link` ns = `m`
)->a( n = `text` v = `LinkedIn`
)->a( n = `target` v = `_blank`
)->end(
)->end(
)->ele( n = `VerticalLayout` ns = `layout`
)->tag( n = `Label` ns = `m`
)->a( n = `text` v = `Personal description`
)->ele( n = `VerticalLayout` ns = `layout`
)->a( n = `id` v = `headerDescription`
)->tag( n = `Label` ns = `m`
)->a( n = `text` v = `Personal description (2)`
)->tag( n = `Label` ns = `m`
)->a( n = `text` v = `Personal description (3)`
)->tag( n = `Label` ns = `m`
)->a( n = `text` v = `Personal description (4)`
)->end(
)->end(
)->ele( n = `VerticalLayout` ns = `layout`
)->tag( n = `Label` ns = `m`
)->a( n = `id` v = `headerRole`
)->a( n = `text` v = `Role Specific info`
)->tag( n = `Label` ns = `m`
)->a( n = `id` v = `headerRole1`
)->a( n = `text` v = `Role Specific info 1`
)->tag( n = `Label` ns = `m`
)->a( n = `id` v = `headerRole2`
)->a( n = `text` v = `Role Specific info 2`
)->end(
)->end(
)->ele( `sections`
)->ele( `ObjectPageSection`
)->a( n = `titleUppercase` v = `false`
)->a( n = `title` v = client->_bind( sec0_title )
)->ele( `subSections`
)->ele( `ObjectPageSubSection`
)->a( n = `title` v = client->_bind( sec0_sub0_title )
)->a( n = `mode` v = client->_bind( sec0_sub0_mode )
)->a( n = `titleUppercase` v = `false`
)->ele( `blocks`
" bl:GeneralInfo (improvised - see sidecar), with the
" MyEmployee record its ModelMapping names
)->ele( n = `SimpleForm` ns = `forms`
)->a( n = `editable` v = `false`
)->a( n = `layout` v = `ColumnLayout`
)->tag( n = `Title` ns = `core`
)->a( n = `text` v = `General Info`
)->tag( n = `Label` ns = `m`
)->a( n = `text` v = `Name`
)->tag( n = `Text` ns = `m`
)->a( n = `text` v = client->_bind( emp_name )
)->tag( n = `Label` ns = `m`
)->a( n = `text` v = `Job`
)->tag( n = `Text` ns = `m`
)->a( n = `text` v = client->_bind( emp_job )
)->tag( n = `Label` ns = `m`
)->a( n = `text` v = `Location`
)->tag( n = `Text` ns = `m`
)->a( n = `text` v = client->_bind( emp_location )
)->end(
)->end(
)->end(
)->ele( `ObjectPageSubSection`
)->a( n = `title` v = client->_bind( sec0_sub1_title )
)->a( n = `mode` v = client->_bind( sec0_sub1_mode )
)->a( n = `titleUppercase` v = `false`
)->ele( `actions`
)->tag( n = `Button` ns = `m`
)->a( n = `icon` v = `sap-icon://action`
)->a( n = `type` v = `Transparent`
)->a( n = `tooltip` v = `action`
)->a( n = `press` v = client->follow_up_action( val = client->cs_event-control_global
t_arg = VALUE #( ( `MESSAGE_TOAST` ) ( `show` ) ( `action pressed !` ) ) )
)->tag( n = `Button` ns = `m`
)->a( n = `icon` v = `sap-icon://edit`
)->a( n = `type` v = `Transparent`
)->a( n = `tooltip` v = `edit`
)->a( n = `press` v = client->follow_up_action( val = client->cs_event-control_global
t_arg = VALUE #( ( `MESSAGE_TOAST` ) ( `show` ) ( `action pressed !` ) ) )
)->end(
)->ele( `blocks`
" sample:MultiViewBlock, its Collapsed view
)->ele( n = `SimpleForm` ns = `forms`
)->a( n = `title` v = `Location`
)->a( n = `editable` v = `false`
)->a( n = `layout` v = `ColumnLayout`
)->tag( n = `Label` ns = `m`
)->a( n = `text` v = `Country`
)->tag( n = `Text` ns = `m`
)->a( n = `text` v = `France`
)->tag( n = `Label` ns = `m`
)->a( n = `text` v = `Subsidiary`
)->tag( n = `Text` ns = `m`
)->a( n = `text` v = `SAP France`
)->end(
" sample:MultiViewBlock, its Collapsed view
)->ele( n = `SimpleForm` ns = `forms`
)->a( n = `title` v = `Location`
)->a( n = `editable` v = `false`
)->a( n = `layout` v = `ColumnLayout`
)->tag( n = `Label` ns = `m`
)->a( n = `text` v = `Country`
)->tag( n = `Text` ns = `m`
)->a( n = `text` v = `France`
)->tag( n = `Label` ns = `m`
)->a( n = `text` v = `Subsidiary`
)->tag( n = `Text` ns = `m`
)->a( n = `text` v = `SAP France`
)->end(
)->end(
)->ele( `moreBlocks`
" sample:MultiViewBlock, its Collapsed view
)->ele( n = `SimpleForm` ns = `forms`
)->a( n = `title` v = `Location`
)->a( n = `editable` v = `false`
)->a( n = `layout` v = `ColumnLayout`
)->tag( n = `Label` ns = `m`
)->a( n = `text` v = `Country`
)->tag( n = `Text` ns = `m`
)->a( n = `text` v = `France`
)->tag( n = `Label` ns = `m`
)->a( n = `text` v = `Subsidiary`
)->tag( n = `Text` ns = `m`
)->a( n = `text` v = `SAP France`
)->end(
)->end(
)->end(
)->end(
)->end(
)->ele( `ObjectPageSection`
)->a( n = `titleUppercase` v = `false`
)->a( n = `title` v = client->_bind( sec1_title )
)->ele( `subSections`
)->ele( `ObjectPageSubSection`
)->a( n = `title` v = client->_bind( sec1_sub0_title )
)->a( n = `mode` v = client->_bind( sec1_sub0_mode )
)->a( n = `titleUppercase` v = `false`
)->ele( `blocks`
" bl:GeneralInfo (improvised - see sidecar), the same
" block a second time, with the same ModelMapping
)->ele( n = `SimpleForm` ns = `forms`
)->a( n = `editable` v = `false`
)->a( n = `layout` v = `ColumnLayout`
)->tag( n = `Title` ns = `core`
)->a( n = `text` v = `General Info`
)->tag( n = `Label` ns = `m`
)->a( n = `text` v = `Name`
)->tag( n = `Text` ns = `m`
)->a( n = `text` v = client->_bind( emp_name )
)->tag( n = `Label` ns = `m`
)->a( n = `text` v = `Job`
)->tag( n = `Text` ns = `m`
)->a( n = `text` v = client->_bind( emp_job )
)->tag( n = `Label` ns = `m`
)->a( n = `text` v = `Location`
)->tag( n = `Text` ns = `m`
)->a( n = `text` v = client->_bind( emp_location )
)->end(
)->end(
)->end(
)->ele( `ObjectPageSubSection`
)->a( n = `title` v = client->_bind( sec1_sub1_title )
)->a( n = `mode` v = client->_bind( sec1_sub1_mode )
)->a( n = `titleUppercase` v = `false`
)->ele( `blocks`
" edit:SimpleEdit (improvised - see sidecar)
)->ele( n = `SimpleForm` ns = `forms`
)->a( n = `editable` v = `true`
)->a( n = `layout` v = `ColumnLayout`
)->tag( n = `Title` ns = `core`
)->a( n = `text` v = `Simple Edit`
)->tag( n = `Label` ns = `m`
)->a( n = `text` v = `Name`
)->tag( n = `Input` ns = `m`
)->a( n = `value` v = client->_bind( emp_name )
)->tag( n = `Label` ns = `m`
)->a( n = `text` v = `Job`
)->tag( n = `Input` ns = `m`
)->a( n = `value` v = client->_bind( emp_job )
)->end(
" mb:MixedBlock (improvised - see sidecar)
)->ele( n = `SimpleForm` ns = `forms`
)->a( n = `editable` v = `true`
)->a( n = `layout` v = `ColumnLayout`
)->tag( n = `Title` ns = `core`
)->a( n = `text` v = `Mixed Block`
)->tag( n = `Label` ns = `m`
)->a( n = `text` v = `Location`
)->tag( n = `Text` ns = `m`
)->a( n = `text` v = client->_bind( emp_location )
)->tag( n = `Label` ns = `m`
)->a( n = `text` v = `Job`
)->tag( n = `Input` ns = `m`
)->a( n = `value` v = client->_bind( emp_job )
)->end(
)->end(
)->ele( `moreBlocks`
" sample:MultiViewBlock, its Collapsed view
)->ele( n = `SimpleForm` ns = `forms`
)->a( n = `title` v = `Location`
)->a( n = `editable` v = `false`
)->a( n = `layout` v = `ColumnLayout`
)->tag( n = `Label` ns = `m`
)->a( n = `text` v = `Country`
)->tag( n = `Text` ns = `m`
)->a( n = `text` v = `France`
)->tag( n = `Label` ns = `m`
)->a( n = `text` v = `Subsidiary`
)->tag( n = `Text` ns = `m`
)->a( n = `text` v = `SAP France`
)->end(
)->end(
)->end(
)->end(
)->end(
)->end(
)->end( ).
client->view_display( view->stringify( ) ).
ENDMETHOD.
METHOD on_event.
CASE client->get_event( ).
WHEN `SHOW_CURRENT_SECTION`.
" showCurrentSection toasts getScrollingSectionId( ) - the sample's own
" comment calls it "the only property that is not really bindable", and a
" thin frontend never sees it, so the toast reports what the page IS
client->message_toast_display( |you are currently scrolling { sec0_title }| ).
WHEN `SHOW_STATE`.
" showObjectPageState dumps the whole state model as pretty JSON
client->message_toast_display(
|ObjectPageLayout current state:\r\n| &&
|\{\n| &&
| "scrollingSectionId": "",\n| &&
| "sections": [\n| &&
| \{\n| &&
| "title": "{ sec0_title }",\n| &&
| "subsections": [\n| &&
| \{ "title": "{ sec0_sub0_title }", "mode": "{ sec0_sub0_mode }" \},\n| &&
| \{ "title": "{ sec0_sub1_title }", "mode": "{ sec0_sub1_mode }" \}\n| &&
| ]\n| &&
| \},\n| &&
| \{\n| &&
| "title": "{ sec1_title }",\n| &&
| "subsections": [\n| &&
| \{ "title": "{ sec1_sub0_title }", "mode": "{ sec1_sub0_mode }" \},\n| &&
| \{ "title": "{ sec1_sub1_title }", "mode": "{ sec1_sub1_mode }" \}\n| &&
| ]\n| &&
| \}\n| &&
| ]\n| &&
|\}| ).
ENDCASE.
ENDMETHOD.
METHOD model_init.
" the ObjectPageState model the controller seeds in onInit
sec0_title = `my first section`.
sec0_sub0_title = `general info`.
sec0_sub0_mode = `Collapsed`.
sec0_sub1_title = `my detail info`.
sec0_sub1_mode = `Collapsed`.
sec1_title = `my second section`.
sec1_sub0_title = `compensation`.
sec1_sub0_mode = `Collapsed`.
sec1_sub1_title = `compensation details`.
sec1_sub1_mode = `Expanded`.
" HRData.json has no /MyEmployee node, so the two GeneralInfo blocks render
" empty upstream; the port seeds the first /Employee row the file does carry
emp_name = `Michael Adams`.
emp_job = `Scrum Master`.
emp_location = `SAP France`.
ENDMETHOD.
ENDCLASS.More in sap.uxap
- Object Page AnchorBar with numbers — This example shows how to visualize numbers in parenthesis after the corresponding sectio…
- Object Page demonstrating beforeNavigate event — Object Page demonstrating how beforeNavigate event can be used to prevent default navigat…
- Object Page with blocks of different view types — ObjectPage sample with blocks that use different view types
- ObjectPage with first editable input — Object Page that focuses its first editable input in the currently selected section.
- ObjectPage with forms — Object Page automatically adjusts form layout to match block column layout
- Object Page with LazyLoading without blocks — This sample showcases the lazy loading using the stashed property of the ObjectPageLazyLo…
- Object Page with LazyLoading — Object Page with LazyLoading
- Object Page with predefined selected section in Tab navigation mode — Object Page sample showing a layout where the selected section is defined by the user.
- Object Page State — This example shows how the page can be accessed directly to a specific vertical position…
- Object Page using the Tab navigation mode — Object Page sample showing a layout where the navigation is Tab based (one Tab per sectio…
- Subsection with automatic layout of blocks — This example shows how blocks can be laid out automatically by the Object Page when their…
- Subsection with blocks using column layout — This example shows how the size of the blocks and be either specified or automatic
On this page