abap2xlsx/src/zcl_excel_table.clas.abap
Lars Hvam 8d072439da
remove TYPE-POOLS statements (#948)
* remove TYPE-POOLS statements

* fix whitespace

Co-authored-by: sandraros <34005250+sandraros@users.noreply.github.com>
2022-01-03 21:42:10 +01:00

305 lines
13 KiB
ABAP

CLASS zcl_excel_table DEFINITION
PUBLIC
FINAL
CREATE PUBLIC .
*"* public components of class ZCL_EXCEL_TABLE
*"* do not include other source files here!!!
PUBLIC SECTION.
CONSTANTS builtinstyle_dark1 TYPE zexcel_table_style VALUE 'TableStyleDark1'. "#EC NOTEXT
CONSTANTS builtinstyle_dark2 TYPE zexcel_table_style VALUE 'TableStyleDark2'. "#EC NOTEXT
CONSTANTS builtinstyle_dark3 TYPE zexcel_table_style VALUE 'TableStyleDark3'. "#EC NOTEXT
CONSTANTS builtinstyle_dark4 TYPE zexcel_table_style VALUE 'TableStyleDark4'. "#EC NOTEXT
CONSTANTS builtinstyle_dark5 TYPE zexcel_table_style VALUE 'TableStyleDark5'. "#EC NOTEXT
CONSTANTS builtinstyle_dark6 TYPE zexcel_table_style VALUE 'TableStyleDark6'. "#EC NOTEXT
CONSTANTS builtinstyle_dark7 TYPE zexcel_table_style VALUE 'TableStyleDark7'. "#EC NOTEXT
CONSTANTS builtinstyle_dark8 TYPE zexcel_table_style VALUE 'TableStyleDark8'. "#EC NOTEXT
CONSTANTS builtinstyle_dark9 TYPE zexcel_table_style VALUE 'TableStyleDark9'. "#EC NOTEXT
CONSTANTS builtinstyle_dark10 TYPE zexcel_table_style VALUE 'TableStyleDark10'. "#EC NOTEXT
CONSTANTS builtinstyle_dark11 TYPE zexcel_table_style VALUE 'TableStyleDark11'. "#EC NOTEXT
CONSTANTS builtinstyle_light1 TYPE zexcel_table_style VALUE 'TableStyleLight1'. "#EC NOTEXT
CONSTANTS builtinstyle_light2 TYPE zexcel_table_style VALUE 'TableStyleLight2'. "#EC NOTEXT
CONSTANTS builtinstyle_light3 TYPE zexcel_table_style VALUE 'TableStyleLight3'. "#EC NOTEXT
CONSTANTS builtinstyle_light4 TYPE zexcel_table_style VALUE 'TableStyleLight4'. "#EC NOTEXT
CONSTANTS builtinstyle_light5 TYPE zexcel_table_style VALUE 'TableStyleLight5'. "#EC NOTEXT
CONSTANTS builtinstyle_pivot_light16 TYPE zexcel_table_style VALUE 'PivotStyleLight16'. "#EC NOTEXT
CONSTANTS builtinstyle_light6 TYPE zexcel_table_style VALUE 'TableStyleLight6'. "#EC NOTEXT
CONSTANTS totals_function_average TYPE zexcel_table_totals_function VALUE 'average'. "#EC NOTEXT
CONSTANTS builtinstyle_light7 TYPE zexcel_table_style VALUE 'TableStyleLight7'. "#EC NOTEXT
CONSTANTS totals_function_count TYPE zexcel_table_totals_function VALUE 'count'. "#EC NOTEXT
CONSTANTS builtinstyle_light8 TYPE zexcel_table_style VALUE 'TableStyleLight8'. "#EC NOTEXT
CONSTANTS totals_function_custom TYPE zexcel_table_totals_function VALUE 'custom'. "#EC NOTEXT
CONSTANTS builtinstyle_light9 TYPE zexcel_table_style VALUE 'TableStyleLight9'. "#EC NOTEXT
CONSTANTS totals_function_max TYPE zexcel_table_totals_function VALUE 'max'. "#EC NOTEXT
CONSTANTS builtinstyle_light10 TYPE zexcel_table_style VALUE 'TableStyleLight10'. "#EC NOTEXT
CONSTANTS totals_function_min TYPE zexcel_table_totals_function VALUE 'min'. "#EC NOTEXT
CONSTANTS builtinstyle_light11 TYPE zexcel_table_style VALUE 'TableStyleLight11'. "#EC NOTEXT
CONSTANTS totals_function_sum TYPE zexcel_table_totals_function VALUE 'sum'. "#EC NOTEXT
CONSTANTS builtinstyle_light12 TYPE zexcel_table_style VALUE 'TableStyleLight12'. "#EC NOTEXT
DATA fieldcat TYPE zexcel_t_fieldcatalog .
CONSTANTS builtinstyle_light13 TYPE zexcel_table_style VALUE 'TableStyleLight13'. "#EC NOTEXT
CONSTANTS builtinstyle_light14 TYPE zexcel_table_style VALUE 'TableStyleLight14'. "#EC NOTEXT
DATA settings TYPE zexcel_s_table_settings .
CONSTANTS builtinstyle_light15 TYPE zexcel_table_style VALUE 'TableStyleLight15'. "#EC NOTEXT
CONSTANTS builtinstyle_light16 TYPE zexcel_table_style VALUE 'TableStyleLight16'. "#EC NOTEXT
CONSTANTS builtinstyle_light17 TYPE zexcel_table_style VALUE 'TableStyleLight17'. "#EC NOTEXT
CONSTANTS builtinstyle_light18 TYPE zexcel_table_style VALUE 'TableStyleLight18'. "#EC NOTEXT
CONSTANTS builtinstyle_light19 TYPE zexcel_table_style VALUE 'TableStyleLight19'. "#EC NOTEXT
CONSTANTS builtinstyle_light20 TYPE zexcel_table_style VALUE 'TableStyleLight20'. "#EC NOTEXT
CONSTANTS builtinstyle_light21 TYPE zexcel_table_style VALUE 'TableStyleLight21'. "#EC NOTEXT
CONSTANTS builtinstyle_medium1 TYPE zexcel_table_style VALUE 'TableStyleMedium1'. "#EC NOTEXT
CONSTANTS builtinstyle_medium2 TYPE zexcel_table_style VALUE 'TableStyleMedium2'. "#EC NOTEXT
CONSTANTS builtinstyle_medium3 TYPE zexcel_table_style VALUE 'TableStyleMedium3'. "#EC NOTEXT
CONSTANTS builtinstyle_medium4 TYPE zexcel_table_style VALUE 'TableStyleMedium4'. "#EC NOTEXT
CONSTANTS builtinstyle_medium5 TYPE zexcel_table_style VALUE 'TableStyleMedium5'. "#EC NOTEXT
CONSTANTS builtinstyle_medium6 TYPE zexcel_table_style VALUE 'TableStyleMedium6'. "#EC NOTEXT
CONSTANTS builtinstyle_medium7 TYPE zexcel_table_style VALUE 'TableStyleMedium7'. "#EC NOTEXT
CONSTANTS builtinstyle_medium8 TYPE zexcel_table_style VALUE 'TableStyleMedium8'. "#EC NOTEXT
CONSTANTS builtinstyle_medium9 TYPE zexcel_table_style VALUE 'TableStyleMedium9'. "#EC NOTEXT
CONSTANTS builtinstyle_medium10 TYPE zexcel_table_style VALUE 'TableStyleMedium10'. "#EC NOTEXT
CONSTANTS builtinstyle_medium11 TYPE zexcel_table_style VALUE 'TableStyleMedium11'. "#EC NOTEXT
CONSTANTS builtinstyle_medium12 TYPE zexcel_table_style VALUE 'TableStyleMedium12'. "#EC NOTEXT
CONSTANTS builtinstyle_medium13 TYPE zexcel_table_style VALUE 'TableStyleMedium13'. "#EC NOTEXT
CONSTANTS builtinstyle_medium14 TYPE zexcel_table_style VALUE 'TableStyleMedium14'. "#EC NOTEXT
CONSTANTS builtinstyle_medium15 TYPE zexcel_table_style VALUE 'TableStyleMedium15'. "#EC NOTEXT
CONSTANTS builtinstyle_medium16 TYPE zexcel_table_style VALUE 'TableStyleMedium16'. "#EC NOTEXT
CONSTANTS builtinstyle_medium17 TYPE zexcel_table_style VALUE 'TableStyleMedium17'. "#EC NOTEXT
CONSTANTS builtinstyle_medium18 TYPE zexcel_table_style VALUE 'TableStyleMedium18'. "#EC NOTEXT
CONSTANTS builtinstyle_medium19 TYPE zexcel_table_style VALUE 'TableStyleMedium19'. "#EC NOTEXT
CONSTANTS builtinstyle_medium20 TYPE zexcel_table_style VALUE 'TableStyleMedium20'. "#EC NOTEXT
CONSTANTS builtinstyle_medium21 TYPE zexcel_table_style VALUE 'TableStyleMedium21'. "#EC NOTEXT
CONSTANTS builtinstyle_medium22 TYPE zexcel_table_style VALUE 'TableStyleMedium22'. "#EC NOTEXT
CONSTANTS builtinstyle_medium23 TYPE zexcel_table_style VALUE 'TableStyleMedium23'. "#EC NOTEXT
CONSTANTS builtinstyle_medium24 TYPE zexcel_table_style VALUE 'TableStyleMedium24'. "#EC NOTEXT
CONSTANTS builtinstyle_medium25 TYPE zexcel_table_style VALUE 'TableStyleMedium26'. "#EC NOTEXT
CONSTANTS builtinstyle_medium27 TYPE zexcel_table_style VALUE 'TableStyleMedium27'. "#EC NOTEXT
METHODS get_totals_formula
IMPORTING
!ip_column TYPE clike
!ip_function TYPE zexcel_table_totals_function
RETURNING
VALUE(ep_formula) TYPE string
RAISING
zcx_excel .
METHODS has_totals
RETURNING
VALUE(ep_result) TYPE abap_bool .
METHODS set_data
IMPORTING
!ir_data TYPE STANDARD TABLE .
METHODS get_id
RETURNING
VALUE(ov_id) TYPE i .
METHODS set_id
IMPORTING
!iv_id TYPE i .
METHODS get_name
RETURNING
VALUE(ov_name) TYPE string .
METHODS get_reference
IMPORTING
!ip_include_totals_row TYPE abap_bool DEFAULT abap_true
RETURNING
VALUE(ov_reference) TYPE string
RAISING
zcx_excel .
METHODS get_bottom_row_integer
RETURNING
VALUE(ev_row) TYPE i .
METHODS get_right_column_integer
RETURNING
VALUE(ev_column) TYPE i
RAISING
zcx_excel .
*"* protected components of class ZCL_EXCEL_TABLE
*"* do not include other source files here!!!
*"* protected components of class ZCL_EXCEL_TABLE
*"* do not include other source files here!!!
*"* protected components of class ZCL_EXCEL_TABLE
*"* do not include other source files here!!!
PROTECTED SECTION.
PRIVATE SECTION.
DATA id TYPE i .
DATA name TYPE string .
DATA table_data TYPE REF TO data .
DATA builtinstyle_medium28 TYPE zexcel_table_style VALUE 'TableStyleMedium28'. "#EC NOTEXT . . . " .
ENDCLASS.
CLASS zcl_excel_table IMPLEMENTATION.
METHOD get_bottom_row_integer.
DATA: lv_table_lines TYPE i.
FIELD-SYMBOLS: <fs_table> TYPE STANDARD TABLE.
IF settings-bottom_right_row IS NOT INITIAL.
* ev_row = zcl_excel_common=>convert_column2int( settings-bottom_right_row ). " del issue #246
ev_row = settings-bottom_right_row . " ins issue #246
RETURN.
ENDIF.
ASSIGN table_data->* TO <fs_table>.
DESCRIBE TABLE <fs_table> LINES lv_table_lines.
IF lv_table_lines = 0.
lv_table_lines = 1. "table needs at least 1 data row
ENDIF.
ev_row = settings-top_left_row + lv_table_lines.
IF me->has_totals( ) = abap_true." ???? AND ip_include_totals_row = abap_true.
ADD 1 TO ev_row.
ENDIF.
ENDMETHOD.
METHOD get_id.
ov_id = id.
ENDMETHOD.
METHOD get_name.
IF me->name IS INITIAL.
me->name = zcl_excel_common=>number_to_excel_string( ip_value = me->id ).
CONCATENATE 'table' me->name INTO me->name.
ENDIF.
ov_name = me->name.
ENDMETHOD.
METHOD get_reference.
DATA: lv_column TYPE zexcel_cell_column,
lv_table_lines TYPE i,
lv_right_column TYPE zexcel_cell_column_alpha,
ls_field_catalog TYPE zexcel_s_fieldcatalog,
lv_bottom_row TYPE zexcel_cell_row,
lv_top_row_string(10) TYPE c,
lv_bottom_row_string(10) TYPE c.
FIELD-SYMBOLS: <fs_table> TYPE STANDARD TABLE.
*column
lv_column = zcl_excel_common=>convert_column2int( settings-top_left_column ).
lv_table_lines = 0.
LOOP AT fieldcat INTO ls_field_catalog WHERE dynpfld EQ abap_true.
ADD 1 TO lv_table_lines.
ENDLOOP.
lv_column = lv_column + lv_table_lines - 1.
lv_right_column = zcl_excel_common=>convert_column2alpha( lv_column ).
*row
ASSIGN table_data->* TO <fs_table>.
DESCRIBE TABLE <fs_table> LINES lv_table_lines.
IF lv_table_lines = 0.
lv_table_lines = 1. "table needs at least 1 data row
ENDIF.
lv_bottom_row = settings-top_left_row + lv_table_lines .
IF me->has_totals( ) = abap_true AND ip_include_totals_row = abap_true.
ADD 1 TO lv_bottom_row.
ENDIF.
lv_top_row_string = zcl_excel_common=>number_to_excel_string( settings-top_left_row ).
lv_bottom_row_string = zcl_excel_common=>number_to_excel_string( lv_bottom_row ).
CONCATENATE settings-top_left_column lv_top_row_string
':'
lv_right_column lv_bottom_row_string INTO ov_reference.
ENDMETHOD.
METHOD get_right_column_integer.
DATA: ls_field_catalog TYPE zexcel_s_fieldcatalog.
IF settings-bottom_right_column IS NOT INITIAL.
ev_column = zcl_excel_common=>convert_column2int( settings-bottom_right_column ).
RETURN.
ENDIF.
ev_column = zcl_excel_common=>convert_column2int( settings-top_left_column ).
LOOP AT fieldcat INTO ls_field_catalog WHERE dynpfld EQ abap_true.
ADD 1 TO ev_column.
ENDLOOP.
ENDMETHOD.
METHOD get_totals_formula.
CONSTANTS: lc_function_id_sum TYPE string VALUE '109',
lc_function_id_min TYPE string VALUE '105',
lc_function_id_max TYPE string VALUE '104',
lc_function_id_count TYPE string VALUE '103',
lc_function_id_average TYPE string VALUE '101'.
DATA: lv_function_id TYPE string.
CASE ip_function.
WHEN zcl_excel_table=>totals_function_sum.
lv_function_id = lc_function_id_sum.
WHEN zcl_excel_table=>totals_function_min.
lv_function_id = lc_function_id_min.
WHEN zcl_excel_table=>totals_function_max.
lv_function_id = lc_function_id_max.
WHEN zcl_excel_table=>totals_function_count.
lv_function_id = lc_function_id_count.
WHEN zcl_excel_table=>totals_function_average.
lv_function_id = lc_function_id_average.
WHEN zcl_excel_table=>totals_function_custom. " issue #292
RETURN.
WHEN OTHERS.
zcx_excel=>raise_text( 'Invalid totals formula. See ZCL_ for possible values' ).
ENDCASE.
CONCATENATE 'SUBTOTAL(' lv_function_id ',[' ip_column '])' INTO ep_formula.
ENDMETHOD.
METHOD has_totals.
DATA: ls_field_catalog TYPE zexcel_s_fieldcatalog.
ep_result = abap_false.
LOOP AT fieldcat INTO ls_field_catalog.
IF ls_field_catalog-totals_function IS NOT INITIAL.
ep_result = abap_true.
EXIT.
ENDIF.
ENDLOOP.
ENDMETHOD.
METHOD set_data.
DATA lr_temp TYPE REF TO data.
FIELD-SYMBOLS: <lt_table_temp> TYPE ANY TABLE,
<lt_table> TYPE ANY TABLE.
GET REFERENCE OF ir_data INTO lr_temp.
ASSIGN lr_temp->* TO <lt_table_temp>.
CREATE DATA table_data LIKE <lt_table_temp>.
ASSIGN me->table_data->* TO <lt_table>.
<lt_table> = <lt_table_temp>.
ENDMETHOD.
METHOD set_id.
id = iv_id.
ENDMETHOD.
ENDCLASS.