sap.suite.ui.commons - ProcessFlow

" @keywords processflow shell processflownode processflowlaneheader
" @summary sap.suite.ui.commons.ProcessFlow expressed in abap2UI5 - a SAPUI5-only control, so the demo kit original is outside OpenUI5 and this is orientation rather than a 1:1 port.
"! <p class="shorttext">sap.suite.ui.commons - ProcessFlow</p>
"!
"! SAPUI5-only control: it ships with SAPUI5, not with OpenUI5, so there is no
"! demo kit original in this repo's sample universe and no 1:1 port (AGENTS section 3).
"! Collected here as orientation - how the control is expressed in abap2UI5.
"!
"! SAPUI5 demo kit: https://ui5.sap.com/#/entity/sap.suite.ui.commons.ProcessFlow
CLASS z2ui5_cl_smpc_sapui5_006 DEFINITION PUBLIC.

  PUBLIC SECTION.
    INTERFACES z2ui5_if_app.

    TYPES ty_t_children TYPE STANDARD TABLE OF int4 WITH NON-UNIQUE KEY table_line.
    TYPES ty_t_texts TYPE STANDARD TABLE OF string WITH NON-UNIQUE KEY table_line.

    TYPES: BEGIN OF ty_s_nodes2,
             id                TYPE string,
             lane              TYPE string,
             title             TYPE string,
             titleabbreviation TYPE string,
             children          TYPE ty_t_children,
             state             TYPE string,
             statetext         TYPE string,
             focused           TYPE abap_bool,
             highlighted       TYPE abap_bool,
             texts             TYPE ty_t_texts,
           END OF ty_s_nodes2.
    TYPES: BEGIN OF ty_s_lanes5,
             id       TYPE string,
             icon     TYPE string,
             label    TYPE string,
             position TYPE i,
           END OF ty_s_lanes5.
    TYPES ty_t_nodes2 TYPE STANDARD TABLE OF ty_s_nodes2 WITH EMPTY KEY.
    TYPES ty_t_lanes5 TYPE STANDARD TABLE OF ty_s_lanes5 WITH EMPTY KEY.

    DATA mt_nodes TYPE ty_t_nodes2.
    DATA mt_lanes TYPE ty_t_lanes5.

  PROTECTED SECTION.
    DATA client TYPE REF TO z2ui5_if_client.

    METHODS set_data.
    METHODS view_display.
    METHODS on_event.

  PRIVATE SECTION.
ENDCLASS.

CLASS z2ui5_cl_smpc_sapui5_006 IMPLEMENTATION.

  METHOD z2ui5_if_app~main.

    me->client     = client.

    IF client->check_on_init( ).

      set_data( ).

      view_display( ).
      RETURN.
    ELSEIF client->check_on_navigated( ).
      view_display( ).
    ELSEIF client->check_on_event( ).
      on_event( ).
    ENDIF.

  ENDMETHOD.


  METHOD on_event.

    IF client->get_event( ) = `NODE_PRESS`.
      " the wire carries no argument, so the press is all this knows. To act
      " on the node itself, add a t_arg to the _event( ) call in view_display
      " and read it back with client->get_event_arg( ).
      client->message_toast_display( `nodePress - a process flow node was clicked` ).
    ENDIF.

  ENDMETHOD.

  METHOD set_data.

    mt_nodes = VALUE #( ( id = `1` lane = `0` title = `Sales Order 1` titleabbreviation = `SO 1` children = VALUE #( ( 10 ) ( 11 ) ( 12 ) ) state = `Positive` statetext = `OK status` focused = abap_true
                          highlighted = abap_false texts = VALUE #( ( `Sales Order Document Overdue long text for the wrap up all the aspects` ) ( `Not cleared` ) ) )
                        ( id = `10` lane = `1` title = `Outbound Delivery 40` titleabbreviation = `OD 40` state = `Positive` statetext = `OK status` focused = abap_true highlighted = abap_false
                        texts = VALUE #( ( `Sales Order Document Overdue long text for the wrap up all the aspects` ) ( `Not cleared` ) ) )
                        ( id = `11` lane = `1` title = `Outbound Delivery 43` titleabbreviation = `OD 43` children = VALUE #( ( 21 ) ) state = `Neutral` statetext = `OK status` focused = abap_true highlighted = abap_false
                        texts = VALUE #( ( `Sales Order Document Overdue long text for the wrap up all the aspects` ) ( `Not cleared` ) ) )
                        ( id = `12` lane = `1` title = `Outbound Delivery 45` titleabbreviation = `OD 45` children = VALUE #( ( 20 ) ) state = `Neutral` focused = abap_false highlighted = abap_false
                         texts = VALUE #( ( `Sales Order Document Overdue long text for the wrap up all the aspects` ) ( `Not cleared` ) ) )
                        ( id = `20` lane = `2` title = `Invoice 9` titleabbreviation = `I 9` state = `Positive` statetext = `OK status` focused = abap_false highlighted = abap_false
                        texts = VALUE #( ( `Sales Order Document Overdue long text for the wrap up all the aspects` ) ( `Not cleared` ) ) )
                        ( id = `21` lane = `2` title = `Invoice Planned` titleabbreviation = `IP` state = `PlannedNegative` focused = abap_false highlighted = abap_false
                        texts = VALUE #( ( `Sales Order Document Overdue long text for the wrap up all the aspects` ) ( `Not cleared` ) ) ) ).

    mt_lanes = VALUE #( ( id = `0` icon = `sap-icon://order-status` label = `Order Processing` position = 0 )
                        ( id = `1` icon = `sap-icon://monitor-payments` label = `Delivery Processing` position = 1 )
                        ( id = `2` icon = `sap-icon://payment-approval` label = `Invoicing` position = 2 ) ).

  ENDMETHOD.

  METHOD view_display.

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

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

        )->ele( `Shell`
            )->ele( `Page`
                )->a( n = `title`          v = `abap2UI5 - Process Flow`
                )->a( n = `navButtonPress` v = client->_event_nav_app_leave( )
                )->a( n = `showNavButton`  b = client->check_app_prev_stack( )
                )->a( n = `class`          v = `sapUiContentPadding`

                )->ele( n = `ProcessFlow` ns = `commons`
                    )->a( n = `id`            v = `processflow1`
                    )->a( n = `nodePress`     v = client->_event( val = `NODE_PRESS` )
                    )->a( n = `nodes`         v = client->_bind( mt_nodes )
                    )->a( n = `lanes`         v = client->_bind( mt_lanes )
                    )->a( n = `scrollable`    b = abap_true
                    )->a( n = `wheelZoomable` b = abap_false
                    )->a( n = `foldedCorners` b = abap_true

                    )->ele( n = `nodes` ns = `commons`
                        )->tag( n = `ProcessFlowNode` ns = `commons`
                            )->a( n = `laneId`            v = `{LANE}`
                            )->a( n = `nodeId`            v = `{ID}`
                            )->a( n = `title`             v = `{TITLE}`
                            )->a( n = `titleAbbreviation` v = `{TITLEABBREVIATION}`
                            )->a( n = `children`          v = `{CHILDREN}`
                            )->a( n = `state`             v = `{STATE}`
                            )->a( n = `stateText`         v = `{STATETEXT}`
                            )->a( n = `highlighted`       v = `{HIGHLIGHTED}`
                            )->a( n = `focused`           v = `{FOCUSED}`

                    )->end(

                    )->ele( n = `lanes` ns = `commons`
                        )->tag( n = `ProcessFlowLaneHeader` ns = `commons`
                            )->a( n = `laneId`   v = `{ID}`
                            )->a( n = `iconSrc`  v = `{ICON}`
                            )->a( n = `text`     v = `{LABEL}`
                            )->a( n = `position` v = `{POSITION}` ).

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

  ENDMETHOD.

ENDCLASS.