Custom Function on OO ALV Grid

Question

I am trying to implement ALV_GRID_XT to enhance the ALV Grid toolbar by adding couple of custom funcitons.As per the SAP documentation I have created 2 methods ON_TOOLBAR - one for adding items on toolbar and the other ON_USER_COMMAND - for processing if the user clicks on the custom function.
I am unable to relate the ALV Grid instance onto the method ON_USER_COMMAND . One of the funciton is to calculate the average of column which represents percentage excluding cells with zero values. Once the user selects column(s) and clicks on the Percent button on the ALV grid my piece of code should trigger ON_USER_COMMAND and then display the average percentage on the Totals row.
Method ON_USER_COMMAND has only one parameter E_UCOMM which i am able to get in the method but I am not able to get the instance of the ALV grid so that I can play around with the data in the Grid.
I could have used a local class and then enhanced the ALV toolbar but this requirement is needed for about 20 reports and hence thought of implementing it globally.
Any ideas would be appreciated.

Answer 1

Hi there
You need to set the handlers of course and register the events
I'm using also a Z-class  using functionality from the ALV Grid
in the application program
data: z_object type ref to zcl_*      "my z_class"
* Instantiate your Z class
create object z_object
       exporting
                  z_object = z_object
                  cfname = 'CCONTAINER1'.
Now in your Constructor for your Z-Class have a variable
say grid1 which is defined as a type ref to cl_gui_alv_grid.
Code the methods you require --. The trick is to instantiate your OWN Z class and within  YOUR CLASS  instantiate the GRID1 variable as an instance of cl_gui_alv_grid - then you can use methods etc from that class in your own Z class simple via  something like this
method CONSTRUCTOR.
create object grid_container1
        exporting
    container_name = cfname.
    create object  grid1
       exporting
          i_parent = grid_container1.
    set handler z_object->on_user_command for grid1.
    set handler z_object->on_toolbar for grid1.
    set handler z_object->handle_data_changed for grid1.
    set handler z_object->handle_data_changed_finished for grid1.
    set handler z_object->on_dubbelklik for grid1.
    set handler z_object->on_hotspot for grid1.
    call method grid1->register_edit_event
        exporting
           i_event_id = cl_gui_alv_grid=>mc_evt_enter.
  endmethod.
method display_grid .
get reference of g_outtab into g_outtab1.
     get reference of g_fldcat into g_fldcat1.
    struct_grid_lset-edit = i_edit.    "To enable editing in ALV
    struct_grid_lset-zebra = i_zebra.
    struct_grid_lset-cwidth_opt = i_opt.
    struct_grid_lset-grid_title = i_gridtitle.
*    struct_grid_lset-ctab_fname = 'T_CELLCOLORS'.
*    struct_grid_lset-stylefname = 'CELLTAB'.
     struct_grid_lset-ctab_fname = style_fname.
     struct_grid_lset-stylefname = style_ctab.
*     export gt_outtab from gt_outtab to memory id 'gt_outtab'.
    call method grid1->set_table_for_first_display
       exporting
             is_layout       = struct_grid_lset
       changing
             it_outtab       = gt_outtab
             it_fieldcatalog = it_fldcat.
  endmethod.
You need to add the buttons to the toolbar with your ON TOOLBAR method
for example
method on_toolbar .
type-pools icon.
clear ls_toolbar.
     move  0 to ls_toolbar-butn_type.
     move 'EXCEL' to ls_toolbar-function.
     move  space to ls_toolbar-disabled.
     move  icon_xxl to ls_toolbar-icon.
     move 'Excel' to ls_toolbar-quickinfo.
     move  'EXCEL' to ls_toolbar-text.
     append ls_toolbar to e_object->mt_toolbar.
    perform   toolbar  in program (caller) if found
     using e_object.
endmethod.
Now the functionality should work in the ON_USER_COMMAND .
Here's my ON_USER_COMMAND method within the class
method ON_USER_COMMAND.
*        FOR EVENT before_user_command OF cl_gui_alv_grid
*        IMPORTING
*          e_ucomm
*          sender
* When defined in SE24 you don't need to code the
* FOR EVENT etc as this is already defined as an event handler
case e_ucomm.
      when 'EXIT'.
        leave program.
      when 'EXCEL'.
       call method me->download_to_excel.
      when 'SAVE'.
      when 'PROC'.
        call method me->process.
      when 'REFR'.
        call method me->refresh.
        when 'SWITCH'.
        call method me->switch.
       when 'TEST'.
        call method me->get_cell.
       endcase.
endmethod.
Add whatever  extra functionality you want to the on_user_command so long as you've defined toolbars..
Cheers
jimbo