Plugin for Responsive Table (sap.m.Table) - File Name validation configuration

" @keywords uploadsetwithtable upload setwith table sap.m.plugins uploadsetwithtableplugin.filenamevalidationsample dynamicpage vbox messagestrip text hbox checkbox
" @summary This example demonstrates the usage of fileNameValidationConfig property to configure file name validation for renaming a file.
" @origin sap.m.sample.UploadSetwithTablePlugin.FileNameValidationSample - https://sdk.openui5.org/entity/sap.m.plugins.UploadSetwithTable/sample/sap.m.sample.UploadSetwithTablePlugin.FileNameValidationSample (status: generated)
CLASS z2ui5_cl_smpc_app_652 DEFINITION PUBLIC.

  PUBLIC SECTION.
    INTERFACES z2ui5_if_app.

    TYPES:
      BEGIN OF ty_s_item,
        id             TYPE string,
        filename       TYPE string,
        mediatype      TYPE string,
        imageurl       TYPE string,
        url            TYPE string,
        revision       TYPE string,
        status         TYPE string,
        filesize       TYPE i,
        lastmodifiedby TYPE string,
        lastmodified   TYPE string,
        documenttype   TYPE string,
        previewable    TYPE abap_bool,
        trustedsource  TYPE abap_bool,
        uploadstate    TYPE string,
        icon           TYPE string,
        filesize_units TYPE string,
      END OF ty_s_item.
    DATA t_items TYPE STANDARD TABLE OF ty_s_item WITH EMPTY KEY.
    " onSelectionChange: Download for one or more rows, the rest for exactly one
    DATA download_enabled TYPE abap_bool.
    DATA single_enabled   TYPE abap_bool.
    " the AddViaUrl fragment, in its Add URL and Edit URL shapes
    DATA dialog_title     TYPE string.
    DATA apply_text       TYPE string.
    DATA url_required     TYPE abap_bool.
    DATA url_input        TYPE string.
    DATA url_state        TYPE string.
    DATA url_state_text   TYPE string.
    DATA name_input       TYPE string.
    DATA name_state       TYPE string.
    DATA name_state_text  TYPE string.
    " the file name validation panel - mode, characters and the Configure button
    DATA defaultcharacterset      TYPE string.
    DATA characters               TYPE string.
    DATA isconfigurebuttonenabled TYPE abap_bool.
    DATA cb_include               TYPE abap_bool.
    DATA cb_exclude               TYPE abap_bool.
    DATA cb_override              TYPE abap_bool.

  PROTECTED SECTION.
    DATA client TYPE REF TO z2ui5_if_client.
    " the binding paths of the selected rows and of the row a removal asks about
    DATA t_selected  TYPE string_table.
    DATA remove_path TYPE string.
    DATA is_edit     TYPE abap_bool.
    DATA upload_no   TYPE i.
    DATA mode        TYPE string.
    " the last config handed to setFileNameValidationConfig - re-issued after a
    " view rebuild, which brings back the view's literal config
    DATA config_live TYPE string.

    METHODS view_display.
    METHODS config_apply.
    METHODS popup_url_display.
    METHODS on_event.
    METHODS mode_select.
    METHODS configure.
    METHODS url_apply.
    METHODS remove_ask
      IMPORTING
        path TYPE string.
    METHODS selection_reset.
    METHODS name_valid
      RETURNING
        VALUE(result) TYPE abap_bool.
    METHODS url_valid
      RETURNING
        VALUE(result) TYPE abap_bool.
    METHODS row_add
      IMPORTING
        filename  TYPE string
        mediatype TYPE string
        url       TYPE string
        filesize  TYPE i.
    METHODS selected_index
      RETURNING
        VALUE(result) TYPE i.
    METHODS row_index
      IMPORTING
        path          TYPE string
      RETURNING
        VALUE(result) TYPE i.
    METHODS row_derive
      CHANGING
        row TYPE ty_s_item.
    METHODS icon_for
      IMPORTING
        mediatype     TYPE string
        filename      TYPE string
      RETURNING
        VALUE(result) TYPE string.
    METHODS size_with_units
      IMPORTING
        size          TYPE i
      RETURNING
        VALUE(result) TYPE string.
    METHODS model_init.

  PRIVATE SECTION.
ENDCLASS.


CLASS z2ui5_cl_smpc_app_652 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( ).

    view->ele( n = `View` ns = `mvc`
        )->a( n = `xmlns`         v = `sap.m`
        )->a( n = `xmlns:mvc`     v = `sap.ui.core.mvc`
        )->a( n = `xmlns:f`       v = `sap.f`
        )->a( n = `xmlns:core`    v = `sap.ui.core`
        )->a( n = `xmlns:upload`  v = `sap.m.upload`
        )->a( n = `xmlns:plugins` v = `sap.m.plugins`
        )->a( n = `height`        v = `100%`
        )->a( n = `displayBlock`  v = `true`

        )->ele( n = `DynamicPage` ns = `f`
            )->a( n = `id` v = `page`

            )->ele( n = `content` ns = `f`
                )->ele( `VBox`
                    )->tag( `MessageStrip`
                        )->a( n = `text`     v = `Select a file and click Rename to see how the file name is validated. ` &&
                                                 `Additionally, configure mode and chacracters to see how a file name is validated ` &&
                                                 `based on the mode and character configuration.`
                        )->a( n = `type`     v = `Information`
                        )->a( n = `showIcon` v = `true`

                    )->ele( `VBox`
                        )->a( n = `class` v = `sapUiMediumMarginTop sapUiMediumMarginBegin`

                        " the original's design="Bold" on the three Texts is dropped - sap.m.Text
                        " has no such property and the view fails to load with it
                        )->tag( `Text`
                            )->a( n = `text` v = |Note: Default restricted characters for file name ---> \{= ${ client->_bind( defaultcharacterset ) }\}|
                        )->tag( `Text`
                            )->a( n = `text`  v = `Mode:`
                            )->a( n = `class` v = `sapUiTinyMarginBottom sapUiSmallMarginTop`

                        )->ele( `HBox`
                            )->a( n = `alignItems`     v = `Center`
                            )->a( n = `justifyContent` v = `Start`
                            )->a( n = `class`          v = `sapUiTinyMarginTop`

                            )->tag( `CheckBox`
                                )->a( n = `text`     v = `include`
                                )->a( n = `select`   v = client->_event( val = `MODE_SELECT` arg = `$event.oSource.getId()` )
                                )->a( n = `id`       v = `cbInclude`
                                )->a( n = `selected` v = client->_bind( cb_include )
                            )->tag( `CheckBox`
                                )->a( n = `text`     v = `exclude`
                                )->a( n = `select`   v = client->_event( val = `MODE_SELECT` arg = `$event.oSource.getId()` )
                                )->a( n = `id`       v = `cbExclude`
                                )->a( n = `selected` v = client->_bind( cb_exclude )
                            )->tag( `CheckBox`
                                )->a( n = `text`     v = `override`
                                )->a( n = `select`   v = client->_event( val = `MODE_SELECT` arg = `$event.oSource.getId()` )
                                )->a( n = `id`       v = `cbOverride`
                                )->a( n = `selected` v = client->_bind( cb_override )

                        )->end(
                        )->tag( `Text`
                            )->a( n = `text`  v = `Characters:`
                            )->a( n = `class` v = `sapUiTinyMarginTop`
                        )->tag( `Input`
                            )->a( n = `id`          v = `charInput`
                            )->a( n = `class`       v = `sapUiSmallMarginTop`
                            )->a( n = `placeholder` v = `Enter characters...`
                            )->a( n = `value`       v = client->_bind( characters )
                            )->a( n = `liveChange`  v = client->_event( val    = `CHARACTERS_CHANGE`
                                                                       arg    = `${$parameters>/newValue}`
                                                                       s_ctrl = VALUE #( check_queue_last = abap_true
                                                                                         check_no_busy    = abap_true ) )
                            )->a( n = `width`       v = `50%`
                        )->tag( `Button`
                            )->a( n = `text`    v = `Configure`
                            )->a( n = `press`   v = client->_event( `CONFIGURE` )
                            )->a( n = `class`   v = `sapUiSmallMarginTop`
                            )->a( n = `enabled` v = client->_bind( isconfigurebuttonenabled )

                    )->end(

                    )->ele( `Table`
                        )->a( n = `id`              v = `table-uploadSet`
                        )->a( n = `sticky`          v = `ColumnHeaders,HeaderToolbar`
                        )->a( n = `width`           v = `auto`
                        )->a( n = `mode`            v = `MultiSelect`
                        )->a( n = `fixedLayout`     v = `false`
                        )->a( n = `inset`           v = `true`
                        )->a( n = `autoPopinMode`   v = `true`
                        )->a( n = `hiddenInPopin`   v = `None`
                        " IMAGEURL and UPLOADSTATE stay absent where the mock has
                        " none, so the view's undefined checks read as in the sample
                        )->a( n = `items`           v = |\{ path: '{ client->_bind( val                = t_items
                                                                                    path               = abap_true
                                                                                    omit_initial_paths = VALUE #( ( `IMAGEURL` )
                                                                                                                  ( `UPLOADSTATE` ) ) ) }', templateShareable: false \}|
                        )->a( n = `selectionChange` v = client->_event( val = `SELECTION`
                                                                        arg = `$event.oSource.getSelectedContexts().join()` )

                        )->ele( `headerToolbar`
                            )->ele( `OverflowToolbar`
                                )->tag( `Title`
                                    )->a( n = `text`  v = |Documents (\{= ${ client->_bind( t_items ) }.length\})|
                                    )->a( n = `level` v = `H2`
                                )->tag( `ToolbarSpacer`

                                )->ele( `SearchField`
                                    )->a( n = `width`      v = `20%`
                                    )->a( n = `liveChange` v = client->follow_up_action( val   = client->cs_event-binding_call
                                                                                         t_arg = VALUE #( ( `table-uploadSet` )
                                                                                                          ( `items` )
                                                                                                          ( `filter` )
                                                                                                          ( `FILENAME` )
                                                                                                          ( `Contains` )
                                                                                                          ( `${$source>/value}` ) ) )

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

                                    )->end(
                                )->end(
                                )->tag( `ToolbarSeparator`
                                )->tag( n = `ActionsPlaceholder` ns = `upload`
                                    )->a( n = `id`             v = `uploadButton`
                                    )->a( n = `placeholderFor` v = `UploadButtonPlaceholder`
                                )->tag( `Button`
                                    )->a( n = `id`      v = `downloadSelectedButton`
                                    )->a( n = `text`    v = `Download`
                                    )->a( n = `enabled` v = client->_bind( download_enabled )
                                    )->a( n = `press`   v = client->follow_up_action( val   = client->cs_event-control_by_id
                                                                                      t_arg = VALUE #( ( `uploadSetPlugin` )
                                                                                                       ( `download` )
                                                                                                       ( `$controller.getView().byId('table-uploadSet').getSelectedContexts()[0]` )
                                                                                                       ( `true` ) ) )

                                )->ele( `MenuButton`
                                    )->a( n = `text` v = `Add`

                                    )->ele( `menu`
                                        )->ele( `Menu`
                                            )->tag( `MenuItem`
                                                )->a( n = `text`  v = `URL`
                                                )->a( n = `press` v = client->_event( `ADD_URL` )

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

                                    )->end(
                                )->end(
                                )->ele( `Button`
                                    )->a( n = `id`      v = `removeDocumentButton`
                                    )->a( n = `text`    v = `Remove`
                                    )->a( n = `press`   v = client->_event( `REMOVE_SELECTED` )
                                    )->a( n = `enabled` v = client->_bind( single_enabled )

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

                                    )->end(
                                )->end(
                                )->ele( `Button`
                                    )->a( n = `id`      v = `renameButton`
                                    )->a( n = `enabled` v = client->_bind( single_enabled )
                                    )->a( n = `press`   v = client->follow_up_action( val   = client->cs_event-control_by_id
                                                                                      t_arg = VALUE #( ( `uploadSetPlugin` )
                                                                                                       ( `renameItem` )
                                                                                                       ( `$controller.getView().byId('table-uploadSet').getSelectedContexts()[0]` ) ) )
                                    )->a( n = `text`    v = `Rename`

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

                                    )->end(
                                )->end(
                                )->ele( `Button`
                                    )->a( n = `id`      v = `editUrlButton`
                                    )->a( n = `text`    v = `Edit URL`
                                    )->a( n = `enabled` v = client->_bind( single_enabled )
                                    )->a( n = `press`   v = client->_event( `EDIT_URL` )

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

                                    )->end(
                                )->end(
                            )->end(
                        )->end(
                        )->ele( `dependents`
                            )->ele( n = `UploadSetwithTable` ns = `plugins`
                                " the id is added - the port calls the plugin by id where the
                                " controller kept the instance onActivated handed it
                                )->a( n = `id`                       v = `uploadSetPlugin`
                                )->a( n = `uploadUrl`                v = `/uploadFiles`
                                )->a( n = `multiple`                 v = `true`
                                " the mock server's part: the upload is vetoed and the backend
                                " adds the row the fake 201 response would have created
                                )->a( n = `beforeUploadStarts`       v = client->_event( val    = `UPLOAD`
                                                                                         t_arg  = VALUE #( ( `${$parameters>/item}.getFileName()` )
                                                                                                           ( `${$parameters>/item}.getMediaType()` )
                                                                                                           ( `${$parameters>/item}.getFileObject().size` ) )
                                                                                         s_ctrl = VALUE #( check_prevent_default = abap_true
                                                                                                           check_queue_last      = abap_true ) )
                                )->a( n = `itemRenamed`              v = client->_event( val   = `RENAMED`
                                                                                         t_arg = VALUE #( ( `${$parameters>/item}.getBindingContext().getPath()` )
                                                                                                          ( `${$parameters>/item}.getFileName()` ) ) )
                                )->a( n = `cloudFilePickerEnabled`   v = `true`
                                )->a( n = `actions`                  v = `uploadButton`
                                )->a( n = `fileNameValidationConfig` v = `{mode: 'override', characters: '@$#'}`

                                )->ele( n = `rowConfiguration` ns = `plugins`
                                    " the paths name the model's upper-case ABAP fields
                                    )->tag( n = `UploadItemConfiguration` ns = `upload`
                                        )->a( n = `fileNamePath`        v = `FILENAME`
                                        )->a( n = `mediaTypePath`       v = `MEDIATYPE`
                                        )->a( n = `urlPath`             v = `URL`
                                        )->a( n = `previewablePath`     v = `PREVIEWABLE`
                                        )->a( n = `fileSizePath`        v = `FILESIZE`
                                        )->a( n = `isTrustedSourcePath` v = `TRUSTEDSOURCE`

                                )->end(
                            )->end(
                        )->end(
                        )->ele( `columns`
                            )->ele( `Column`
                                )->a( n = `id`         v = `fileName`
                                )->a( n = `importance` v = `High`

                                )->ele( `header`
                                    )->tag( `Label`
                                        )->a( n = `text` v = `File Name`

                                )->end(
                            )->end(
                            )->ele( `Column`
                                )->a( n = `id` v = `id`

                                )->ele( `header`
                                    )->tag( `Label`
                                        )->a( n = `text` v = `ID`

                                )->end(
                            )->end(
                            )->ele( `Column`
                                )->a( n = `id` v = `revision`

                                )->ele( `header`
                                    )->tag( `Label`
                                        )->a( n = `text` v = `Revision`

                                )->end(
                            )->end(
                            )->ele( `Column`
                                )->a( n = `id` v = `status`

                                )->ele( `header`
                                    )->tag( `Label`
                                        )->a( n = `text` v = `Status`

                                )->end(
                            )->end(
                            )->ele( `Column`
                                )->a( n = `id` v = `fileSize`

                                )->ele( `header`
                                    )->tag( `Label`
                                        )->a( n = `text` v = `File Size`

                                )->end(
                            )->end(
                            )->ele( `Column`
                                )->a( n = `id` v = `lastModified`

                                )->ele( `header`
                                    )->tag( `Label`
                                        )->a( n = `text` v = `Last Modified`

                                )->end(
                            )->end(
                            )->tag( `Column`
                                )->a( n = `id`         v = `actionButton`
                                )->a( n = `importance` v = `High`

                        )->end(
                        )->ele( `items`
                            )->ele( `ColumnListItem`
                                )->a( n = `highlight` v = `{= ${UPLOADSTATE} === 'Complete' ? 'Indication05' : null }`

                                )->ele( `cells`
                                    )->ele( `HBox`
                                        )->tag( `Image`
                                            )->a( n = `src`     v = `{IMAGEURL}`
                                            )->a( n = `class`   v = `sapMUSTItemImage sapMUSTItemIcon`
                                            )->a( n = `visible` v = `{= ${IMAGEURL} !== undefined}`
                                        " getIconSrc runs in ABAP: the row carries the finished icon
                                        )->tag( n = `Icon` ns = `core`
                                            )->a( n = `src`     v = `{ICON}`
                                            )->a( n = `visible` v = `{= ${IMAGEURL} === undefined || ${IMAGEURL} === '' }`
                                            )->a( n = `class`   v = `sapMUSTItemImage sapMUSTItemIcon`

                                        )->ele( `VBox`
                                            )->a( n = `class` v = `sapUiTinyMargin sapUiSmallMarginBegin`

                                            )->tag( `Link`
                                                )->a( n = `text`  v = `{FILENAME}`
                                                )->a( n = `press` v = client->follow_up_action( val   = client->cs_event-control_by_id
                                                                                                t_arg = VALUE #( ( `uploadSetPlugin` )
                                                                                                                 ( `openFilePreview` )
                                                                                                                 ( `$event.oSource.getBindingContext()` ) ) )
                                                )->a( n = `class` v = `sapUiTinyMarginBottom`
                                            )->tag( `Text`
                                                )->a( n = `text` v = `{DOCUMENTTYPE}`

                                        )->end(
                                    )->end(
                                    )->tag( `Text`
                                        )->a( n = `text` v = `{ID}`
                                    )->tag( `Link`
                                        )->a( n = `text` v = `{REVISION}`
                                    )->tag( `Text`
                                        )->a( n = `text` v = `{STATUS}`
                                    " getFileSizeWithUnits runs in ABAP as well
                                    )->tag( `Text`
                                        )->a( n = `text` v = `{FILESIZE_UNITS}`

                                    )->ele( `VBox`
                                        )->tag( `Text`
                                            )->a( n = `text` v = `{LASTMODIFIEDBY}`
                                        )->tag( `Text`
                                            )->a( n = `class` v = `sapUiTinyMarginTop`
                                            )->a( n = `text`  v = `{LASTMODIFIED}`

                                    )->end(
                                    )->tag( `Button`
                                        )->a( n = `class` v = `sapUiTinyMarginBegin`
                                        )->a( n = `type`  v = `Transparent`
                                        )->a( n = `icon`  v = `sap-icon://decline`
                                        )->a( n = `press` v = client->_event( val = `REMOVE_ROW`
                                                                              arg = `$event.oSource.getBindingContext().getPath()` ) ).

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

    IF config_live IS NOT INITIAL.
      config_apply( ).
    ENDIF.

  ENDMETHOD.


  METHOD config_apply.

    " setFileNameValidationConfig - an object argument travels as real JSON
    client->follow_up_action( val   = client->cs_event-control_by_id
                              t_arg = VALUE #( ( `uploadSetPlugin` ) ( `setFileNameValidationConfig` ) ( config_live ) ) ).

  ENDMETHOD.


  METHOD popup_url_display.

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

    popup->ele( n = `FragmentDefinition` ns = `core`
        )->a( n = `xmlns`             v = `sap.m`
        )->a( n = `xmlns:core`        v = `sap.ui.core`
        )->a( n = `xmlns:form`        v = `sap.ui.layout.form`
        )->a( n = `templateShareable` v = `false`
        )->a( n = `class`             v = `sapUiTinyMarginTop`

        )->ele( `Dialog`
            )->a( n = `id`            v = `addViaUrlDialog`
            )->a( n = `title`         v = client->_bind( dialog_title )
            )->a( n = `contentWidth`  v = `28rem`
            )->a( n = `contentHeight` v = `15rem`
            )->a( n = `class`         v = `sapUiSmallMargin`

            )->ele( `content`
                )->ele( n = `SimpleForm` ns = `form`
                    )->a( n = `editable` v = `true`
                    )->a( n = `id`       v = `addViaUrlSimpleform`

                    )->tag( `Label`
                        )->a( n = `id`       v = `urlInputLabel`
                        )->a( n = `text`     v = `URL`
                        )->a( n = `required` v = client->_bind( url_required )
                    )->tag( `Input`
                        )->a( n = `id`             v = `urlInput`
                        )->a( n = `value`          v = client->_bind( url_input )
                        )->a( n = `valueState`     v = client->_bind( url_state )
                        )->a( n = `valueStateText` v = client->_bind( url_state_text )
                    )->tag( `Label`
                        )->a( n = `id`       v = `nameInputLabel`
                        )->a( n = `text`     v = `Name`
                        )->a( n = `required` v = `true`
                    )->tag( `Input`
                        )->a( n = `id`             v = `nameInput`
                        )->a( n = `value`          v = client->_bind( name_input )
                        )->a( n = `valueState`     v = client->_bind( name_state )
                        )->a( n = `valueStateText` v = client->_bind( name_state_text )

                )->end(
            )->end(
            )->ele( `beginButton`
                )->tag( `Button`
                    )->a( n = `id`    v = `addDocumentBtn`
                    )->a( n = `text`  v = client->_bind( apply_text )
                    )->a( n = `type`  v = `Emphasized`
                    )->a( n = `press` v = client->_event( `URL_APPLY` )

            )->end(
            )->ele( `endButton`
                )->tag( `Button`
                    )->a( n = `text`  v = `Cancel`
                    )->a( n = `press` v = client->follow_up_action( client->cs_event-popup_close ) ).

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

  ENDMETHOD.


  METHOD on_event.

    CASE client->get_event( ).

      WHEN `SELECTION`.
        " onSelectionChange - the selected rows arrive as their binding paths
        IF client->get_event_arg( ) IS INITIAL.
          t_selected = VALUE #( ).
        ELSE.
          SPLIT client->get_event_arg( ) AT `,` INTO TABLE t_selected.
        ENDIF.
        download_enabled = xsdbool( t_selected IS NOT INITIAL ).
        single_enabled   = xsdbool( lines( t_selected ) = 1 ).

      WHEN `ADD_URL`.
        " openAddOrEditDialog in its Add shape
        is_edit         = abap_false.
        dialog_title    = `Add URL`.
        apply_text      = `Add`.
        url_required    = abap_true.
        url_input       = ``.
        name_input      = ``.
        url_state       = `None`.
        url_state_text  = ``.
        name_state      = `None`.
        name_state_text = ``.
        popup_url_display( ).

      WHEN `EDIT_URL`.
        " onEditUrl - the same fragment as Edit URL, filled from the selected row
        DATA(current) = selected_index( ).
        IF current = 0.
          RETURN.
        ENDIF.
        DATA(row) = t_items[ current ].
        is_edit         = abap_true.
        dialog_title    = `Edit URL`.
        apply_text      = `Apply`.
        url_required    = abap_false.
        url_input       = row-url.
        name_input      = row-filename.
        url_state       = `None`.
        url_state_text  = ``.
        name_state      = `None`.
        name_state_text = ``.
        popup_url_display( ).

      WHEN `URL_APPLY`.
        url_apply( ).

      WHEN `EDIT_CONFIRM`.
        IF client->get_event_arg( ) = `Save`.
          " the Save button validates (value states) and applies regardless
          name_valid( ).
          url_valid( ).
          DATA(target) = selected_index( ).
          IF target > 0.
            t_items[ target ]-filename = name_input.
            t_items[ target ]-url      = url_input.
          ENDIF.
          client->popup_destroy( ).
        ENDIF.

      WHEN `REMOVE_SELECTED`.
        IF t_selected IS NOT INITIAL.
          remove_ask( t_selected[ 1 ] ).
        ENDIF.

      WHEN `REMOVE_ROW`.
        remove_ask( client->get_event_arg( ) ).

      WHEN `REMOVE_CLOSE`.
        IF client->get_event_arg( ) = `Remove`.
          DATA(index) = row_index( remove_path ).
          IF index BETWEEN 1 AND lines( t_items ).
            DELETE t_items INDEX index.
          ENDIF.
          selection_reset( ).
        ENDIF.

      WHEN `UPLOAD`.
        " the file the FileUploader picked, as the mock server would answer it
        row_add( filename  = client->get_event_arg( )
                 mediatype = client->get_event_arg( 2 )
                 url       = ``
                 filesize  = CONV #( client->get_event_arg( 3 ) ) ).
        client->message_toast_display( `Document Added` ).

      WHEN `RENAMED`.
        " onDocumentRenamedSuccess writes the new name into the row
        DATA(renamed) = row_index( client->get_event_arg( ) ).
        IF renamed BETWEEN 1 AND lines( t_items ).
          t_items[ renamed ]-filename = client->get_event_arg( 2 ).
        ENDIF.
        client->message_toast_display( text = `Document Renamed.` duration = `2000` ).

      WHEN `MODE_SELECT`.
        mode_select( ).

      WHEN `CHARACTERS_CHANGE`.
        " onInputChange reads newValue - the model only follows on change
        characters               = client->get_event_arg( ).
        isconfigurebuttonenabled = xsdbool( characters IS NOT INITIAL AND mode IS NOT INITIAL ).

      WHEN `CONFIGURE`.
        configure( ).

    ENDCASE.

  ENDMETHOD.


  METHOD mode_select.

    " onCheckboxSelect - the three boxes behave as one choice
    DATA(box) = client->get_event_arg( ).
    cb_include  = xsdbool( box CS `cbInclude` ).
    cb_exclude  = xsdbool( box CS `cbExclude` ).
    cb_override = xsdbool( cb_include = abap_false AND cb_exclude = abap_false ).
    IF cb_include = abap_true.
      mode = `include`.
    ELSEIF cb_exclude = abap_true.
      mode = `exclude`.
    ELSE.
      mode = `override`.
    ENDIF.
    isconfigurebuttonenabled = xsdbool( characters IS NOT INITIAL AND mode IS NOT INITIAL ).

  ENDMETHOD.


  METHOD configure.

    " onConfigureHandler - setFileNameValidationConfig with the config object
    IF cb_include = abap_true.
      mode = `include`.
    ELSEIF cb_exclude = abap_true.
      mode = `exclude`.
    ELSEIF cb_override = abap_true.
      mode = `override`.
    ELSE.
      mode = ``.
    ENDIF.
    DATA(json_chars) = replace( val  = replace( val = characters sub = `\` with = `\\` occ = 0 )
                                sub  = `"`
                                with = `\"`
                                occ  = 0 ).
    config_live = |\{"mode":"{ mode }","characters":"{ json_chars }"\}|.
    config_apply( ).
    client->message_toast_display(
        |Configuration mode: { mode }, Characters: { characters }, have been applied to the fileNameValidationConfig.| ).

  ENDMETHOD.


  METHOD url_apply.

    " handleAddViaUrl
    IF is_edit = abap_true.
      IF name_valid( ) = abap_true.
        " showEditConfirmation - a Message dialog in the Warning state
        client->message_box_display( text             = `You have made changes to this object. What would you like to do?`
                                     type             = `warning`
                                     title            = `Warning`
                                     actions          = VALUE #( ( `Save` ) ( `DiscardChanges` ) )
                                     emphasizedaction = `Save`
                                     onclose          = `EDIT_CONFIRM` ).
      ELSE.
        client->message_toast_display( `No Changes found` ).
      ENDIF.
      RETURN.
    ENDIF.
    DATA(has_error) = xsdbool( name_valid( ) = abap_false ).
    IF url_valid( ) = abap_false.
      has_error = abap_true.
    ENDIF.
    IF has_error = abap_false.
      " uploadItemViaUrl - the mock server answers with the typed URL as the
      " document URL and an empty file
      row_add( filename  = name_input
               mediatype = ``
               url       = url_input
               filesize  = 0 ).
      client->popup_destroy( ).
      client->message_toast_display( `Document Added` ).
    ENDIF.

  ENDMETHOD.


  METHOD remove_ask.

    " removeItem - MessageBox.warning; the icon is the warning box's own
    DATA(index) = row_index( path ).
    IF index NOT BETWEEN 1 AND lines( t_items ).
      RETURN.
    ENDIF.
    remove_path = path.
    client->message_box_display( text             = |Are you sure you want to remove the document { t_items[ index ]-filename } ?|
                                 type             = `warning`
                                 actions          = VALUE #( ( `Remove` ) ( `CANCEL` ) )
                                 emphasizedaction = `Remove`
                                 styleclass       = `sapMUSTRemovePopoverContainer`
                                 initialfocus     = `CANCEL`
                                 onclose          = `REMOVE_CLOSE` ).

  ENDMETHOD.


  METHOD selection_reset.

    " oTable.removeSelections( ) - and the buttons follow the empty selection
    client->follow_up_action( val   = client->cs_event-control_by_id
                              t_arg = VALUE #( ( `table-uploadSet` ) ( `removeSelections` ) ) ).
    t_selected       = VALUE #( ).
    download_enabled = abap_false.
    single_enabled   = abap_false.

  ENDMETHOD.


  METHOD name_valid.

    " _isValidName
    IF name_input IS INITIAL.
      name_state      = `Error`.
      name_state_text = `Text is either empty or contains special characters`.
    ELSE.
      name_state = `None`.
      result     = abap_true.
    ENDIF.

  ENDMETHOD.


  METHOD url_valid.

    " _validateAddOrEditUrlDialog's URL half - the sample's regex is unanchored,
    " so a scheme followed by one non-blank character is what it requires
    FIND REGEX `(ftp|http|https)://\S` IN url_input.
    IF sy-subrc <> 0.
      url_state      = `Error`.
      url_state_text = `Enter Valid URL`.
    ELSE.
      url_state = `None`.
      result    = abap_true.
    ENDIF.

  ENDMETHOD.


  METHOD row_add.

    " the mock server's Create branch - unshift the new document
    upload_no = upload_no + 1.
    DATA(row) = VALUE ty_s_item( id             = |{ upload_no }|
                                 filename       = filename
                                 mediatype      = mediatype
                                 url            = url
                                 uploadstate    = `Complete`
                                 revision       = `00`
                                 status         = `In work`
                                 filesize       = filesize
                                 lastmodifiedby = `Jane Burns`
                                 lastmodified   = `10/03/21, 10:03:00 PM`
                                 documenttype   = `Invoice`
                                 trustedsource  = abap_true ).
    row_derive( CHANGING row = row ).
    INSERT row INTO t_items INDEX 1.

  ENDMETHOD.


  METHOD selected_index.

    " the one selected row the toolbar actions work on - 0 when there is none
    IF t_selected IS INITIAL.
      RETURN.
    ENDIF.
    result = row_index( t_selected[ 1 ] ).
    IF result > lines( t_items ).
      result = 0.
    ENDIF.

  ENDMETHOD.


  METHOD row_index.

    " a row's binding path ends in its 0-based index: /T_ITEMS/3 is the 4th row
    DATA(slash) = find( val = path sub = `/` occ = -1 ).
    IF slash < 0.
      RETURN.
    ENDIF.
    DATA(digits) = substring( val = path off = slash + 1 ).
    IF digits IS INITIAL OR digits CN `0123456789`.
      RETURN.
    ENDIF.
    result = CONV i( digits ) + 1.

  ENDMETHOD.


  METHOD row_derive.

    row-icon           = icon_for( mediatype = row-mediatype filename = row-filename ).
    row-filesize_units = size_with_units( row-filesize ).

  ENDMETHOD.


  METHOD icon_for.

    " UploadSetwithTable.getIconForFileType: IconPool's media type table, or the
    " file extension when there is no media type
    IF mediatype IS NOT INITIAL.
      DATA(type) = to_lower( mediatype ).
      CASE type.
        WHEN `application/msword` OR `application/vnd.google-apps.document` OR `application/rtf`
            OR `application/vnd.openxmlformats-officedocument.wordprocessingml.document`.
          result = `sap-icon://doc-attachment`.
        WHEN `application/pdf`.
          result = `sap-icon://pdf-attachment`.
        WHEN `application/msexcel` OR `application/vnd.ms-excel` OR `application/vnd.google-apps.spreadsheet`
            OR `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`
            OR `application/vnd.ms-excel.sheet.macroenabled.12`
            OR `application/vnd.openxmlformats-officedocument.spreadsheetml.template`
            OR `application/vnd.ms-excel.template.macroenabled.12`
            OR `application/vnd.ms-excel.sheet.binary.macroenabled.12`
            OR `application/vnd.ms-excel.addin.macroenabled.12`.
          result = `sap-icon://excel-attachment`.
        WHEN `application/vnd.ms-powerpoint` OR `application/vnd.google-apps.presentation` OR `application/mspowerpoint`
            OR `application/vnd.openxmlformats-officedocument.presentationml.presentation`
            OR `application/vnd.openxmlformats-officedocument.presentationml.slideshow`.
          result = `sap-icon://ppt-attachment`.
        WHEN `application/xml` OR `application/xhtml+xml` OR `application/x-httpd-php` OR `application/x-javascript`
            OR `text/html`.
          result = `sap-icon://attachment-html`.
        WHEN `application/gzip` OR `application/x-rar-compressed` OR `application/x-tar` OR `application/zip`.
          result = `sap-icon://attachment-zip-file`.
        WHEN `audio/mpeg` OR `audio/voxware` OR `audio/x-aiff` OR `audio/x-midi` OR `audio/x-mpeg` OR `audio/x-m4a`
            OR `audio/x-pn-realaudio` OR `audio/x-pn-realaudio-plugin` OR `audio/x-qt-stream` OR `audio/x-wav`.
          result = `sap-icon://attachment-audio`.
        WHEN `image/png` OR `image/tiff` OR `image/bmp` OR `image/jpeg` OR `image/gif`.
          result = `sap-icon://attachment-photo`.
        WHEN `text/plain` OR `text/comma-separated-values` OR `text/css` OR `text/javascript` OR `text/richtext`