OverflowToolbar - Active

Making an OverflowToolbar or a Toolbar active allows them to react to the click event.

Z2UI5_CL_SMPC_APP_424

Controls sap.m UI5 1.71

The facts

Repository: abap2UI5/samples-controls
Class: Z2UI5_CL_SMPC_APP_424
Source file: z2ui5_cl_smpc_app_424.clas.abap ↗
Library: sap.m
UI5 entity: sap.m.OverflowToolbar
Demo kit sample: sap.m.sample.ToolbarActive
SAP's own sample: running at sdk.openui5.org ↗
Minimum UI5: 1.71 — the floor abap2UI5 holds its samples to
In the playground: runs in the browser, with no system and nothing installed

Keywords: overflowtoolbar, overflow, toolbar, sap.m, toolbaractive, checkbox, text, toolbarspacer, icon

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_424.clas.abap — 73 lines Read it on GitHub ↗

" @keywords overflowtoolbar overflow toolbar sap.m toolbaractive checkbox text toolbarspacer icon
" @summary Making an OverflowToolbar or a Toolbar active allows them to react to the click event.
CLASS z2ui5_cl_smpc_app_424 DEFINITION PUBLIC.

  PUBLIC SECTION.
    INTERFACES z2ui5_if_app.

    DATA active TYPE abap_bool VALUE abap_true.

  PROTECTED SECTION.
    DATA client TYPE REF TO z2ui5_if_client.

    METHODS view_display.

  PRIVATE SECTION.
ENDCLASS.


CLASS z2ui5_cl_smpc_app_424 IMPLEMENTATION.

  METHOD z2ui5_if_app~main.

    me->client = client.
    IF client->check_on_navigated( ).
      view_display( ).
    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:core` v = `sap.ui.core`

        " onCheckBoxSelect calls toolbar.setActive( selected ) - reproduced roundtrip-free
        " by two-way binding the same flag on CheckBox.selected and OverflowToolbar.active
        " (the CheckBox select attribute is dropped)
        )->tag( `CheckBox`
            )->a( n = `text`     v = `Active`
            )->a( n = `selected` v = client->_bind( active )

        )->ele( `OverflowToolbar`
            )->a( n = `id`             v = `toolbar`
            )->a( n = `active`         v = client->_bind( active )
            )->a( n = `design`         v = `Info`
            )->a( n = `height`         v = `2rem`
            " onToolbarPress shows a MessageToast with a constant text - composed on the
            " client (control_global MESSAGE_TOAST), so the press needs no round-trip
            )->a( n = `press`          v = client->follow_up_action( val   = client->cs_event-control_global
                                                                     t_arg = VALUE #( ( `MESSAGE_TOAST` ) ( `show` ) ( `OverflowToolbar is clicked` ) ) )
            )->a( n = `ariaLabelledBy` v = `myText`

            )->tag( `Text`
                )->a( n = `id`   v = `myText`
                )->a( n = `text` v = `If you click here, while the OverflowToolbar is active, an event will be fired.`
            )->tag( `Text`
                )->a( n = `id`   v = `myText1`
                )->a( n = `text` v = `There should be no interactive elements in the toolbar.`
            )->tag( `ToolbarSpacer`
            )->tag( n = `Icon` ns = `core`
                )->a( n = `src`   v = `sap-icon://undo`
                )->a( n = `width` v = `2rem` ).

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

  ENDMETHOD.

ENDCLASS.