abap2UI5

MultiComboBox - Clear Icon

The multi combo box control can show 'clear' icon, which when pressed will remove the user's input.

Z2UI5_CL_SMPC_APP_491

Controls sap.m UI5 1.96

The facts

Repository
abap2UI5/samples-controls
Class
Z2UI5_CL_SMPC_APP_491
Source file
z2ui5_cl_smpc_app_491.clas.abap
Library
sap.m
UI5 entity
sap.m.MultiComboBox
Demo kit sample
sap.m.sample.MultiComboBoxClearIcon
SAP's own sample
running at sdk.openui5.org ↗
Minimum UI5
1.96
In the playground
runs in the browser, with no system and nothing installed

Keywords: multicombobox, multi, combo, box, sap.m, multicomboboxclearicon, verticallayout, item

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_491.clas.abap — 239 lines Read it on GitHub ↗
" @keywords multicombobox multi combo box sap.m multicomboboxclearicon verticallayout item
" @summary The multi combo box control can show 'clear' icon, which when pressed will remove the user's input.
CLASS z2ui5_cl_smpc_app_491 DEFINITION PUBLIC.

  PUBLIC SECTION.
    INTERFACES z2ui5_if_app.

    TYPES: BEGIN OF ty_s_product,
             productid TYPE string,
             name      TYPE string,
           END OF ty_s_product.
    TYPES ty_t_product TYPE STANDARD TABLE OF ty_s_product WITH EMPTY KEY.

    DATA t_products     TYPE ty_t_product.
    DATA t_selected_key TYPE string_table.

  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_491 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 = `height`     v = `100%`
        )->a( n = `xmlns:l`    v = `sap.ui.layout`
        )->a( n = `xmlns:core` v = `sap.ui.core`
        )->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%`

            )->ele( `MultiComboBox`
                " handleSelectionChange toasts the changed item and its new state -
                " composed on the client from the two event parameters
                )->a( n = `selectionChange` v = client->follow_up_action( val   = client->cs_event-control_global
                                                                          t_arg = VALUE #( ( `MESSAGE_TOAST` ) ( `show` )
                                                                                           ( `Event 'selectionChange': {0?Selected:Deselected} '{1}'` )
                                                                                           ( `${$parameters>/selected}` )
                                                                                           ( `${$parameters>/changedItem}.getText()` ) ) )
                " handleSelectionFinish lists every selected item; a UI5 expression has
                " no loop, so the selection travels as the bound selectedKeys and ABAP
                " builds the same line
                )->a( n = `selectionFinish` v = client->_event( `SELECTION_FINISH` )
                )->a( n = `selectedKeys`    v = client->_bind( t_selected_key )
                )->a( n = `showClearIcon`   v = `true`
                )->a( n = `width`           v = `350px`
                )->a( n = `items`           v = |\{ path: '{ client->_bind_path( t_products ) }', sorter: \{ path: 'NAME' \} \}|

                )->tag( n = `Item` ns = `core`
                    )->a( n = `key`  v = `{PRODUCTID}`
                    )->a( n = `text` v = `{NAME}` ).

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

  ENDMETHOD.


  METHOD on_event.

    IF client->get_event( ) = `SELECTION_FINISH`.

      " "Event 'selectionFinished': ['A','B']" - the texts of the selected keys in
      " SELECTION order: the original reads the selectedItems event parameter, which
      " MultiComboBox fills by addAssociation per pick, so looping the bound keys
      " (not the product table) is what reproduces it - the app-281 form
      DATA(list) = ``.
      LOOP AT t_selected_key INTO DATA(key).
        IF list IS NOT INITIAL.
          list = list && `,`.
        ENDIF.
        list = list && |'{ VALUE #( t_products[ productid = key ]-name OPTIONAL ) }'|.
      ENDLOOP.

      client->message_toast_display( text = |Event 'selectionFinished': [{ list }]| width = `auto` ).

    ENDIF.

  ENDMETHOD.


  METHOD model_init.

    " full mock /ProductCollection of ui5/mock/products.json (the bound fields)
    t_products = VALUE #(
        ( productid = `HT-1000` name = `Notebook Basic 15` )
        ( productid = `HT-1001` name = `Notebook Basic 17` )
        ( productid = `HT-1002` name = `Notebook Basic 18` )
        ( productid = `HT-1003` name = `Notebook Basic 19` )
        ( productid = `HT-1007` name = `ITelO Vault` )
        ( productid = `HT-1010` name = `Notebook Professional 15` )
        ( productid = `HT-1011` name = `Notebook Professional 17` )
        ( productid = `HT-1020` name = `ITelO Vault Net` )
        ( productid = `HT-1021` name = `ITelO Vault SAT` )
        ( productid = `HT-1022` name = `Comfort Easy` )
        ( productid = `HT-1023` name = `Comfort Senior` )
        ( productid = `HT-1030` name = `Ergo Screen E-I` )
        ( productid = `HT-1031` name = `Ergo Screen E-II` )
        ( productid = `HT-1032` name = `Ergo Screen E-III` )
        ( productid = `HT-1035` name = `Flat Basic` )
        ( productid = `HT-1036` name = `Flat Future` )
        ( productid = `HT-1037` name = `Flat XL` )
        ( productid = `HT-1040` name = `Laser Professional Eco` )
        ( productid = `HT-1041` name = `Laser Basic` )
        ( productid = `HT-1042` name = `Laser Allround` )
        ( productid = `HT-1050` name = `Ultra Jet Super Color` )
        ( productid = `HT-1051` name = `Ultra Jet Mobile` )
        ( productid = `HT-1052` name = `Ultra Jet Super Highspeed` )
        ( productid = `HT-1055` name = `Multi Print` )
        ( productid = `HT-1056` name = `Multi Color` )
        ( productid = `HT-1060` name = `Cordless Mouse` )
        ( productid = `HT-1061` name = `Speed Mouse` )
        ( productid = `HT-1062` name = `Track Mouse` )
        ( productid = `HT-1063` name = `Ergonomic Keyboard` )
        ( productid = `HT-1064` name = `Internet Keyboard` )
        ( productid = `HT-1065` name = `Media Keyboard` )
        ( productid = `HT-1066` name = `Mousepad` )
        ( productid = `HT-1067` name = `Ergo Mousepad` )
        ( productid = `HT-1068` name = `Designer Mousepad` )
        ( productid = `HT-1069` name = `Universal card reader` )
        ( productid = `HT-1070` name = `Proctra X` )
        ( productid = `HT-1071` name = `Gladiator MX` )
        ( productid = `HT-1072` name = `Hurricane GX` )
        ( productid = `HT-1073` name = `Hurricane GX/LN` )
        ( productid = `HT-1080` name = `Photo Scan` )
        ( productid = `HT-1081` name = `Power Scan` )
        ( productid = `HT-1082` name = `Jet Scan Professional` )
        ( productid = `HT-1083` name = `Jet Scan Professional` )
        ( productid = `HT-1085` name = `Copymaster` )
        ( productid = `HT-1090` name = `Surround Sound` )
        ( productid = `HT-1091` name = `Blaster Extreme` )
        ( productid = `HT-1092` name = `Sound Booster` )
        ( productid = `HT-1095` name = `Lovely Sound 5.1 Wireless` )
        ( productid = `HT-1096` name = `Lovely Sound 5.1` )
        ( productid = `HT-1097` name = `Lovely Sound Stereo` )
        ( productid = `HT-1100` name = `Smart Office` )
        ( productid = `HT-1101` name = `Smart Design` )
        ( productid = `HT-1102` name = `Smart Network` )
        ( productid = `HT-1103` name = `Smart Multimedia` )
        ( productid = `HT-1104` name = `Smart Games` )
        ( productid = `HT-1105` name = `Smart Internet Antivirus` )
        ( productid = `HT-1106` name = `Smart Firewall` )
        ( productid = `HT-1107` name = `Smart Money` )
        ( productid = `HT-1110` name = `PC Lock` )
        ( productid = `HT-1111` name = `Notebook Lock` )
        ( productid = `HT-1112` name = `Web cam reality` )
        ( productid = `HT-1113` name = `Screen clean` )
        ( productid = `HT-1114` name = `Fabric bag professional` )
        ( productid = `HT-1115` name = `Wireless DSL Router` )
        ( productid = `HT-1116` name = `Wireless DSL Router / Repeater` )
        ( productid = `HT-1117` name = `Wireless DSL Router / Repeater and Print Server` )
        ( productid = `HT-1118` name = `USB Stick` )
        ( productid = `HT-1119` name = `Travel Adapter` )
        ( productid = `HT-1120` name = `Cordless Bluetooth Keyboard, english international` )
        ( productid = `HT-1137` name = `Flat XXL` )
        ( productid = `HT-1138` name = `Pocket Mouse` )
        ( productid = `HT-1210` name = `PC Power Station` )
        ( productid = `HT-1251` name = `Astro Laptop 1516` )
        ( productid = `HT-1252` name = `Astro Phone 6` )
        ( productid = `HT-1253` name = `Benda Laptop 1408` )
        ( productid = `HT-1254` name = `Bending Screen 21HD` )
        ( productid = `HT-1255` name = `Broad Screen 22HD` )
        ( productid = `HT-1256` name = `Cerdik Phone 7` )
        ( productid = `HT-1257` name = `Cepat Tablet 10.5` )
        ( productid = `HT-1258` name = `Cepat Tablet 8` )
        ( productid = `HT-1500` name = `Server Basic` )
        ( productid = `HT-1501` name = `Server Professional` )
        ( productid = `HT-1502` name = `Server Power Pro` )
        ( productid = `HT-1600` name = `Family PC Basic` )
        ( productid = `HT-1601` name = `Family PC Pro` )
        ( productid = `HT-1602` name = `Gaming Monster` )
        ( productid = `HT-1603` name = `Gaming Monster Pro` )
        ( productid = `HT-2000` name = `7" Widescreen Portable DVD Player w MP3` )
        ( productid = `HT-2001` name = `10" Portable DVD player` )
        ( productid = `HT-2002` name = `Portable DVD Player with 9" LCD Monitor` )
        ( productid = `HT-2025` name = `CD/DVD case: 264 sleeves` )
        ( productid = `HT-2026` name = `Audio/Video Cable Kit - 4m` )
        ( productid = `HT-2027` name = `Removable CD/DVD Laser Labels` )
        ( productid = `HT-6100` name = `Beam Breaker B-1` )
        ( productid = `HT-6101` name = `Beam Breaker B-2` )
        ( productid = `HT-6102` name = `Beam Breaker B-3` )
        ( productid = `HT-6110` name = `Play Movie` )
        ( productid = `HT-6111` name = `Record Movie` )
        ( productid = `HT-6120` name = `ITelo MusicStick` )
        ( productid = `HT-6121` name = `ITelo Jog-Mate` )
        ( productid = `HT-6122` name = `Power Pro Player 40` )
        ( productid = `HT-6123` name = `Power Pro Player 80` )
        ( productid = `HT-6130` name = `Flat Watch HD32` )
        ( productid = `HT-6131` name = `Flat Watch HD37` )
        ( productid = `HT-6132` name = `Flat Watch HD41` )
        ( productid = `HT-7000` name = `Copperberry` )
        ( productid = `HT-7010` name = `Silverberry` )
        ( productid = `HT-7020` name = `Goldberry` )
        ( productid = `HT-7030` name = `Platinberry` )
        ( productid = `HT-8000` name = `ITelO FlexTop I4000` )
        ( productid = `HT-8001` name = `ITelO FlexTop I6300c` )
        ( productid = `HT-8002` name = `ITelO FlexTop I9100` )
        ( productid = `HT-8003` name = `ITelO FlexTop I9800` )
        ( productid = `HT-9991` name = `Smartphone Leather Case` )
        ( productid = `HT-9992` name = `Smartphone Alpha` )
        ( productid = `HT-9993` name = `Mini Tablet` )
        ( productid = `HT-9994` name = `Camcorder View` )
        ( productid = `HT-9995` name = `Tablet Pouch` )
        ( productid = `HT-9996` name = `Tablet Pouch` )
        ( productid = `HT-9997` name = `e-Book Reader ReadMe` )
        ( productid = `HT-9998` name = `Smartphone Beta` )
        ( productid = `HT-9999` name = `Maxi Tablet` )
        ( productid = `PF-1000` name = `Flyer` ) ).

  ENDMETHOD.

ENDCLASS.

More in sap.m

Search every abap2UI5 sample · the full list on one page

On this page