Samples / Learn / Message

Message

Turns what ABAP already has into a MessageBox - a SY message, a BAPIRET2 table or a caught exception.

Class
z2ui5_cl_smp_app_008
Repository
abap2UI5/samples
UI5 libraries
sap.m, sap.ui.core, sap.ui.layout
Lowest UI5 release
1.71
In the browser
Runs in the playground
Controls it builds
sap.m.Button, sap.m.MessageStrip, sap.m.Page, sap.m.Shell, sap.ui.core.mvc.View, sap.ui.layout.Grid, sap.ui.layout.form.SimpleForm
Documentation
cookbook/event_navigation/exception ↗, cookbook/translation_messages/message ↗

The class

" @keywords t100 message class number exception cx_root error abend message_box_display
" @summary Turns what ABAP already has into a MessageBox - a SY message, a BAPIRET2 table or a caught exception.
" @docs https://abap2ui5.github.io/docs/cookbook/event_navigation/exception https://abap2ui5.github.io/docs/cookbook/translation_messages/message
CLASS z2ui5_cl_smp_app_008 DEFINITION PUBLIC.

  PUBLIC SECTION.
    INTERFACES z2ui5_if_app.

  PROTECTED SECTION.
    DATA client TYPE REF TO z2ui5_if_client.

    METHODS on_event.
    METHODS view_display.

  PRIVATE SECTION.
ENDCLASS.


CLASS z2ui5_cl_smp_app_008 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 on_event.

    CASE client->get_event( ).
      WHEN `BUTTON_MESSAGE_BOX_SY`.
        " only the message key - message_box_display( ) reads the text from
        " T100 itself, exactly as it does for the BAPIRET2 structure below
        DATA(ls_msg_sy) = VALUE symsg( msgty = `I` msgid = `NET` msgno = `001` ).
        client->message_box_display( ls_msg_sy ).
      WHEN `BUTTON_MESSAGE_BOX_BAPIRET`.
        DATA(ls_msg_bapiret) = VALUE bapiret2( id = `NET` number = `001` ).
        client->message_box_display( ls_msg_bapiret ).
      WHEN `BUTTON_MESSAGE_BOX_CX_ROOT`.
        TRY.
            DATA(lv_val) = 1 / 0.
            client->message_box_display( |{ lv_val }| ).
          CATCH cx_root INTO DATA(x).
            client->message_box_display( x ).
        ENDTRY.
    ENDCASE.

  ENDMETHOD.


  METHOD view_display.

    DATA(view) = z2ui5_cl_ui5_view_builder=>factory(
        )->ele( n = `View` ns = `mvc`
            )->a( n = `displayBlock` v = `true`
            )->a( n = `height`       v = `100%`
            )->a( n = `xmlns`        v = `sap.m`
            )->a( n = `xmlns:mvc`    v = `sap.ui.core.mvc`
            )->a( n = `xmlns:form`   v = `sap.ui.layout.form`
            )->a( n = `xmlns:layout` v = `sap.ui.layout` ).
    DATA(page) = view->ele( `Shell`
        )->ele( `Page`
            )->a( n = `title`          v = `abap2UI5 - Message - MessageBox from SY, BAPIRET2 or Exception`
            )->a( n = `showNavButton`  b = client->check_app_prev_stack( )
            )->a( n = `navButtonPress` v = client->_event_nav_app_leave( ) ).

    page->tag( `MessageStrip`
        )->a( n = `text`     v = `The three buttons feed a MessageBox with the message objects ABAP ` &&
                   `produces: a SY message read from T100, a BAPIRET2 structure and a ` &&
                   `caught CX_ROOT exception. message_box_display( ) accepts each of them ` &&
                   `directly, no conversion in the app.`
        )->a( n = `type`     v = `Information`
        )->a( n = `showIcon` b = abap_true
        )->a( n = `class`    v = `sapUiSmallMargin` ).

    page->ele( n = `Grid` ns = `layout`
        )->a( n = `defaultSpan` v = `L6 M12 S12`
        )->ele( n = `content` ns = `layout`
            )->ele( n = `SimpleForm` ns = `form`
                )->a( n = `title` v = `Message Box from ABAP Object`
                )->ele( n = `content` ns = `form`
                    )->tag( `Button`
                        )->a( n = `press` v = client->_event( `BUTTON_MESSAGE_BOX_SY` )
                        )->a( n = `text`  v = `SY Message`
                    )->tag( `Button`
                        )->a( n = `press` v = client->_event( `BUTTON_MESSAGE_BOX_BAPIRET` )
                        )->a( n = `text`  v = `BAPIRET2`
                    )->tag( `Button`
                        )->a( n = `press` v = client->_event( `BUTTON_MESSAGE_BOX_CX_ROOT` )
                        )->a( n = `text`  v = `CX_ROOT` ).

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

  ENDMETHOD.

ENDCLASS.