Cookie Settings Dialog Pattern

The class

" @keywords cookiesettingsdialogpattern cookie settings dialog pattern sap.m verticallayout button vbox text gridlist gridbasiclayout
" @summary The Cookie Settings Dialog allows you to easily manage the cookie settings according to the needs of the specific product.
" @origin sap.m.sample.CookieSettingsDialogPattern - https://sdk.openui5.org/entity/sap.m.CookieSettingsDialogPattern/sample/sap.m.sample.CookieSettingsDialogPattern (status: checked - verified in a running system)
CLASS z2ui5_cl_smpc_app_013 DEFINITION PUBLIC.

  PUBLIC SECTION.
    INTERFACES z2ui5_if_app.

    DATA showcookiedetails TYPE abap_bool.

  PROTECTED SECTION.
    DATA client TYPE REF TO z2ui5_if_client.

    METHODS view_display.
    METHODS on_event.
    METHODS dialog_display.

  PRIVATE SECTION.
ENDCLASS.


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

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

            )->tag( `Button`
                )->a( n = `text`  v = `Open Cookie Settings Dialog`
                )->a( n = `press` v = client->_event( `OPEN_COOKIE_SETTINGS_DIALOG` )
                )->a( n = `class` v = `sapUiSmallMarginBottom` ).

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

  ENDMETHOD.


  METHOD on_event.

    CASE client->get_event( ).

      WHEN `OPEN_COOKIE_SETTINGS_DIALOG`.
        " the original forces cookie details to be hidden on opening of the dialog
        showcookiedetails = abap_false.
        dialog_display( ).

      WHEN `SHOW_COOKIE_DETAILS`.
        showcookiedetails = abap_true.
        " the original moves the focus to the Save Preferences action through
        " its _focusButton helper: focus now if the button is rendered, else
        " once it is. SET_FOCUS is that helper - it waits for the render,
        " where a control_by_id focus is a bare control.focus( ) that returns
        " at once on the still-invisible button. SET_FOCUS resolves the id
        " across every open slot, so it needs no view
        client->follow_up_action( val   = client->cs_event-set_focus
                                  t_arg = VALUE #( ( `actionSavePreferences` ) ) ).

      WHEN `ACCEPT_ALL_COOKIES`.
        " insert your accept all logic here
        client->popup_destroy( ).

      WHEN `REJECT_ALL_COOKIES`.
        " insert your reject all logic here
        client->popup_destroy( ).

      WHEN `SAVE_COOKIES`.
        " insert your save cookies logic here according to the user input
        client->popup_destroy( ).

      WHEN `CANCEL_PRESS`.
        IF showcookiedetails = abap_false.
          " the cancel action ignores all changes and closes the dialog
          client->popup_destroy( ).
        ELSE.
          " the cancel action navigates back to the preview
          showcookiedetails = abap_false.
          client->follow_up_action( val   = client->cs_event-set_focus
                                    t_arg = VALUE #( ( `actionSetPreferences` ) ) ).
        ENDIF.

    ENDCASE.

  ENDMETHOD.


  METHOD dialog_display.

    DATA(popup) = z2ui5_cl_ui5_view_builder=>factory( ).

    popup->ele( n = `FragmentDefinition` ns = `core`
        )->a( n = `xmlns`      v = `sap.m`
        )->a( n = `xmlns:f`    v = `sap.f`
        )->a( n = `xmlns:grid` v = `sap.ui.layout.cssgrid`
        )->a( n = `xmlns:core` v = `sap.ui.core`

        )->ele( `Dialog`
            )->a( n = `title`        v = `Cookie Settings (Sample)`
            )->a( n = `contentWidth` v = `45rem`

            )->ele( `content`
                " the original's custom:DivContainer (demo-kit-internal sap.ui.documentation control) rebuilt as a VBox
                )->ele( `VBox`
                    )->a( n = `class` v = `sapUiSmallMargin`

                    )->tag( `Text`
                        )->a( n = `text`    v = `We use cookies and SAP Web Analytics to improve your experience on our site. By continuing to use this site, you consent to use our cookies.`
                        )->a( n = `visible` v = |\{= !${ client->_bind( showcookiedetails ) } \}|
                    )->tag( `Text`
                        )->a( n = `text`    v = `We use cookies to improve your experience on our site. By continuing to use this site, you consent to use our cookies.`
                        )->a( n = `visible` v = |\{= !${ client->_bind( showcookiedetails ) } \}|

                    )->ele( n = `GridList` ns = `f`
                        )->a( n = `visible` v = client->_bind( showcookiedetails )

                        )->ele( n = `customLayout` ns = `f`
                            )->tag( n = `GridBasicLayout` ns = `grid`
                                )->a( n = `gridTemplateColumns` v = `1fr`
                                )->a( n = `gridGap`             v = `1rem`

                        )->end(
                        )->ele( n = `GridListItem` ns = `f`
                            )->ele( `HBox`
                                )->a( n = `justifyContent` v = `SpaceBetween`
                                )->a( n = `class`          v = `sapUiSmallMarginBeginEnd sapUiSmallMarginTop`

                                )->ele( `VBox`
                                    )->tag( `Title`
                                        )->a( n = `text` v = `Required Cookies`
                                    )->tag( `Text`
                                        )->a( n = `text` v = `These cookies are required to enable core site functionality.`

                                )->end(
                                )->tag( `Switch`
                                    )->a( n = `class` v = `sapUiSmallMarginBegin`

                            )->end(
                            )->ele( `Panel`
                                )->a( n = `headerText` v = `More Info`
                                )->a( n = `expandable` v = `true`
                                )->a( n = `class`      v = `sapUiTinyMarginTop`

                                )->tag( `Text`
                                    )->a( n = `text` v = `We use cookies to improve your experience on our site. By continuing to use this site, you consent to use our cookies.`

                            )->end(
                        )->end(
                        )->ele( n = `GridListItem` ns = `f`
                            )->ele( `HBox`
                                )->a( n = `justifyContent` v = `SpaceBetween`
                                )->a( n = `class`          v = `sapUiSmallMarginBeginEnd sapUiSmallMarginTop`

                                )->ele( `VBox`
                                    )->tag( `Title`
                                        )->a( n = `text` v = `Functional Cookies`
                                    )->tag( `Text`
                                        )->a( n = `text` v = `These cookies are used to analyse site usage for the purpose of measuring and improving site performance.`

                                )->end(
                                )->tag( `Switch`
                                    )->a( n = `class` v = `sapUiSmallMarginBegin`

                            )->end(
                            )->ele( `Panel`
                                )->a( n = `headerText` v = `More Info`
                                )->a( n = `expandable` v = `true`
                                )->a( n = `class`      v = `sapUiTinyMarginTop`

                                )->tag( `Text`
                                    )->a( n = `text`
                                             v = `This site uses SAP Web Analytics to analyze how users use this site. The information generated (including a part of your IP address and a browser ID) ` &&
                                                 `will be transmitted to and stored by SAP on its servers. Cookies are used to identify your repeat visit and your visit origin page. ` &&
                                                 `We will use this information only for the purpose of evaluating website usage and compiling reports on website activity for website operators - and finally, to improve the site. ` &&
                                                 `If you would like to opt-in for SAP Web Analytics tracking, please specify your preference using the "On"/"Off" switch above. ` &&
                                                 `By opt-in, you consent to the processing of analytics data about you in the manner and for the purposes set out above.`

                            )->end(
                        )->end(
                    )->end(
                )->end(
            )->end(
            )->ele( `buttons`
                )->ele( `Button`
                    )->a( n = `text`    v = `Accept All`
                    )->a( n = `type`    v = `Emphasized`
                    )->a( n = `press`   v = client->_event( `ACCEPT_ALL_COOKIES` )
                    )->a( n = `visible` v = |\{=! ${ client->_bind( showcookiedetails ) } \}|

                    )->ele( `layoutData`
                        )->tag( `OverflowToolbarLayoutData`
                            )->a( n = `priority` v = `NeverOverflow`

                    )->end(
                )->end(
                )->tag( `Button`
                    )->a( n = `text`    v = `Set Preferences`
                    )->a( n = `id`      v = `actionSetPreferences`
                    )->a( n = `type`    v = `Ghost`
                    )->a( n = `press`   v = client->_event( `SHOW_COOKIE_DETAILS` )
                    )->a( n = `visible` v = |\{= !${ client->_bind( showcookiedetails ) } \}|

                )->ele( `Button`
                    )->a( n = `text`    v = `Reject All`
                    )->a( n = `press`   v = client->_event( `REJECT_ALL_COOKIES` )
                    )->a( n = `visible` v = |\{=! ${ client->_bind( showcookiedetails ) } \}|

                    )->ele( `layoutData`
                        )->tag( `OverflowToolbarLayoutData`
                            )->a( n = `priority` v = `NeverOverflow`

                    )->end(
                )->end(
                )->tag( `Button`
                    )->a( n = `text`    v = `Save Preferences`
                    )->a( n = `id`      v = `actionSavePreferences`
                    )->a( n = `type`    v = `Emphasized`
                    )->a( n = `press`   v = client->_event( `SAVE_COOKIES` )
                    )->a( n = `visible` v = client->_bind( showcookiedetails )
                )->tag( `Button`
                    )->a( n = `text`    v = `Cancel`
                    )->a( n = `press`   v = client->_event( `CANCEL_PRESS` )
                    )->a( n = `visible` v = client->_bind( showcookiedetails ) ).

    client->popup_display( popup->stringify( ) ).

    " the original's afterOpen handler moves the focus to the Set Preferences action
    client->follow_up_action( val   = client->cs_event-set_focus
                              t_arg = VALUE #( ( `actionSetPreferences` ) ) ).

  ENDMETHOD.

ENDCLASS.