SAP ABAP Class /XNFE/CL_ALV_CONFIG (Base NFE Auxiliary Class for ALV Configuration)
Hierarchy
SLL-NFE (Software Component) xNFE
   SLL-NFE-MGM (Application Component) NF-e: Communication Management & Monitoring
     /XNFE/USICORE (Package) User Interface of Core Components (NF-e and CT-e)
Meta Relationship - Using
# Relationship type Using Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  /XNFE/IF_WD_ALV_CONFIG Configuration Interface 20111010
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Inheritance (c INHERITING FROM c_ref)  /XNFE/CL_ALV_CONFIG_DYN Action-Specific NFE Auxiliary Class for ALV Configuration 20110712
2 Inheritance (c INHERITING FROM c_ref)  /XNFE/CL_ALV_CONFIG_STAT Non-Action-Specific NFE Auxiliary Class for ALV Config. 20110715
Properties
Class /XNFE/CL_ALV_CONFIG  
Short Description Base NFE Auxiliary Class for ALV Configuration    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package /XNFE/USICORE   User Interface of Core Components (NF-e and CT-e) 
Created 20110712   SAP 
Last change 20141107    
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 /XNFE/CL_ALV_CONFIG Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
2 /XNFE/IF_ALV_CONFIG Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
3 ABAP Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
Interfaces
# Interface Abstract Final Description Created on
1 /XNFE/IF_WD_ALV_CONFIG Configuration Interface 20111010
Friends
Class /XNFE/CL_ALV_CONFIG has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 MT_COLUMNS Instance attribute Protected Type reference (TYPE) /XNFE/IF_ALV_CONFIG=>T_COLUMNS Utilized Table Columns 20110712
2 MT_CONFIGURATIONS Static Attribute Protected Type reference (TYPE) /XNFE/CL_ALV_CONFIG=>T_CONFIG Table with ALV COnfigurations 20110712
3 MT_FUNCTIONS Instance attribute Protected Type reference (TYPE) /XNFE/IF_ALV_CONFIG=>T_FUNCTIONS Self-Defined Functions 20110712
Methods
# Method Level Visibility Method type Description Created on
1 CHECK_CONFIG_IS_ACTIVE Instance method Protected Method Is the desired configuration the current one? 20110712
2 CHECK_INIT_CONFIGURATION Instance method Protected Method Set Current Configuration as Active Configuration 20110713
3 CREATE_BUTTON Instance method Public Method Create Action Button 20110712
4 CREATE_BUTTON_CHOICE Instance method Public Method Create Group of Action Buttons 20110712
5 CREATE_INPUT_FIELD Instance method Public Method Create Input Field (Including Label) 20110902
6 CREATE_MENU Instance method Public Method Create Menu Item Beneath a Selection 20110712
7 GET_COLUMNS Instance method Protected Method Return Columns for a Configuration 20110715
8 GET_CONFIG Instance method Protected Method Read Configuration 20110810
9 GET_FIELDS Instance method Protected Method Return DDIC Structure Fields for Current ALV 20110712
10 GET_FUNCTIONS Instance method Protected Method Return Utilized ALV Functions 20110715
11 HIDE_ALV_STD_FUNCTIONS Instance method Public Method Hide ALV Standard Functions (PDF, Export, Views) 20110712
12 INITIALIZE_COLUMNS Instance method Protected Method Initialize Columns 20110712
13 INITIALIZE_FUNCTIONS Instance method Protected Method Initialize All Self-Defined Actions on the ALV 20110712
14 INITIALIZE_TABLE Instance method Protected Method Initialize General Table Settings 20140404
15 RELOAD_VIEW Instance method Protected Method Initialization of User Views of ALV 20140423
16 RENDER_COLUMNS Instance method Protected Method Provide Required Columns 20110712
17 RENDER_FUNCTIONS Instance method Protected Method Provide Self-Defined Actions 20110712
18 SET_ACTIVE_CONFIGURATION Instance method Protected Method Set Current Configuration as Active Configuration 20110712
19 SET_TABLE_HEADER Instance method Public Method Set Headers for a Table 20110712
Events
Class /XNFE/CL_ALV_CONFIG has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 S_ALV_CONFIG Public See coding Internal Structure with Reference to ALV Configuration Class 20110926 begin of s_alv_config, name type char30, alv_config type ref to /xnfe/if_wd_alv_config, end of s_alv_config
2 S_CONFIG Protected See coding Internal Structure for ALV Configuration 20110712 begin of S_CONFIG, usage_name type char30, usage type ref to if_wd_component_usage, model type ref to cl_salv_wd_config_table, interface type ref to iwci_salv_wd_table, proctyp type /xnfe/proctyp, procstep type /xnfe/proc_step, application type char30, initialized type abap_bool, active type abap_bool, exit type ref to /xnfe/if_alv_config, exit_class type char30, config type ref to /xnfe/if_wd_alv_config, columns type /xnfe/wd_alv_columns_t, functions type /xnfe/wd_alv_functions_t, end of s_config
3 T_ALV_CONFIG Public See coding 20110926 t_alv_config type standard table of s_alv_config
4 T_CONFIG Protected See coding Internal Tables for ALV Configurations 20110712 t_config type standard table of s_config
Method Signatures

Method CHECK_CONFIG_IS_ACTIVE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_PROCSTEP Call by reference Type reference (TYPE) /XNFE/PROC_STEP NF-e Incoming Prozessschritte 20110712
2 Importing IV_PROCTYP Call by reference Type reference (TYPE) /XNFE/PROCTYP Prozesstyp 20110712
3 Importing IV_USAGE_NAME Call by reference Type reference (TYPE) CHAR21 Name der ALV Einbettung 20110715
4 Returning RV_ACTIVE Value transfer Type reference (TYPE) ABAP_BOOL Gewünschte Konfig ist aktiv 20110712
# Exception Resumable Description Created on
1 ERROR_LOADING_CONFIG Fehler beim Laden der Konfiguration 20110810

Method CHECK_INIT_CONFIGURATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_PROCSTEP Call by reference Type reference (TYPE) /XNFE/PROC_STEP Process Step (ID) 20110713
2 Importing IV_PROCTYP Call by reference Type reference (TYPE) /XNFE/PROCTYP Prozesstyp 20110713
3 Importing IV_USAGE_NAME Call by reference Type reference (TYPE) CHAR21 Name de ALV Einbettung 20110715
4 Returning RV_INITIALIZED Value transfer Type reference (TYPE) ABAP_BOOL Ist die Konfiguration bereits initialisiert? 20110713

Method CHECK_INIT_CONFIGURATION on class /XNFE/CL_ALV_CONFIG has no exception.

Method CREATE_BUTTON Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ENABLED Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20110712
2 Importing IV_TEXT Call by reference Type reference (TYPE) STRING 20110712
3 Importing IV_TOOLTIP Call by reference Type reference (TYPE) STRING 20110712
4 Returning RR_BUTTON Value transfer Object reference (TYPE REF TO) CL_SALV_WD_FE_BUTTON Button in der Toolbar 20110712

Method CREATE_BUTTON on class /XNFE/CL_ALV_CONFIG has no exception.

Method CREATE_BUTTON_CHOICE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ENABLED Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20110712
2 Importing IV_TEXT Call by reference Type reference (TYPE) STRING 20110712
3 Importing IV_TOOLTIP Call by reference Type reference (TYPE) STRING 20110712
4 Returning RR_CHOICE Value transfer Object reference (TYPE REF TO) CL_SALV_WD_FE_BUTTON_CHOICE ButtonChoice in der Toolbar 20110712

Method CREATE_BUTTON_CHOICE on class /XNFE/CL_ALV_CONFIG has no exception.

Method CREATE_INPUT_FIELD Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_CTX_PATH Call by reference Type reference (TYPE) STRING Pfad für Contextbinding 20110902
2 Importing IV_LABEL Call by reference Type reference (TYPE) STRING Label zum Eingabefeld 20110902
3 Importing IV_LABEL_TOOLTIP Call by reference Type reference (TYPE) STRING Tooltip zum Label (falls abweichend) 20110902
4 Returning RR_INPUT_FIELD Value transfer Object reference (TYPE REF TO) CL_SALV_WD_FE_INPUT_FIELD Eingabefeld in der Toolbar 20110902

Method CREATE_INPUT_FIELD on class /XNFE/CL_ALV_CONFIG has no exception.

Method CREATE_MENU Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_CHOICE Call by reference Object reference (TYPE REF TO) CL_SALV_WD_FE_BUTTON_CHOICE ButtonChoice in der Toolbar 20110712
2 Importing IV_ACTION_ID Call by reference Type reference (TYPE) STRING 20110712
3 Importing IV_ENABLED Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20110712
4 Importing IV_TEXT Call by reference Type reference (TYPE) STRING 20110712
5 Returning RR_MENU_ITEM Value transfer Object reference (TYPE REF TO) CL_SALV_WD_MENU_ACTION_ITEM Menüaktion in der Liste eines ButtonChoice der Toolbar 20110712

Method CREATE_MENU on class /XNFE/CL_ALV_CONFIG has no exception.

Method GET_COLUMNS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_APPL_NAME Call by reference Type reference (TYPE) CHAR30 Name der WD Anwendung 20110810
2 Importing IV_PROCSTEP Call by reference Type reference (TYPE) /XNFE/PROC_STEP B2B Incoming: Process Step (ID) 20110810
3 Importing IV_PROCTYP Call by reference Type reference (TYPE) /XNFE/PROCTYP Prozesstyp 20110810
4 Importing IV_USAGE_NAME Call by reference Type reference (TYPE) CHAR21 Name des ALV 20110715
5 Returning RT_COLUMNS Value transfer Type reference (TYPE) /XNFE/WD_ALV_COLUMNS_T WD Hilfstabellentyp für ALV Spalten 20110715
# Exception Resumable Description Created on
1 ERROR_LOADING_CONFIG Fehler beim Laden der Konfiguration 20110810

Method GET_CONFIG Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ES_CONFIG Call by reference Type reference (TYPE) /XNFE/CL_ALV_CONFIG=>S_CONFIG Interne Struktur für ALV Konfiguration 20110810
2 Exporting EV_INDEX Call by reference Type reference (TYPE) SY-TABIX Index interner Tabellen 20110810
3 Importing IV_APPL_NAME Call by reference Type reference (TYPE) CHAR30 Name der WD Anwendung 20110810
4 Importing IV_PROCSTEP Call by reference Type reference (TYPE) /XNFE/PROC_STEP B2B Incoming: Process Step (ID) 20110810
5 Importing IV_PROCTYP Call by reference Type reference (TYPE) /XNFE/PROCTYP Prozesstyp 20110810
6 Importing IV_USAGE_NAME Call by reference Type reference (TYPE) CHAR21 Name der ALV Einbettung 20110810
# Exception Resumable Description Created on
1 ERROR_LOADING_CONFIG Fehler beim Laden der Konfiguration 20110810

Method GET_FIELDS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_APPL_NAME Call by reference Type reference (TYPE) CHAR30 Name der WD Anwendung 20110810
2 Importing IV_PROCSTEP Call by reference Type reference (TYPE) /XNFE/PROC_STEP B2B Incoming: Process Step (ID) 20110810
3 Importing IV_PROCTYP Call by reference Type reference (TYPE) /XNFE/PROCTYP Prozesstyp 20110810
4 Importing IV_USAGE_NAME Call by reference Type reference (TYPE) CHAR21 Name der ALV Einbettung 20110715
5 Returning RT_FIELDS Value transfer Type reference (TYPE) SALV_WD_T_FIELD_REF SALV_WD_T_FIELD_REF 20110712
# Exception Resumable Description Created on
1 ERROR_LOADING_CONFIG Fehler beim Laden der Konfiguration 20110810

Method GET_FUNCTIONS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_APPL_NAME Call by reference Type reference (TYPE) CHAR30 Name der WD Anwendung 20110810
2 Importing IV_PROCSTEP Call by reference Type reference (TYPE) /XNFE/PROC_STEP B2B Incoming: Process Step (ID) 20110810
3 Importing IV_PROCTYP Call by reference Type reference (TYPE) /XNFE/PROCTYP Prozesstyp 20110810
4 Importing IV_USAGE_NAME Call by reference Type reference (TYPE) CHAR21 Name der ALV Einbettung 20110715
5 Returning RT_FUNCTIONS Value transfer Type reference (TYPE) /XNFE/WD_ALV_FUNCTIONS_T WD Hilfstabellentyp für ALV Funktionen 20110715
# Exception Resumable Description Created on
1 ERROR_LOADING_CONFIG Fehler beim Laden der Konfiguration 20110810

Method HIDE_ALV_STD_FUNCTIONS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_MODEL Call by reference Object reference (TYPE REF TO) CL_SALV_WD_CONFIG_TABLE Konfiguration der ALV-Ausgabe 20110719
2 Importing IV_HIDE_FILTER Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Aktion 'Filter einblenden' unterdrücken 20110822
3 Importing IV_HIDE_SORTING Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Aktion 'Sortierung' unterdrücken 20110822
4 Importing IV_SHOW_EXPORT Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Aktion Export z.B. als Excel verfügbar machen 20110715
5 Importing IV_SHOW_PDF Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Aktion Download als PDF verfügbar 20110715
6 Importing IV_SHOW_VIEW_LOAD Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE Aktion Sichten verfügbar machen 20110715

Method HIDE_ALV_STD_FUNCTIONS on class /XNFE/CL_ALV_CONFIG has no exception.

Method INITIALIZE_COLUMNS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_APPL_NAME Call by reference Type reference (TYPE) CHAR30 Name der WD Anwendung 20110810
2 Importing IV_PROCSTEP Call by reference Type reference (TYPE) /XNFE/PROC_STEP B2B Incoming: Process Step (ID) 20110810
3 Importing IV_PROCTYP Call by reference Type reference (TYPE) /XNFE/PROCTYP Prozesstyp 20110810
4 Importing IV_USAGE_NAME Call by reference Type reference (TYPE) CHAR21 Name der ALV Einbettung 20110715
# Exception Resumable Description Created on
1 ERROR_LOADING_CONFIG Fehler beim Laden der Konfiguration 20110810

Method INITIALIZE_FUNCTIONS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_APPL_NAME Call by reference Type reference (TYPE) CHAR30 Name der WD Anwendung 20110810
2 Importing IV_PROCSTEP Call by reference Type reference (TYPE) /XNFE/PROC_STEP B2B Incoming: Process Step (ID) 20110810
3 Importing IV_PROCTYP Call by reference Type reference (TYPE) /XNFE/PROCTYP Prozesstyp 20110810
4 Importing IV_USAGE_NAME Call by reference Type reference (TYPE) CHAR21 Name der ALV Einbettung 20110715
# Exception Resumable Description Created on
1 ERROR_LOADING_CONFIG Fehler beim Laden der Konfiguration 20110810

Method INITIALIZE_TABLE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_APPL_NAME Call by reference Type reference (TYPE) CHAR30 Name der WD Anwendung 20140404
2 Importing IV_PROCSTEP Call by reference Type reference (TYPE) /XNFE/PROC_STEP B2B Incoming: Process Step (ID) 20140404
3 Importing IV_PROCTYP Call by reference Type reference (TYPE) /XNFE/PROCTYP Prozesstyp 20140404
4 Importing IV_USAGE_NAME Call by reference Type reference (TYPE) CHAR21 Name der ALV Einbettung 20140404
# Exception Resumable Description Created on
1 ERROR_LOADING_CONFIG Fehler beim Laden der Konfiguration 20140404

Method RELOAD_VIEW Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_APPL_NAME Call by reference Type reference (TYPE) CHAR30 Name der WD Anwendung 20140423
2 Importing IV_PROCSTEP Call by reference Type reference (TYPE) /XNFE/PROC_STEP B2B Incoming: Process Step (ID) 20140423
3 Importing IV_PROCTYP Call by reference Type reference (TYPE) /XNFE/PROCTYP Prozesstyp 20140423
4 Importing IV_USAGE_NAME Call by reference Type reference (TYPE) CHAR21 Name der ALV Einbettung 20140423
# Exception Resumable Description Created on
1 ERROR_LOADING_CONFIG Fehler beim Laden der Konfiguration 20140423

Method RENDER_COLUMNS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_APPL_NAME Call by reference Type reference (TYPE) CHAR30 Name der WD Anwendung 20110810
2 Importing IV_PROCSTEP Call by reference Type reference (TYPE) /XNFE/PROC_STEP B2B Incoming: Process Step (ID) 20110810
3 Importing IV_PROCTYP Call by reference Type reference (TYPE) /XNFE/PROCTYP Prozesstyp 20110810
4 Importing IV_USAGE_NAME Call by reference Type reference (TYPE) CHAR21 Name der ALV Einbettung 20110715
# Exception Resumable Description Created on
1 ERROR_LOADING_CONFIG Fehler beim Laden der Konfiguration 20110810

Method RENDER_FUNCTIONS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_APPL_NAME Call by reference Type reference (TYPE) CHAR30 Name der WD Anwendung 20110810
2 Importing IV_PROCSTEP Call by reference Type reference (TYPE) /XNFE/PROC_STEP B2B Incoming: Process Step (ID) 20110810
3 Importing IV_PROCTYP Call by reference Type reference (TYPE) /XNFE/PROCTYP Prozesstyp 20110810
4 Importing IV_USAGE_NAME Call by reference Type reference (TYPE) CHAR21 Name der ALV Einbettung 20110715
# Exception Resumable Description Created on
1 ERROR_LOADING_CONFIG Fehler beim Laden der Konfiguration 20110810

Method SET_ACTIVE_CONFIGURATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_PROCSTEP Call by reference Type reference (TYPE) /XNFE/PROC_STEP Process Step (ID) 20110712
2 Importing IV_PROCTYP Call by reference Type reference (TYPE) /XNFE/PROCTYP Prozesstyp 20110712
3 Importing IV_USAGE_NAME Call by reference Type reference (TYPE) CHAR21 Name der ALV Einbettung 20110715
# Exception Resumable Description Created on
1 ERROR_LOADING_CONFIG Fehler beim Laden der Konfiguration 20110810

Method SET_TABLE_HEADER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_TABLE_SETTINGS Call by reference Object reference (TYPE REF TO) IF_SALV_WD_TABLE_SETTINGS Einstellungen zur gesamten ALV-Ausgabe 20110712
2 Importing IV_ACC_DESCR Call by reference Type reference (TYPE) STRING Accessibility Beschreibung der Tabelle 20110712
3 Importing IV_TEXT Call by reference Type reference (TYPE) STRING Tabellenüberschrift 20110712
4 Importing IV_TOOLTIP Call by reference Type reference (TYPE) STRING Tooltip zur Tabellenüberschrift 20110712

Method SET_TABLE_HEADER on class /XNFE/CL_ALV_CONFIG has no exception.
History
Last changed by/on SAP  20141107 
SAP Release Created in 900