SAP CL_GUI_ECATT_PARAMS OO Class - eCATT: Parameter Editor
CL_GUI_ECATT_PARAMS is a standard SAP object class available within R/3 SAP systems depending on your version and release level. You can view/maintain the class details by entering its name into the relevant SAP transactions such as SE24, SE80 or even SE84. Below is the documentation available for class CL_GUI_ECATT_PARAMS including details of:
- Interface class implementations
- Inheritance details
- Methods defined within class ( including link to full details )
- Attributes ( including initial values )
- Class Events
Inheritance
This OO class has a superclass assigned to it, which means it will inherit its objects and methods. The superclass for CL_GUI_ECATT_PARAMS is CL_GUI_ECATT_DATAMethod list of CL_GUI_ECATT_PARAMS SAP class
A method is a coding block that performs a certain procedure (i.e. ABAP functionality) on an object within the overall SAP class. In simple terms if the object is an SAP database table a method could be the procedure to add a record or to delete a record. If you are new to OO in many respects, the implementation of a method is similar to a function module and can be called in a very similar way using CALL METHOD.
Instead of "CALL FUNCTION", Methods are referenced using the following syntax: CALL METHOD =>methodname EXPORTING/IMPORTING...
| Method Name | Description | Visability |
| CONSTRUCTOR | Constructor | Public |
| CALL METHOD cl_gui_ecatt_params=>CONSTRUCTOR...more details | ||
| DELETE_PARAM_USAGELOCATION | Deletes parameter if usage location is available | Private |
| CALL METHOD cl_gui_ecatt_params=>DELETE_PARAM_USAGELOCATION...more details | ||
| GET_PARAMS | Get Parameters from Middleware Object | Protected |
| CALL METHOD cl_gui_ecatt_params=>GET_PARAMS...more details | ||
| GET_PARAM_FROM_ROWID | Get Parameter for RowID | Protected |
| CALL METHOD cl_gui_ecatt_params=>GET_PARAM_FROM_ROWID...more details | ||
| GET_PARAM_PREF_NAME2 | Get Strings Abbreviated in Grid from Middleware | Protected |
| CALL METHOD cl_gui_ecatt_params=>GET_PARAM_PREF_NAME2...more details | ||
| GET_PARAM_REFERENCE_F4 | F4 Help for Dictionary Objects | Protected |
| CALL METHOD cl_gui_ecatt_params=>GET_PARAM_REFERENCE_F4...more details | ||
|
| ||
| GET_PARAM_STRING_VALUE | Get strings shortened in grid from middleware | Protected |
| CALL METHOD cl_gui_ecatt_params=>GET_PARAM_STRING_VALUE...more details | ||
| GET_SELECTED_PARAMS | Returns the Parameter/Command Interface Selected in ALV Grid | Public |
| CALL METHOD cl_gui_ecatt_params=>GET_SELECTED_PARAMS...more details | ||
| ON_F4_INTERNAL_ABAP_TYPE | F4 Input Help for Predefined ABAP Types | Protected |
| CALL METHOD cl_gui_ecatt_params=>ON_F4_INTERNAL_ABAP_TYPE...more details | ||
| ON_F4_PARAM_TYPE | F4 Value Help for Visibility of Parameter | Protected |
| CALL METHOD cl_gui_ecatt_params=>ON_F4_PARAM_TYPE...more details | ||
| ON_PARAMS_CHANGED | Parameters Changed | Protected |
| CALL METHOD cl_gui_ecatt_params=>ON_PARAMS_CHANGED...more details | ||
| ON_PARAM_REF_CHANGED | Parameter Reference Changed | Protected |
| CALL METHOD cl_gui_ecatt_params=>ON_PARAM_REF_CHANGED...more details | ||
| ON_PARAM_VAL_CHANGED | Value Container of Parameter Changed | Protected |
| CALL METHOD cl_gui_ecatt_params=>ON_PARAM_VAL_CHANGED...more details | ||
| ON_QUERY_CHANGE_PNAME | If Parameter Name Should Be Changed | Protected |
| CALL METHOD cl_gui_ecatt_params=>ON_QUERY_CHANGE_PNAME...more details | ||
| ON_QUERY_DELETE_PARAM | Parameter Is to Be Deleted | Protected |
| CALL METHOD cl_gui_ecatt_params=>ON_QUERY_DELETE_PARAM...more details | ||
| ON_QUERY_ERR_CHANGE_REF | Error During Parameter Reference Change - Terminate? | Protected |
| CALL METHOD cl_gui_ecatt_params=>ON_QUERY_ERR_CHANGE_REF...more details | ||
| RAISE_EV_PARAM_DOUBLE_CLICK | Raise Event PARAM_DOUBLE_CLICK | Public |
| CALL METHOD cl_gui_ecatt_params=>RAISE_EV_PARAM_DOUBLE_CLICK...more details | ||
| SET_DATA_TO_GRID | Set Data in ALV Grid | Public |
| CALL METHOD cl_gui_ecatt_params=>SET_DATA_TO_GRID...more details | ||
| SET_ECATT_OBJECT | Set eCATT Object | Public |
| CALL METHOD cl_gui_ecatt_params=>SET_ECATT_OBJECT...more details | ||
| SET_ECATT_OBJ_START_DATA | Private | |
| CALL METHOD cl_gui_ecatt_params=>SET_ECATT_OBJ_START_DATA...more details | ||
| SET_FIELDCAT_OLD | Set Field Catalog OLD! OLD! OLD! OLD! OLD! OLD! | Private |
| CALL METHOD cl_gui_ecatt_params=>SET_FIELDCAT_OLD...more details | ||
| SET_OUTTAB_HANDLSTYLE | Set Outtab Line and Its Ready-for-Input Status | Protected |
| CALL METHOD cl_gui_ecatt_params=>SET_OUTTAB_HANDLSTYLE...more details | ||
| SET_PARAMS | Set Parameter Changes in Middleware Object | Protected |
| CALL METHOD cl_gui_ecatt_params=>SET_PARAMS...more details | ||
| SET_PARAM_PREF_NAME2 | Note Index for Long PREF_NAME2 in Web Dynpro | Protected |
| CALL METHOD cl_gui_ecatt_params=>SET_PARAM_PREF_NAME2...more details | ||
| SET_PARAM_STRING_VALUE | Note Index for Long Strings (Values) | Protected |
| CALL METHOD cl_gui_ecatt_params=>SET_PARAM_STRING_VALUE...more details | ||
| SET_USAGE_LOCATION | Gets usage location | Private |
| CALL METHOD cl_gui_ecatt_params=>SET_USAGE_LOCATION...more details | ||
| UC_CHECK | Parameter Display | Protected |
| CALL METHOD cl_gui_ecatt_params=>UC_CHECK...more details | ||
| UC_COPY_PARAM | Copy parameters | Protected |
| CALL METHOD cl_gui_ecatt_params=>UC_COPY_PARAM...more details | ||
| UC_CREATE_FROM_TEMPLATE | Create Parameter with Template | Protected |
| CALL METHOD cl_gui_ecatt_params=>UC_CREATE_FROM_TEMPLATE...more details | ||
| UC_DELETE_PARAM | Delete Parameter | Protected |
| CALL METHOD cl_gui_ecatt_params=>UC_DELETE_PARAM...more details | ||
| UC_DELETE_VALUE | Delete Parameter Value | Protected |
| CALL METHOD cl_gui_ecatt_params=>UC_DELETE_VALUE...more details | ||
| UC_PARAM_VALUE | Maintain Parameter Value | Protected |
| CALL METHOD cl_gui_ecatt_params=>UC_PARAM_VALUE...more details | ||
| UC_REFRESH | Refresh Parameter Display | Protected |
| CALL METHOD cl_gui_ecatt_params=>UC_REFRESH...more details | ||
| UC_SORT | Sort Parameters | Protected |
| CALL METHOD cl_gui_ecatt_params=>UC_SORT...more details | ||
| UC_TOGGLE_PARAMS_CMDIF | Toggle Between Parameters and Command Interface | Protected |
| CALL METHOD cl_gui_ecatt_params=>UC_TOGGLE_PARAMS_CMDIF...more details | ||
| UC_WHEREUSED | Where-Used List for Parameter | Public |
| CALL METHOD cl_gui_ecatt_params=>UC_WHEREUSED...more details | ||
CL_GUI_ECATT_PARAMS attributes
List of attributes within class CL_ABAP_CHAR_UTILITIES. These can be referenced using the following syntax CL_ABAP_CHAR_UTILITIES=>. Although depending on where you are inserting the ABAP code you do need to check if the attribute is public or private.
| Name | Level | Description | Initial Value | Type | Visability |
| ADAPT_DELETE | Instance Attribute | Function Code that Triggered PAI | LIKE SYUCOMM | Private | |
| AS_SELECTED_ROWID | Instance Attribute | ALV control: Line Description | LIKE LVC_S_ROW | Private | |
| CO_STRUCTURE_NAME | Constant | Structure for ALVGRID | 'ETPAR_GUI_C' | LIKE TABNAME | Protected |
| ECATT_OBJECT | Instance Attribute | eCATT Object | LIKE CL_APL_ECATT_OBJECT | Protected | |
| ECATT_OBJ_START_DATA | Instance Attribute | eCATT Object - Start Profile Data | LIKE CL_APL_ECATT_START_DATA | Protected | |
| FC_AUTOPAR | Constant | FC: Parameter Auto | 'AUTOPAR' | LIKE SYUCOMM | Protected |
| FC_COPY_PARAM | Constant | FC: Copy Parameter | 'COPY_PARAM' | LIKE SYUCOMM | Protected |
| FC_CREATE_FROM_TEMPLATE | Constant | FC: Create with Template | 'CREATE_FROM_TEMPLATE' | LIKE SYUCOMM | Private |
| FC_DELETE_PARAM | Constant | FC: Delete Parameter | 'DELETE_PARAM' | LIKE SYUCOMM | Protected |
| FC_DELETE_VALUE | Constant | FC: Delete Parameter Value | 'DELETE_PARAM_VALUE' | LIKE SYUCOMM | Protected |
| FC_PARAM_VALUE | Constant | FC: Display Parameter Value | 'PARAM_VALUE' | LIKE SYUCOMM | Protected |
| FC_REFRESH | Constant | FC: Refresh Parameter Display | 'REFRESH' | LIKE SYUCOMM | Protected |
| FC_SORT_PARAMS_ASC | Constant | FC: Sort Parameters Ascending | 'SORT_PARAMS_ASC' | LIKE SYUCOMM | Protected |
| FC_SORT_PARAMS_DSC | Constant | FC: Sort Parameters Descending | 'SORT_PARAMS_DSC' | LIKE SYUCOMM | Protected |
| FC_TOGGLE_PARAMS_CMDIF | Constant | FC: Toggle Between Parameters and CMDIF | 'TOGGLE_PARAMS_CMDIF' | LIKE SYUCOMM | Private |
| FIELDCAT_CMDIF | Instance Attribute | Field Catalog for Command Interface Display | LIKE LVC_T_FCAT | Private | |
| FIELDCAT_PARAM | Instance Attribute | Field Catalog for Parameter Display | LIKE LVC_T_FCAT | Protected | |
| GT_MESSAGES | Instance Attribute | eCATT: Table Type for Checklist | LIKE ETCHECKLST_TABTYPE | Private | |
| GT_OUTTAB | Instance Attribute | Saved Output Table for the Parameter | LIKE ETPAR_OUT_TABTYPE | Protected | |
| INDEX_FOR_LONG_PREF_NAME2 | Instance Attribute | eCATT: Parameter Index | LIKE ETPINDEX_TABTYPE | Protected | |
| INDEX_FOR_LONG_VALUES | Instance Attribute | eCATT: Parameter Index | LIKE ETPINDEX_TABTYPE | Protected | |
| MAX_VALUE_LENGTH | Instance Attribute | Length of Values in the OUTTAB | 128 | LIKE I | Protected |
| OUTTAB | Instance Attribute | Current Parameter Output Table | LIKE ETPAR_OUT_TABTYPE | Protected | |
| RECENT_PARAMS_VIEW | Instance Attribute | Special View of Parameter Use | LIKE ETPARVIEW | Protected | |
| SELECTED_OUTTAB | Instance Attribute | Selected Outtab Rows | LIKE ETPAR_OUT_TABTYPE | Protected | |
| SELECTED_ROWS | Instance Attribute | Selected Rows | LIKE LVC_T_ROW | Protected | |
| WA_OUTTAB | Instance Attribute | Parameter Output Structure | LIKE ETPAR_OUT | Protected |
Events of Class CL_GUI_ECATT_PARAMS
Events are created within your class using special event handler methods. These must be registered at runtime for the event and can then be triggered using the ABAP syntax: RAISE EVENT EXPOTING... EV_PARAMS_DROPPED - Drop in Parameter ExecutedEV_PARAMS_REFRESHED - Parameter Display Refreshed
EV_PARAMS_SORTED - Parameters Were Resorted
EV_PARAM_DOUBLE_CLICK - Parameter Double-Clicked
EV_PARAM_REF_CHANGED - Parameter Reference Changed
EV_PARAM_VAL_CHANGED - Values of Structured Parameter Changed
EV_TOGGLE_PARAMS_CMDIF - Toggle Between Parameter and Command Interfaces
EV_VALUE_DELETED - Parameter Value Deleted
EV_WHERE_USED - Where-Used List Parameter Requested
Links to Related Class(s)
CL_GUI_E...Full list of available SAP object classes
Search for further information about these or an SAP related objects