Busy Dialog - Light

This is a 'light' version of the standard Busy Dialog; it also blocks the user interface until the currently running operation has been finished. It has no UI components, so you must close it programmatically when appropriate.

Z2UI5_CL_SMPC_APP_251

Controls sap.m UI5 1.71

The facts

Repository: abap2UI5/samples-controls
Class: Z2UI5_CL_SMPC_APP_251
Source file: z2ui5_cl_smpc_app_251.clas.abap ↗
Library: sap.m
UI5 entity: sap.m.BusyDialog
Demo kit sample: sap.m.sample.BusyDialogLight
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: busydialog, busy, dialog, sap.m, busydialoglight, verticallayout, button

Controls it builds

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_251.clas.abap — 83 lines Read it on GitHub ↗

" @keywords busydialog busy dialog sap.m busydialoglight verticallayout button
" @summary This is a 'light' version of the standard Busy Dialog; it also blocks the user interface until the currently running operation has been finished. It has no UI components, so you must close it programmatically when appropriate.
CLASS z2ui5_cl_smpc_app_251 DEFINITION PUBLIC.

  PUBLIC SECTION.
    INTERFACES z2ui5_if_app.

  PROTECTED SECTION.
    DATA client TYPE REF TO z2ui5_if_client.

    METHODS view_display.
    METHODS on_event.

  PRIVATE SECTION.
ENDCLASS.


CLASS z2ui5_cl_smpc_app_251 IMPLEMENTATION.

  METHOD z2ui5_if_app~main.

    me->client = client.
    IF 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:mvc`  v = `sap.ui.core.mvc`
        )->a( n = `xmlns:l`    v = `sap.ui.layout`
        )->a( n = `xmlns:core` v = `sap.ui.core`
        )->a( n = `xmlns`      v = `sap.m`

        )->ele( n = `VerticalLayout` ns = `l`
            )->a( n = `class` v = `sapUiContentPadding`
            )->a( n = `width` v = `100%`

            )->ele( n = `dependents` ns = `l`
                " BusyDialog.fragment.xml inlined (the core:Fragment reference
                " element is dropped, declared)
                )->tag( `BusyDialog`
                    )->a( n = `id` v = `BusyDialog`

            )->end(
            )->tag( `Button`
                )->a( n = `text`  v = `Show Light Busy Dialog`
                )->a( n = `press` v = client->_event( `SHOW_BUSY` )
                )->a( n = `class` v = `sapUiSmallMarginBottom` ).

    client->view_display( view->stringify( ) ).

  ENDMETHOD.


  METHOD on_event.

    " handlePress: oDialog.open() + setTimeout(close, 3000) - the 147 idiom
    " (control_by_id open + START_TIMER, the timer round-trip closes)
    CASE client->get_event( ).

      WHEN `SHOW_BUSY`.
        client->follow_up_action( val   = client->cs_event-control_by_id
                                  t_arg = VALUE #( ( `BusyDialog` ) ( `open` ) ) ).
        client->follow_up_action( val   = client->cs_event-start_timer
                                  t_arg = VALUE #( ( `CLOSE_BUSY` ) ( `3000` ) ) ).

      WHEN `CLOSE_BUSY`.
        client->follow_up_action( val   = client->cs_event-control_by_id
                                  t_arg = VALUE #( ( `BusyDialog` ) ( `close` ) ) ).

    ENDCASE.

  ENDMETHOD.

ENDCLASS.