Draft Indicator

The Draft Indicator shows that eighter currently a draft is saving or that it is already saved. It does not block the current UI screen so other operations could be triggered in parallel.

Z2UI5_CL_SMPC_APP_021

Controls sap.m UI5 1.71

The facts

Repository: abap2UI5/samples-controls
Class: Z2UI5_CL_SMPC_APP_021
Source file: z2ui5_cl_smpc_app_021.clas.abap ↗
Library: sap.m
UI5 entity: sap.m.DraftIndicator
Demo kit sample: sap.m.sample.DraftIndicator
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: draftindicator, draft, indicator, sap.m, sap.m.label, verticallayout, button

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

" @keywords draftindicator draft indicator sap.m sap.m.label verticallayout button
" @summary The Draft Indicator shows that eighter currently a draft is saving or that it is already saved. It does not block the current UI screen so other operations could be triggered in parallel.
CLASS z2ui5_cl_smpc_app_021 DEFINITION PUBLIC.

  PUBLIC SECTION.
    INTERFACES z2ui5_if_app.

    DATA state TYPE string.

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

        )->ele( `Page`
            )->a( n = `showHeader`    v = `false`
            )->a( n = `class`         v = `sapUiContentPadding`
            )->a( n = `showNavButton` v = `false`

            )->ele( n = `VerticalLayout` ns = `l`
                )->ele( n = `content` ns = `l`
                    )->tag( `Button`
                        )->a( n = `id`    v = `setSavingDraft`
                        )->a( n = `class` v = `sapUiSmallMarginBottom`
                        )->a( n = `text`  v = `Set Saving Draft state`
                        )->a( n = `width` v = `200px`
                        )->a( n = `press` v = client->_event( `SET_SAVING_DRAFT` )
                    )->tag( `Button`
                        )->a( n = `id`    v = `setSavedDraft`
                        )->a( n = `class` v = `sapUiSmallMarginBottom`
                        )->a( n = `text`  v = `Set Draft Saved state`
                        )->a( n = `width` v = `200px`
                        )->a( n = `press` v = client->_event( `SHOW_DRAFT_SAVED` )
                    )->tag( `Button`
                        )->a( n = `id`    v = `setClearDraft`
                        )->a( n = `class` v = `sapUiSmallMarginBottom`
                        )->a( n = `text`  v = `Clear Draft state`
                        )->a( n = `width` v = `200px`
                        )->a( n = `press` v = client->_event( `CLEAR_DRAFT_STATE` )
                    " the controller's showDraftSaving/showDraftSaved/clearDraftState calls, expressed via the public state property (its setter queues the same transitions)
                    )->tag( `DraftIndicator`
                        )->a( n = `id`    v = `draftIndi`
                        )->a( n = `state` v = client->_bind( state ) ).

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

  ENDMETHOD.


  METHOD on_event.

    CASE client->get_event( ).

      WHEN `SET_SAVING_DRAFT`.
        state = `Saving`.

      WHEN `SHOW_DRAFT_SAVED`.
        state = `Saved`.

      WHEN `CLEAR_DRAFT_STATE`.
        state = `Clear`.

    ENDCASE.

  ENDMETHOD.


  METHOD model_init.

    " the UI5 default of the enum-typed state property - an empty string would crash it
    state = `Clear`.

  ENDMETHOD.

ENDCLASS.