TOP of PAGE using ABAP oo with single CUSTOM CONTROL

Question

Can anybody please tell me how to handle TOP_OF_PAGE using ABAP OBJECTS with a SINGLE CUSTOM CONTROL and not with  SPLIT CONTAINER(i.e. using single CL_GUI_CUSTOM_CONTAINER and single grid CL_GUI_ALV_GRID  ). Is it possible if so Please help me out?

Answer 1

Hi Ravi,
Here is my code. i didn't handle the top_of_page event yet but created a method to handle.
REPORT  ZSATEESH_ALV_CONTAINER MESSAGE-ID ZZ
                  LINE-SIZE 150 NO STANDARD PAGE HEADING.
PROGRAM id        :  ZSATEESH_ALV_CONTAINER                         *
Title             : Sales document report                           *
Author            : Sateesh                                         *
Date              :                                                 *
CR#               :                                                 *
Dev Initiative    :
Description       :ALV GRID/LIST Report which displays the sales
                      document header data using ABAP Objects.
                          Modification Log
Corr. no        date       programmer        description
                TYPES Declaration
*--Type for the Header Sales data
TYPES: BEGIN OF TY_VBAK ,
        INDICAT LIKE ICON-ID,               " Icon
        VBELN   LIKE VBAK-VBELN,            " Sales Document
        AUDAT   LIKE VBAK-AUDAT,            " Document date
        VBTYP   LIKE VBAK-VBTYP,            " SD document category
        AUART   LIKE VBAK-AUART,            " Sales Document Type
        AUGRU   LIKE VBAK-AUGRU,            " Order reason
        NETWR   LIKE VBAK-NETWR,            " Net Value
        WAERK   LIKE VBAK-WAERK,            " SD document currency
     END OF TY_VBAK.
                DATA Declaration
*--Tableto hold the header sales data
DATA: TB_VBAK  TYPE  STANDARD TABLE OF TY_VBAK.
*--Table to hold the Icons
DATA: BEGIN OF TB_ICON OCCURS 0,
        ID   TYPE ICON-ID,                  " Icon
        NAME TYPE ICON-NAME,                " Name of an Icon
      END OF TB_ICON.
*--Declaration of ALV Grid Tables
DATA: TB_FDCAT         TYPE LVC_T_FCAT,     " Fieldcatalog
      TB_SORT          TYPE LVC_T_SORT.     " Sorting
DATA: OK_CODE          LIKE SY-UCOMM.       " sy-ucomm
*--Reference variables for container and grid control.
DATA: CUSTOM_CONTAINER TYPE REF TO CL_GUI_CUSTOM_CONTAINER,
                                            " Container reference
      OBJ_ALV_GRID     TYPE REF TO CL_GUI_ALV_GRID.
" Alv Grid reference
                  S T R U C T U R E S
DATA: X_FDCAT          TYPE LVC_S_FCAT,     " Fieldcatalog
      X_LAYOUT         TYPE LVC_S_LAYO,     " layout
      X_SORT           TYPE LVC_S_SORT,     " Sorting
      X_VBAK           TYPE TY_VBAK,        " sales header stucture
      X_ICON           LIKE TB_ICON.        " icons structure
                  C O N S T A N T S
*--Declaration of Constants
CONSTANTS :
            C_GREEN(40)    TYPE  C VALUE 'ICON_GREEN_LIGHT',
            C_RED(40)      TYPE  C VALUE 'ICON_RED_LIGHT',
            C_YELLOW(40)   TYPE  C VALUE 'ICON_YELLOW_LIGHT',
            C_X            TYPE  C VALUE 'X'.      " Flag
                  SELECTION SCREEN
*--Block 1.
SELECTION-SCREEN : BEGIN OF BLOCK B1 WITH FRAME TITLE TEXT-001.
PARAMETER: P_AUDAT LIKE VBAK-AUDAT
                   DEFAULT '20050101'(003).    " doc date.
SELECTION-SCREEN: END OF BLOCK B1.
*--bLOCK 2.
SELECTION-SCREEN : BEGIN OF BLOCK B2 WITH FRAME TITLE TEXT-002.
PARAMETER :P_ALVDIS AS CHECKBOX.              " For List/Grid
SELECTION-SCREEN : END OF BLOCK B2.
      Class LC_VBAK  definition
CLASS  LC_VBAK DEFINITION.
  PUBLIC SECTION.
    METHODS: VBAK_POPULATE,                 " sales header population
             ICON_POPULATE,                 " Icons population
             FINAL_POPULATE,                " Final ALV population
             DISPLAY,                      " Displaying ALV
             TOP_OF_PAGE FOR EVENT TOP_OF_PAGE OF CL_GUI_ALV_GRID
                                           IMPORTING E_DYNDOC_ID.
ENDCLASS.                    "LC_VBAK DEFINITION
      Class LC_VBAK IMPLEMENTATION
CLASS LC_VBAK IMPLEMENTATION.
  METHOD VBAK_POPULATE.
*-- selecting from VBAK
    SELECT VBELN
            AUDAT
            VBTYP
            AUART
            AUGRU
            NETWR
            WAERK
            INTO   CORRESPONDING FIELDS OF TABLE TB_VBAK
            FROM VBAK
            WHERE AUDAT > P_AUDAT AND
            NETWR  > 0.
    IF SY-SUBRC <> 0.
      SORT TB_VBAK  BY AUART VBTYP WAERK .
    ENDIF.
  ENDMETHOD .                    "VBAK_POPULATE
  METHOD ICON_POPULATE.
*--selecting from ICON table
    SELECT ID
           NAME
           INTO TABLE TB_ICON
           FROM ICON.
    IF SY-SUBRC = 0.
      SORT TB_ICON BY NAME .
    ENDIF.
  ENDMETHOD .                    "ICON_POPULATE
  METHOD FINAL_POPULATE.
*--looping through VBAK table into the work area
    LOOP AT TB_VBAK INTO X_VBAK .
      IF X_VBAK-NETWR <= 10.
*--Reading the ICON table into work area comparing field NAME
        READ TABLE TB_ICON INTO X_ICON WITH KEY NAME = C_GREEN
                                                 BINARY SEARCH.
        IF SY-SUBRC = 0.
          X_VBAK-INDICAT =  X_ICON-ID.
*--modifying the TB_VBAK table
          MODIFY TB_VBAK FROM X_VBAK.
        ENDIF.
      ELSEIF X_VBAK-NETWR > 10 AND X_VBAK-NETWR < 100.
*--Reading the ICON table into work area comparing field NAME
        READ TABLE TB_ICON INTO X_ICON WITH KEY NAME = C_YELLOW
                                                 BINARY SEARCH.
        IF SY-SUBRC = 0.
          X_VBAK-INDICAT =  X_ICON-ID.
*--modifying the TB_VBAK table
          MODIFY TB_VBAK FROM X_VBAK.
        ENDIF.
      ELSEIF X_VBAK-NETWR >= 100.
*--Reading the ICON table into work area comparing field NAME
        READ TABLE TB_ICON INTO X_ICON WITH KEY NAME = C_RED
                                                 BINARY SEARCH.
        IF SY-SUBRC = 0.
          X_VBAK-INDICAT =  X_ICON-ID.
*--modifying the TB_VBAK table
          MODIFY TB_VBAK FROM X_VBAK.
        ENDIF.
      ENDIF.
    ENDLOOP.
  ENDMETHOD.                    "FINAL_POPULATE
      METHOD top_of_page                                            *
  METHOD TOP_OF_PAGE.
    PERFORM EVENT_TOP_OF_PAGE USING E_DYNDOC_ID.
  ENDMETHOD.                    "top_of_page
  METHOD DISPLAY.
*--Building fieldcatalog table
    PERFORM FIELDCATLOG.
*--FOr making the Layout settings
    PERFORM LAYOUT.
*--For sorting the fields
    PERFORM SORTING.
*--perform for displaying the ALV
    PERFORM ALV_GRID_DISPLAY.
  ENDMETHOD.                    "DISPLAY
ENDCLASS.                    "LC_VBAK IMPLEMENTATION
*&      Form  FIELDCATLOG
     Building the FIELDCATALOG
FORM FIELDCATLOG .
  CLEAR: X_FDCAT,TB_FDCAT[].
  X_FDCAT-ROW_POS   = 1.
  X_FDCAT-COL_POS   = 1.
  X_FDCAT-FIELDNAME = 'INDICAT'(004) .
  X_FDCAT-TABNAME   = 'TB_VBAK'(005).
  X_FDCAT-SCRTEXT_L = 'STATUS_INDICATOR'(006).
  APPEND X_FDCAT TO TB_FDCAT.
  X_FDCAT-ROW_POS   = 1.
  X_FDCAT-COL_POS   = 2.
  X_FDCAT-FIELDNAME = 'VBELN'(007) .
  X_FDCAT-TABNAME   = 'TB_VBAK'(005).
  X_FDCAT-SCRTEXT_L = 'SALES DOC'(008).
  APPEND X_FDCAT TO TB_FDCAT.
  X_FDCAT-ROW_POS   = 1.
  X_FDCAT-COL_POS   = 3.
  X_FDCAT-FIELDNAME = 'AUDAT'(009) .
  X_FDCAT-TABNAME   = 'TB_VBAK'.
  X_FDCAT-SCRTEXT_L = 'DOC DATE'(010).
  APPEND X_FDCAT TO TB_FDCAT.
  X_FDCAT-ROW_POS   = 1.
  X_FDCAT-COL_POS   = 4.
  X_FDCAT-FIELDNAME = 'VBTYP'(011) .
  X_FDCAT-TABNAME   = 'TB_VBAK'.
  X_FDCAT-SCRTEXT_L = 'SALES CATEGORY'(012).
  APPEND X_FDCAT TO TB_FDCAT.
  X_FDCAT-ROW_POS   = 1.
  X_FDCAT-COL_POS   = 5.
  X_FDCAT-FIELDNAME = 'AUART'(013) .
  X_FDCAT-TABNAME   = 'TB_VBAK'.
  X_FDCAT-SCRTEXT_L = 'DOC TYPE'(014).
  APPEND X_FDCAT TO TB_FDCAT.
  X_FDCAT-ROW_POS   = 1.
  X_FDCAT-COL_POS   = 6.
  X_FDCAT-FIELDNAME = 'AUGRU'(015) .
  X_FDCAT-TABNAME   = 'TB_VBAK'.
  X_FDCAT-SCRTEXT_L = 'REASON'(016).
  APPEND X_FDCAT TO TB_FDCAT.
  X_FDCAT-ROW_POS   = 1.
  X_FDCAT-COL_POS   = 7.
  X_FDCAT-FIELDNAME = 'NETWR'(017) .
  X_FDCAT-TABNAME   = 'TB_VBAK'.
  X_FDCAT-SCRTEXT_L = 'NET VALUE'(018).
  X_FDCAT-DO_SUM   = C_X.
  APPEND X_FDCAT TO TB_FDCAT.
  X_FDCAT-ROW_POS   = 1.
  X_FDCAT-COL_POS   = 8.
  X_FDCAT-FIELDNAME = 'WAERK'(019) .
  X_FDCAT-TABNAME   = 'TB_VBAK'.
  X_FDCAT-SCRTEXT_L = 'UNIT'(020).
  APPEND X_FDCAT TO TB_FDCAT.
ENDFORM.                    " FIELDCATLOG
*&      Module  STATUS_0007  OUTPUT
      module for setting the pf status
MODULE STATUS_0007 OUTPUT.
  SET PF-STATUS 'ZSTATUS'.
SET TITLEBAR 'xxx'.
ENDMODULE.                 " STATUS_0007  OUTPUT
*&      Module  USER_COMMAND_0007  INPUT
      module  for handling the user commands
MODULE USER_COMMAND_0007 INPUT.
  OK_CODE = SY-UCOMM.
  CASE OK_CODE.
    WHEN 'BACK'.
      LEAVE TO SCREEN 0.
    WHEN 'CANCEL'.
      LEAVE TO SCREEN 0.
    WHEN 'EXIT'.
      LEAVE TO SCREEN 0.
  ENDCASE.
ENDMODULE.                 " USER_COMMAND_0007  INPUT
*&      Form  LAYOUT
      ALV Layout settings
FORM LAYOUT .
  CLEAR X_LAYOUT.
*-- making Layout settings
  X_LAYOUT-GRID_TITLE = 'Sales Header Document'(021).
  X_LAYOUT-ZEBRA      = C_X.
  IF P_ALVDIS =  C_X.
    X_LAYOUT-NO_HGRIDLN = C_X.
    X_LAYOUT-NO_VGRIDLN = C_X.
  ENDIF.
ENDFORM.                    " LAYOUT
*&      Form  SORTING
      sub routine for sorting criteria
FORM SORTING .
  CLEAR X_SORT.
  X_SORT-SPOS = '1'(022).
  X_SORT-FIELDNAME = 'AUART'.
  X_SORT-UP        = C_X.
  APPEND X_SORT TO TB_SORT.
  CLEAR X_SORT.
  X_SORT-SPOS = '2'(023).
  X_SORT-FIELDNAME = 'VBTYP'.
  X_SORT-UP        = C_X.
  APPEND X_SORT TO TB_SORT.
  CLEAR X_SORT.
  X_SORT-SPOS = '3'(024).
  X_SORT-FIELDNAME = 'WAERK'.
  X_SORT-UP        = C_X.
  X_SORT-SUBTOT    = C_X.
  APPEND X_SORT TO TB_SORT.
ENDFORM.                    " SORTING
*&      Form  CREATE_CONTAINER_OBJECT
      subroutine to create object of container
FORM CREATE_CONTAINER_OBJECT .
  CREATE OBJECT CUSTOM_CONTAINER
    EXPORTING
      CONTAINER_NAME              = 'CUST_CONTROL'(025)
    EXCEPTIONS
      CNTL_ERROR                  = 1
      CNTL_SYSTEM_ERROR           = 2
      CREATE_ERROR                = 3
      LIFETIME_ERROR              = 4
      LIFETIME_DYNPRO_DYNPRO_LINK = 5
      OTHERS                      = 6
  IF SY-SUBRC <> 0.
    MESSAGE ID SY-MSGID TYPE SY-MSGTY NUMBER SY-MSGNO
               WITH SY-MSGV1 SY-MSGV2 SY-MSGV3 SY-MSGV4.
  ENDIF.
ENDFORM.                    " CREATE_CONTAINER_OBJECT
*&      Form  CREATE_ALV_GRID_OBJECT
      subroutine to create object of ALV GRID
FORM CREATE_ALV_GRID_OBJECT .
  CREATE OBJECT OBJ_ALV_GRID
    EXPORTING
      I_PARENT          = CUSTOM_CONTAINER
    EXCEPTIONS
      ERROR_CNTL_CREATE = 1
      ERROR_CNTL_INIT   = 2
      ERROR_CNTL_LINK   = 3
      ERROR_DP_CREATE   = 4
      OTHERS            = 5
  IF SY-SUBRC <> 0.
    MESSAGE ID SY-MSGID TYPE SY-MSGTY NUMBER SY-MSGNO
               WITH SY-MSGV1 SY-MSGV2 SY-MSGV3 SY-MSGV4.
  ENDIF.
ENDFORM.                    " CREATE_ALV_GRID_OBJECT
*&      Form  ALV_GRID_DISPLAY
      subroutine to call method for displaying the ALV GRID
FORM ALV_GRID_DISPLAY .
  CALL METHOD OBJ_ALV_GRID->SET_TABLE_FOR_FIRST_DISPLAY
    EXPORTING
      IS_LAYOUT                     = X_LAYOUT
    CHANGING
      IT_OUTTAB                     = TB_VBAK
      IT_FIELDCATALOG               = TB_FDCAT
      IT_SORT                       = TB_SORT
    EXCEPTIONS
      INVALID_PARAMETER_COMBINATION = 1
      PROGRAM_ERROR                 = 2
      TOO_MANY_LINES                = 3
      OTHERS                        = 4.
  IF SY-SUBRC <> 0.
    MESSAGE ID SY-MSGID TYPE SY-MSGTY NUMBER SY-MSGNO
               WITH SY-MSGV1 SY-MSGV2 SY-MSGV3 SY-MSGV4.
  ENDIF.
  CALL SCREEN 0007.
ENDFORM.                    " ALV_GRID_DISPLAY
                START OF SELECTION
START-OF-SELECTION.
*--Creating a reference variable for the class LC_VBAK
  DATA : OBJ1 TYPE REF TO LC_VBAK.
*--Creating a container object
  PERFORM CREATE_CONTAINER_OBJECT.
*--Creating a ALV GRID control object
  PERFORM CREATE_ALV_GRID_OBJECT.
*--Creating a object of class LC_VBAK
  CREATE OBJECT OBJ1.
*--calling vbak population method
  CALL METHOD OBJ1->VBAK_POPULATE.
*--calling icon population method
  CALL METHOD OBJ1->ICON_POPULATE.
*--calling fianl table population method
  CALL METHOD OBJ1->FINAL_POPULATE.
*--calling final  method for display
  CALL METHOD OBJ1->DISPLAY.
*&      Form  EVENT_TOP_OF_PAGE
      text
     -->P_E_DYNDOC_ID  text
FORM EVENT_TOP_OF_PAGE  USING    P_E_DYNDOC_ID TYPE REF TO
                                                  CL_DD_DOCUMENT.
ENDFORM.                    " EVENT_TOP_OF_PAGE