Samples / Controls / sap.m

View Settings Dialog - Custom Search

You can filter the items in the filter details page using different string filter operators.

Class
z2ui5_cl_smpc_app_296
Repository
abap2UI5/samples-controls
Ports
sap.m.sample.ViewSettingsDialogCustomFilterDetails
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.ViewSettingsDialog, sap.m.ViewSettingsFilterItem, sap.m.ViewSettingsItem, sap.ui.core.mvc.View, sap.ui.layout.VerticalLayout

The class

" @keywords viewsettingsdialog settings dialog sap.m viewsettingsdialogcustomfilterdetails viewsettingsfilteritem viewsettingsitem verticallayout button
" @summary You can filter the items in the filter details page using different string filter operators.
" @origin sap.m.sample.ViewSettingsDialogCustomFilterDetails - https://sdk.openui5.org/entity/sap.m.ViewSettingsDialog/sample/sap.m.sample.ViewSettingsDialogCustomFilterDetails (status: reviewed - read against the original, not run)
CLASS z2ui5_cl_smpc_app_296 DEFINITION PUBLIC.

  PUBLIC SECTION.
    INTERFACES z2ui5_if_app.

    DATA search_operator TYPE string.

  PROTECTED SECTION.
    DATA client TYPE REF TO z2ui5_if_client.

    METHODS view_display.
    METHODS on_event.
    METHODS dialog_open
      IMPORTING
        operator TYPE string.
    METHODS model_init.

  PRIVATE SECTION.
ENDCLASS.


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

        " the controller-loaded Dialog fragment, declared in the view's dependents aggregation
        )->ele( n = `dependents` ns = `mvc`

            )->ele( `ViewSettingsDialog`
                )->a( n = `id`                   v = `settingsDialog`
                )->a( n = `filterSearchOperator` v = client->_bind( search_operator )

                )->ele( `filterItems`
                    )->ele( `ViewSettingsFilterItem`
                        )->a( n = `text` v = `Products`
                        )->a( n = `key`  v = `1`

                        )->ele( `items`
                            )->tag( `ViewSettingsItem`
                                )->a( n = `text` v = `Mouse DX20`
                                )->a( n = `key`  v = `1a`
                            )->tag( `ViewSettingsItem`
                                )->a( n = `text` v = `Optical mouse OX3`
                                )->a( n = `key`  v = `1b`
                            )->tag( `ViewSettingsItem`
                                )->a( n = `text` v = `Monitor`
                                )->a( n = `key`  v = `1c`
                            )->tag( `ViewSettingsItem`
                                )->a( n = `text` v = `Keyboard (ultra flat)`
                                )->a( n = `key`  v = `1d`
                            )->tag( `ViewSettingsItem`
                                )->a( n = `text` v = `Wireless keyboard`
                                )->a( n = `key`  v = `1e`

                        )->end(
                    )->end(
                )->end(
            )->end(
        )->end(

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

            )->tag( `Button`
                )->a( n = `text`  v = `Search Contains`
                )->a( n = `press` v = client->_event( `OPEN_CONTAINS` )
            )->tag( `Button`
                )->a( n = `text`  v = `Search Any Word Starts With`
                )->a( n = `press` v = client->_event( `OPEN_ANY_WORD` )
            )->tag( `Button`
                )->a( n = `text`  v = `Search Case Sensitive Contains`
                )->a( n = `press` v = client->_event( `OPEN_CUSTOM` ) ).

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

  ENDMETHOD.


  METHOD on_event.

    CASE client->get_event( ).

      WHEN `OPEN_CONTAINS`.
        dialog_open( `Contains` ).

      WHEN `OPEN_ANY_WORD`.
        dialog_open( `AnyWordStartsWith` ).

      WHEN `OPEN_CUSTOM`.
        " the original installs a case-SENSITIVE contains callback here; a live
        " JS function has no declarative equivalent, so the closest built-in
        " operator (case-insensitive Contains) is used instead
        dialog_open( `Contains` ).

    ENDCASE.

  ENDMETHOD.


  METHOD dialog_open.

    search_operator = operator.

    client->follow_up_action( val   = client->cs_event-control_by_id
                              t_arg = VALUE #( ( `settingsDialog` ) ( `open` ) ) ).

  ENDMETHOD.


  METHOD model_init.

    search_operator = `Contains`.

  ENDMETHOD.

ENDCLASS.