SAP CL_GUI_PROPS_CONSUMER OO Class - Receives Global GUI Props
CL_GUI_PROPS_CONSUMER 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_PROPS_CONSUMER including details of:
- Interface class implementations
- Inheritance details
- Methods defined within class ( including link to full details )
- Attributes ( including initial values )
- Class Events
Interface Implementation
This OO class is an Interface Implementation, which means it will implement its own version of the methods from implementation class IF_GUI_DYNAMIC_DATAMethod list of CL_GUI_PROPS_CONSUMER 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 |
| CLASS_CONSTRUCTOR | Class constructor | Public |
| CALL METHOD cl_gui_props_consumer=>CLASS_CONSTRUCTOR...more details | ||
| CONSTRUCTOR | Constructor | Public |
| CALL METHOD cl_gui_props_consumer=>CONSTRUCTOR...more details | ||
| CREATE_CONSUMER | Internal use! | Public |
| CALL METHOD cl_gui_props_consumer=>CREATE_CONSUMER...more details | ||
| FORCE_DATA_REQUEST_HANDLER | Force CFW Initialization | Private |
| CALL METHOD cl_gui_props_consumer=>FORCE_DATA_REQUEST_HANDLER...more details | ||
| GET_COLORS | Returns the Current Colors | Public |
| CALL METHOD cl_gui_props_consumer=>GET_COLORS...more details | ||
| GET_LIST_DIMENSION | Returns the Current List Dimensions | Public |
| CALL METHOD cl_gui_props_consumer=>GET_LIST_DIMENSION...more details | ||
|
| ||
| GET_METRIC_FACTORS | Internal Use! Conversion Factors of Metrics Supported | Public |
| CALL METHOD cl_gui_props_consumer=>GET_METRIC_FACTORS...more details | ||
| HANDLE_COLOR_CHANGE | Internal Use! Triggers Color Change Event | Public |
| CALL METHOD cl_gui_props_consumer=>HANDLE_COLOR_CHANGE...more details | ||
| HANDLE_LIST_DIM_CHANGE | Internal use! Triggers List-Dim-Change Event | Public |
| CALL METHOD cl_gui_props_consumer=>HANDLE_LIST_DIM_CHANGE...more details | ||
| INIT | Internal Use! | Public |
| CALL METHOD cl_gui_props_consumer=>INIT...more details | ||
| INIT_GUI_DATA | Initialization | Private |
| CALL METHOD cl_gui_props_consumer=>INIT_GUI_DATA...more details | ||
| IS_DATA_AVAILABLE | List Dimension and Colors Available? | Private |
| CALL METHOD cl_gui_props_consumer=>IS_DATA_AVAILABLE...more details | ||
| SET_DEFAULT_FACTORS | Internal use! | Public |
| CALL METHOD cl_gui_props_consumer=>SET_DEFAULT_FACTORS...more details | ||
| SET_METRIC_FACTORS | Internal Use! Conversion Factor Update | Public |
| CALL METHOD cl_gui_props_consumer=>SET_METRIC_FACTORS...more details | ||
| SYNC_GUI_DATA | Forces Update of GUI Data | Public |
| CALL METHOD cl_gui_props_consumer=>SYNC_GUI_DATA...more details | ||
CL_GUI_PROPS_CONSUMER 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 |
| ACTIVEX | Static Attribute | ActiveX? | LIKE SYCHAR01 | Private | |
| CATT_ACTIVE | Static Attribute | Catt? | LIKE SYCHAR01 | Public | |
| COLOR_CONSUMER | Static Attribute | Receives the Colors | LIKE LCL_COLOR_CONSUMER | Private | |
| CONSUMERS | Static Attribute | Consumers | LIKE CONSUMERS_TYPE | Protected | |
| CONTEXT_ID | Static Attribute | Context ID | LIKE EUDB-NAME | Public | |
| FACTORS_CHANGED | Instance Attribute | Change of Factors? | LIKE SYCHAR01 | Private | |
| GUI_IS_RUNNING | Static Attribute | GUI Available? | LIKE SYCHAR01 | Public | |
| IS_INITIALIZED | Static Attribute | Initialized? | LIKE SYCHAR01 | Public | |
| JAVABEAN | Static Attribute | Java-Beans? | LIKE SYCHAR01 | Protected | |
| LIST_DIM_CONSUMER | Static Attribute | Receives List Dimensions | LIKE LCL_LIST_DIM_CONSUMER | Private | |
| METRIC_FACTORS | Static Attribute | Conversion Factors | LIKE CNTL_METRIC_FACTORS | Protected | |
| M_AVAILABLE | Static Attribute | Data Available? | LIKE SYCHAR01 | Private | |
| M_HAS_DATA_REQUEST_HANDLER | Static Attribute | Handler Available? | LIKE SYCHAR01 | Private | |
| WWW_ACTIVE | Static Attribute | WebGui? | LIKE SYCHAR01 | Public |
Events of Class CL_GUI_PROPS_CONSUMER
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... COLOR_CHANGE - Change of the ColorsGLOBAL_PROP_CHANGE - Change of Global GUI Data
GUI_DATA_REQUEST - Internal use! Consumer Requests GUI Data
LIST_DIMENSION_CHANGE - Change of List Dimensions
METRIC_FACTORS_CHANGE - Internal Use! Change of Conversion Factors
CL_GUI_PROPS_CONSUMER types
CONSUMERS_TYPE - CONSUMERS_TYPEONE_CONSUMER_TYPE - ONE_CONSUMER_TYPE
Links to Related Class(s)
CL_GUI_P...Full list of available SAP object classes
Search for further information about these or an SAP related objects