Using the Document Class to display the contents of an internal table

[Former Member]

In one of my earlier blogs ALV Fast Display Class I had explained how the SAP standard document class

cl_dd_document

can be used along with the ALV class

cl_gui_alv_grid

for displaying ALV headers and footers in any report.In this blog I would like to go a little further and explain how the document class can be used to display the contents of any internal table dynamically.

Part 1 : Class ZCL_DOCUMENT_DISPLAY

<p>        PUBLIC SECTIONclass ZCL_DOCUMENT_DISPLAY definition  public  final  create public .public section.  type-pools SDYDO .  methods CONSTRUCTOR    importing      !I_ALV type ref to CL_GUI_ALV_GRID      !IT_OUTTAB type STANDARD TABLE      value(WIDTH) type I default 30      value(HEIGHT) type I default 30      value(TOP) type I default 0      value(LEFT) type I default 0      value(CAPTION) type SDYDO_TEXT_ELEMENT optional      value(DOC_TITLE) type SDYDO_TEXT_ELEMENT optional .</p>




<p>          Private section.  data MT_OUTTAB type ref to DATA .  data REF_ALV type ref to CL_GUI_ALV_GRID .  data REF_DIALOG type ref to CL_GUI_DIALOGBOX_CONTAINER .  data GT_BUTTONS type TTB_BUTTON .  data AT_DISPLAY_AS_DIALOG_BOX type XFELD .  data AT_DOC_TITLE type SDYDO_TEXT_ELEMENT .  data AT_WIDTH type I .  data AT_HEIGHT type I .  data AT_TOP type I .  data AT_LEFT type I .  data AT_CAPTION type SDYDO_TEXT_ELEMENT .  methods HANDLE_TOOLBAR    for event TOOLBAR of CL_GUI_ALV_GRID    importing      !E_OBJECT      !E_INTERACTIVE .  methods HANDLE_USER_COMMAND    for event USER_COMMAND of CL_GUI_ALV_GRID    importing      !E_UCOMM .  methods HANDLE_CLOSE    for event CLOSE of CL_GUI_DIALOGBOX_CONTAINER    importing      !SENDER .  methods DISPLAY_DOCUMENT .</p>

Methods

METHOD constructor.

  DATA :

  wa_buttons TYPE stb_button."Work area for custom buttons

*Add the button to display document to the ALV Toolbar

• append a separator to normal toolbar

  CLEAR : wa_buttons,gt_buttons.

  MOVE 3 TO wa_buttons-butn_type.

  APPEND wa_buttons TO gt_buttons.

•   append create assets button

  CLEAR wa_buttons.

  MOVE 'DOC' TO wa_buttons-function.

  MOVE icon_document TO wa_buttons-icon.

  MOVE 'Document View' TO wa_buttons-quickinfo.

  MOVE ' ' TO wa_buttons-disabled.

  APPEND wa_buttons TO gt_buttons.

*Set the handler for toolbar

  SET HANDLER me->handle_toolbar FOR i_alv.

*Set the handle for user command

  SET HANDLER me->handle_user_command FOR i_alv.

*Assign the output table and alv object to private attributes

  GET REFERENCE OF it_outtab INTO mt_outtab.

  ref_alv ?= i_alv.

  at_doc_title          = doc_title.

  at_width              = width.

  at_height             = height.

  at_top                = top.

  at_left               = left.

  at_caption            = caption.

ENDMETHOD.

METHOD handle_toolbar.

  DATA :

    lwa_buttons TYPE stb_button,

     wa_toolbar  TYPE stb_button.

  LOOP AT gt_buttons INTO lwa_buttons.

    MOVE-CORRESPONDING lwa_buttons TO wa_toolbar.

    APPEND wa_toolbar TO e_object->mt_toolbar.

    CLEAR wa_toolbar.

  ENDLOOP.

ENDMETHOD.

METHOD handle_user_command.

  IF e_ucomm = 'DOC'.

*Display the document

    CALL METHOD me->display_document.

  ENDIF.

ENDMETHOD.

method HANDLE_CLOSE.

call method sender->free.

endmethod.

METHOD display_document.

  DATA :

  lt_fieldcatalog  TYPE lvc_t_fcat,

  lwa_fieldcatalog TYPE lvc_s_fcat,

  ref_dd           TYPE REF TO cl_dd_document,

  ref_dd_table     TYPE REF TO cl_dd_table_element,

  ref_column       TYPE REF TO cl_dd_area,

  ref_form         TYPE REF TO cl_dd_form_area,

  v_heading        TYPE sdydo_text_element,

  v_text           TYPE sdydo_text_element,

  v_column_count   TYPE i,

  ref_html          TYPE REF TO cl_gui_html_viewer,

  ref_doc_container TYPE REF TO cl_gui_container.

  FIELD-SYMBOLS: html_control = ref_html.

• Display document

    CALL METHOD ref_dd->display_document

      EXPORTING

        reuse_control      = 'X'

        parent             = ref_dialog

      EXCEPTIONS

        html_display_error = 1.

  ENDIF.

ENDMETHOD.

Part 2: Test Program

<p>REPORT  zalv_fast.DATA :ref_alv       TYPE REF TO cl_gui_alv_grid,gt_sflight    TYPE TABLE OF sflight,ref_doc       TYPE REF TO zcl_document_display.SELECTION-SCREEN BEGIN OF SCREEN 1001.SELECTION-SCREEN END OF SCREEN 1001.SELECT * FROM sflight INTO TABLE gt_sflight UP TO 15 ROWS.CREATE OBJECT ref_alv EXPORTING i_parent = cl_gui_container=>screen0.********************************************************IF ref_doc IS INITIAL.*Display in document view*in user defined dialog box  CREATE OBJECT ref_doc    EXPORTING      i_alv     = ref_alv      it_outtab = gt_sflight      width     = 900      height    = 200      top       = 50      left      = 50      caption   = 'Flight Details'  "For dialog box      doc_title = 'Flight Details'. "For documentENDIF.CALL METHOD ref_alv->set_table_for_first_display  EXPORTING    i_structure_name = 'SFLIGHT'  CHANGING    it_outtab        = gt_sflight.CALL SELECTION-SCREEN 1001.</p>

Note :

In this example I have merged the document class with the ALV class to display the result.But it is also possible to use the document class independantly within a separate custom container.