ABAP ALV mit CL_SALV_TABLE: Moderne Tabellenanzeige

kategorie
ABAP-Statements
Veröffentlicht
autor
Johannes

CL_SALV_TABLE ist die moderne objektorientierte API für ALV (ABAP List Viewer). Sie ersetzt die älteren Funktionsbausteine (REUSE_ALV_*) und bietet eine saubere, typisierte Schnittstelle für Tabellenanzeigen.

Grundstruktur

DATA: lo_alv TYPE REF TO cl_salv_table.
TRY.
" ALV erstellen
cl_salv_table=>factory(
IMPORTING r_salv_table = lo_alv
CHANGING t_table = lt_data
).
" Konfiguration...
" Anzeigen
lo_alv->display( ).
CATCH cx_salv_msg INTO DATA(lx_error).
WRITE: / lx_error->get_text( ).
ENDTRY.

Beispiele

1. Einfachste ALV-Anzeige

REPORT z_alv_simple.
TYPES: BEGIN OF ty_customer,
id TYPE i,
name TYPE string,
city TYPE string,
END OF ty_customer.
DATA: lt_customers TYPE TABLE OF ty_customer,
lo_alv TYPE REF TO cl_salv_table.
" Testdaten
lt_customers = VALUE #(
( id = 1 name = 'Müller GmbH' city = 'Berlin' )
( id = 2 name = 'Schmidt AG' city = 'München' )
( id = 3 name = 'Weber KG' city = 'Hamburg' )
).
TRY.
cl_salv_table=>factory(
IMPORTING r_salv_table = lo_alv
CHANGING t_table = lt_customers
).
lo_alv->display( ).
CATCH cx_salv_msg.
ENDTRY.

2. Spalten konfigurieren

DATA: lo_columns TYPE REF TO cl_salv_columns_table,
lo_column TYPE REF TO cl_salv_column.
TRY.
cl_salv_table=>factory(
IMPORTING r_salv_table = lo_alv
CHANGING t_table = lt_customers
).
" Spalten-Objekt holen
lo_columns = lo_alv->get_columns( ).
" Spaltenbreite optimieren
lo_columns->set_optimize( abap_true ).
" Einzelne Spalte konfigurieren
lo_column = lo_columns->get_column( 'ID' ).
lo_column->set_short_text( 'ID' ).
lo_column->set_medium_text( 'Kunden-ID' ).
lo_column->set_long_text( 'Kundennummer' ).
lo_column->set_output_length( 10 ).
lo_column = lo_columns->get_column( 'NAME' ).
lo_column->set_long_text( 'Kundenname' ).
lo_column = lo_columns->get_column( 'CITY' ).
lo_column->set_long_text( 'Stadt' ).
lo_alv->display( ).
CATCH cx_salv_not_found cx_salv_msg.
ENDTRY.

3. Spalte ausblenden

TRY.
lo_column = lo_columns->get_column( 'INTERNAL_FIELD' ).
lo_column->set_visible( abap_false ).
CATCH cx_salv_not_found.
ENDTRY.

4. Toolbar aktivieren

DATA: lo_functions TYPE REF TO cl_salv_functions_list.
" Alle Standardfunktionen aktivieren
lo_functions = lo_alv->get_functions( ).
lo_functions->set_all( abap_true ).
" Oder einzelne Funktionen
lo_functions->set_export_xml( abap_true ).
lo_functions->set_export_spreadsheet( abap_true ).
lo_functions->set_print( abap_true ).
lo_functions->set_find( abap_true ).
lo_functions->set_aggregation( abap_true ).
lo_functions->set_filter( abap_true ).
lo_functions->set_sort_asc( abap_true ).
lo_functions->set_sort_desc( abap_true ).

5. Sortierung setzen

DATA: lo_sorts TYPE REF TO cl_salv_sorts.
lo_sorts = lo_alv->get_sorts( ).
TRY.
" Nach Stadt sortieren (aufsteigend)
lo_sorts->add_sort(
columnname = 'CITY'
position = 1
sequence = if_salv_c_sort=>sort_up
).
" Zweite Sortierung nach Name
lo_sorts->add_sort(
columnname = 'NAME'
position = 2
sequence = if_salv_c_sort=>sort_up
).
CATCH cx_salv_not_found cx_salv_existing cx_salv_data_error.
ENDTRY.

6. Filter setzen

DATA: lo_filters TYPE REF TO cl_salv_filters.
lo_filters = lo_alv->get_filters( ).
TRY.
" Nach Stadt filtern
lo_filters->add_filter(
columnname = 'CITY'
sign = 'I'
option = 'EQ'
low = 'Berlin'
).
CATCH cx_salv_not_found cx_salv_existing cx_salv_data_error.
ENDTRY.

7. Aggregation (Summen)

DATA: lo_aggregations TYPE REF TO cl_salv_aggregations.
lo_aggregations = lo_alv->get_aggregations( ).
TRY.
" Summe für Betrags-Spalte
lo_aggregations->add_aggregation(
columnname = 'AMOUNT'
aggregation = if_salv_c_aggregation=>total
).
" Durchschnitt
lo_aggregations->add_aggregation(
columnname = 'QUANTITY'
aggregation = if_salv_c_aggregation=>average
).
CATCH cx_salv_not_found cx_salv_existing cx_salv_data_error.
ENDTRY.

8. Zebra-Streifen und Layout

DATA: lo_display TYPE REF TO cl_salv_display_settings.
lo_display = lo_alv->get_display_settings( ).
" Zebra-Muster (abwechselnde Zeilenfarben)
lo_display->set_striped_pattern( abap_true ).
" Titel setzen
lo_display->set_list_header( 'Kundenliste' ).
" Horizontale Linien
lo_display->set_horizontal_lines( abap_true ).
" Vertikale Linien
lo_display->set_vertical_lines( abap_true ).

9. Events behandeln (Doppelklick)

" Event-Handler Klasse
CLASS lcl_event_handler DEFINITION.
PUBLIC SECTION.
METHODS: on_double_click
FOR EVENT double_click OF cl_salv_events_table
IMPORTING row column.
METHODS: on_link_click
FOR EVENT link_click OF cl_salv_events_table
IMPORTING row column.
ENDCLASS.
CLASS lcl_event_handler IMPLEMENTATION.
METHOD on_double_click.
" Daten lesen
READ TABLE lt_customers INTO DATA(ls_cust) INDEX row.
IF sy-subrc = 0.
MESSAGE |Doppelklick auf { ls_cust-name }| TYPE 'I'.
ENDIF.
ENDMETHOD.
METHOD on_link_click.
MESSAGE |Link geklickt: Zeile { row }, Spalte { column }| TYPE 'I'.
ENDMETHOD.
ENDCLASS.
" Hauptprogramm
DATA: lo_events TYPE REF TO cl_salv_events_table,
lo_handler TYPE REF TO lcl_event_handler.
TRY.
cl_salv_table=>factory(
IMPORTING r_salv_table = lo_alv
CHANGING t_table = lt_customers
).
" Event-Handler registrieren
lo_events = lo_alv->get_event( ).
lo_handler = NEW #( ).
SET HANDLER lo_handler->on_double_click FOR lo_events.
SET HANDLER lo_handler->on_link_click FOR lo_events.
lo_alv->display( ).
CATCH cx_salv_msg.
ENDTRY.

10. Hotspot (Klickbare Zellen)

TRY.
lo_column = lo_columns->get_column( 'ID' ).
" Spalte als Hotspot (Link) markieren
lo_column->set_cell_type( if_salv_c_cell_type=>hotspot ).
CATCH cx_salv_not_found.
ENDTRY.

11. Farben setzen

TYPES: BEGIN OF ty_colored_line,
id TYPE i,
name TYPE string,
status TYPE c LENGTH 1,
t_color TYPE lvc_t_scol, " Farbinformationen
END OF ty_colored_line.
DATA: lt_data TYPE TABLE OF ty_colored_line,
ls_color TYPE lvc_s_scol.
" Daten mit Farben füllen
lt_data = VALUE #(
( id = 1 name = 'OK' status = 'G' )
( id = 2 name = 'Error' status = 'R' )
( id = 3 name = 'Warning' status = 'Y' )
).
" Farben setzen
LOOP AT lt_data ASSIGNING FIELD-SYMBOL(<ls_line>).
CLEAR ls_color.
ls_color-fname = 'STATUS'.
CASE <ls_line>-status.
WHEN 'G'.
ls_color-color-col = col_positive. " Grün
WHEN 'R'.
ls_color-color-col = col_negative. " Rot
WHEN 'Y'.
ls_color-color-col = col_total. " Gelb
ENDCASE.
APPEND ls_color TO <ls_line>-t_color.
ENDLOOP.
" ALV mit Farben
TRY.
cl_salv_table=>factory(
IMPORTING r_salv_table = lo_alv
CHANGING t_table = lt_data
).
" Farbspalte zuweisen
lo_columns = lo_alv->get_columns( ).
lo_columns->set_color_column( 'T_COLOR' ).
" Farbspalte ausblenden
lo_column = lo_columns->get_column( 'T_COLOR' ).
lo_column->set_visible( abap_false ).
lo_alv->display( ).
CATCH cx_salv_not_found cx_salv_msg.
ENDTRY.

12. Layout speichern/laden

DATA: lo_layout TYPE REF TO cl_salv_layout,
ls_key TYPE salv_s_layout_key.
" Layout-Key definieren
ls_key-report = sy-repid.
lo_layout = lo_alv->get_layout( ).
lo_layout->set_key( ls_key ).
" Benutzer kann Layout speichern
lo_layout->set_save_restriction( if_salv_c_layout=>restrict_none ).
" Standard-Layout
lo_layout->set_default( abap_true ).

13. Eigene Buttons hinzufügen

" Nur in Fullscreen-Modus möglich!
DATA: lo_functions TYPE REF TO cl_salv_functions.
" Status-GUI setzen (für eigene Buttons)
lo_alv->set_screen_status(
pfstatus = 'ZSTATUS'
report = sy-repid
set_functions = lo_alv->c_functions_all
).
" Event-Handler für Benutzerbefehl
CLASS lcl_handler DEFINITION.
PUBLIC SECTION.
METHODS: on_user_command
FOR EVENT added_function OF cl_salv_events
IMPORTING e_salv_function.
ENDCLASS.
CLASS lcl_handler IMPLEMENTATION.
METHOD on_user_command.
CASE e_salv_function.
WHEN 'ZREFRESH'.
" Daten aktualisieren
refresh_data( ).
lo_alv->refresh( ).
WHEN 'ZEXPORT'.
" Eigener Export
export_data( ).
ENDCASE.
ENDMETHOD.
ENDCLASS.
" Handler registrieren
DATA: lo_events TYPE REF TO cl_salv_events.
lo_events = lo_alv->get_event( ).
SET HANDLER lo_handler->on_user_command FOR lo_events.

14. ALV in Container (Screen)

" Für Screen-Programmierung
DATA: lo_container TYPE REF TO cl_gui_custom_container.
" Container erstellen (im Screen: Custom Control 'CC_ALV')
lo_container = NEW #( container_name = 'CC_ALV' ).
TRY.
" ALV in Container
cl_salv_table=>factory(
EXPORTING r_container = lo_container
IMPORTING r_salv_table = lo_alv
CHANGING t_table = lt_data
).
" Konfiguration...
lo_alv->display( ).
CATCH cx_salv_msg.
ENDTRY.

15. Daten aktualisieren (Refresh)

" Daten wurden geändert
lt_customers = VALUE #(
( id = 1 name = 'Neu' city = 'Berlin' )
( id = 2 name = 'Aktualisiert' city = 'München' )
).
" ALV aktualisieren
lo_alv->refresh( ).
" Mit Scroll-Position beibehalten
lo_alv->refresh(
s_stable = VALUE lvc_s_stbl( row = abap_true col = abap_true )
).

16. Editierbares ALV

" Leider nicht direkt mit CL_SALV_TABLE möglich!
" Für editierbare ALV: CL_GUI_ALV_GRID verwenden
" Workaround: Nach Display Daten aus Tabelle lesen
" (Tabelle wurde als CHANGING übergeben)

17. Export-Funktionen

DATA: lo_functions TYPE REF TO cl_salv_functions_list.
lo_functions = lo_alv->get_functions( ).
" Excel-Export aktivieren
lo_functions->set_export_spreadsheet( abap_true ).
" XML-Export
lo_functions->set_export_xml( abap_true ).
" Alle Export-Optionen
lo_functions->set_group_export( abap_true ).

18. Komplettes Beispiel

REPORT z_alv_complete.
TYPES: BEGIN OF ty_order,
order_id TYPE i,
customer TYPE string,
amount TYPE p DECIMALS 2,
currency TYPE waers,
order_date TYPE d,
status TYPE c LENGTH 1,
END OF ty_order.
DATA: lt_orders TYPE TABLE OF ty_order,
lo_alv TYPE REF TO cl_salv_table.
CLASS lcl_handler DEFINITION.
PUBLIC SECTION.
METHODS: on_double_click
FOR EVENT double_click OF cl_salv_events_table
IMPORTING row column.
ENDCLASS.
CLASS lcl_handler IMPLEMENTATION.
METHOD on_double_click.
READ TABLE lt_orders INTO DATA(ls_order) INDEX row.
IF sy-subrc = 0.
MESSAGE |Bestellung { ls_order-order_id }: { ls_order-amount } { ls_order-currency }| TYPE 'I'.
ENDIF.
ENDMETHOD.
ENDCLASS.
START-OF-SELECTION.
" Testdaten
lt_orders = VALUE #(
( order_id = 1001 customer = 'Müller' amount = '1500.00' currency = 'EUR' order_date = '20241101' status = 'A' )
( order_id = 1002 customer = 'Schmidt' amount = '2300.50' currency = 'EUR' order_date = '20241105' status = 'A' )
( order_id = 1003 customer = 'Weber' amount = '890.00' currency = 'EUR' order_date = '20241110' status = 'O' )
( order_id = 1004 customer = 'Bauer' amount = '3200.00' currency = 'EUR' order_date = '20241112' status = 'A' )
( order_id = 1005 customer = 'Klein' amount = '450.75' currency = 'EUR' order_date = '20241115' status = 'X' )
).
TRY.
" ALV erstellen
cl_salv_table=>factory(
IMPORTING r_salv_table = lo_alv
CHANGING t_table = lt_orders
).
" Toolbar aktivieren
DATA(lo_functions) = lo_alv->get_functions( ).
lo_functions->set_all( abap_true ).
" Spalten konfigurieren
DATA(lo_columns) = lo_alv->get_columns( ).
lo_columns->set_optimize( abap_true ).
DATA(lo_col_id) = lo_columns->get_column( 'ORDER_ID' ).
lo_col_id->set_long_text( 'Bestellnummer' ).
lo_col_id->set_cell_type( if_salv_c_cell_type=>hotspot ).
DATA(lo_col_cust) = lo_columns->get_column( 'CUSTOMER' ).
lo_col_cust->set_long_text( 'Kunde' ).
DATA(lo_col_amt) = lo_columns->get_column( 'AMOUNT' ).
lo_col_amt->set_long_text( 'Betrag' ).
DATA(lo_col_date) = lo_columns->get_column( 'ORDER_DATE' ).
lo_col_date->set_long_text( 'Bestelldatum' ).
" Summe für Betrag
DATA(lo_agg) = lo_alv->get_aggregations( ).
lo_agg->add_aggregation( columnname = 'AMOUNT' aggregation = if_salv_c_aggregation=>total ).
" Sortierung
DATA(lo_sorts) = lo_alv->get_sorts( ).
lo_sorts->add_sort( columnname = 'ORDER_DATE' sequence = if_salv_c_sort=>sort_down ).
" Display-Settings
DATA(lo_display) = lo_alv->get_display_settings( ).
lo_display->set_striped_pattern( abap_true ).
lo_display->set_list_header( 'Bestellübersicht' ).
" Events
DATA(lo_events) = lo_alv->get_event( ).
DATA(lo_handler) = NEW lcl_handler( ).
SET HANDLER lo_handler->on_double_click FOR lo_events.
" Anzeigen
lo_alv->display( ).
CATCH cx_salv_msg cx_salv_not_found cx_salv_existing cx_salv_data_error INTO DATA(lx_error).
WRITE: / lx_error->get_text( ).
ENDTRY.

Wichtige Klassen

KlasseBeschreibung
CL_SALV_TABLEHaupt-ALV-Klasse
CL_SALV_COLUMNS_TABLESpaltensammlung
CL_SALV_COLUMNEinzelne Spalte
CL_SALV_FUNCTIONS_LISTToolbar-Funktionen
CL_SALV_DISPLAY_SETTINGSAnzeigeeinstellungen
CL_SALV_SORTSSortierungen
CL_SALV_FILTERSFilter
CL_SALV_AGGREGATIONSAggregationen
CL_SALV_EVENTS_TABLEEvent-Handling
CL_SALV_LAYOUTLayout-Verwaltung

Wichtige Hinweise / Best Practice

  • CL_SALV_TABLE ist die moderne ALV-API – bevorzugen Sie sie gegenüber REUSE_ALV*.
  • factory() erstellt das ALV-Objekt – CHANGING für die Datentabelle.
  • Spaltenoptimierung mit set_optimize( abap_true ) für automatische Breiten.
  • Toolbar mit get_functions( )->set_all( abap_true ) aktivieren.
  • Events über SET HANDLER registrieren.
  • Hotspots machen Zellen klickbar (set_cell_type).
  • Farben erfordern eine Farbspalte vom Typ LVC_T_SCOL.
  • Editierbar nur mit CL_GUI_ALV_GRID möglich.
  • Container für Screen-Integration verwenden.
  • Layout ermöglicht Benutzern, ihre Einstellungen zu speichern.