SAP CL_GUI_CFW OO Class - Control Framework Basic Class
CL_GUI_CFW 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_CFW including details of:
- Interface class implementations
- Inheritance details
- Methods defined within class ( including link to full details )
- Attributes ( including initial values )
- Class Events
Method list of CL_GUI_CFW 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 |
| ADD_OBJECT | Internal Use! Registration of CL_GUI_OBJECT for CFW | Public |
| CALL METHOD cl_gui_cfw=>ADD_OBJECT...more details | ||
| CLASS_CONSTRUCTOR | CLASS_CONSTRUCTOR | Public |
| CALL METHOD cl_gui_cfw=>CLASS_CONSTRUCTOR...more details | ||
| CLEANUP_EVENT_STACK | Clean Up Event Stack | Private |
| CALL METHOD cl_gui_cfw=>CLEANUP_EVENT_STACK...more details | ||
| COMPUTE_DYNP_FROM_PIXELS | Internal Use! Calculates Lines/Columns from Pixels | Public |
| CALL METHOD cl_gui_cfw=>COMPUTE_DYNP_FROM_PIXELS...more details | ||
| COMPUTE_EXTENSION_FROM_RATIO | Calculates Extensions from Ratios | Private |
| CALL METHOD cl_gui_cfw=>COMPUTE_EXTENSION_FROM_RATIO...more details | ||
| COMPUTE_METRIC_FROM_DYNP | Internal Use! Calculates Screen Metric from Others | Public |
| CALL METHOD cl_gui_cfw=>COMPUTE_METRIC_FROM_DYNP...more details | ||
|
| ||
| COMPUTE_METRIC_FROM_PIXEL | Internal Use! Calculates Metric Extension from Pixels | Private |
| CALL METHOD cl_gui_cfw=>COMPUTE_METRIC_FROM_PIXEL...more details | ||
| COMPUTE_PIXEL_FROM_METRIC | Internal Use! Calculates Pixel Extension from Other Metrics | Public |
| CALL METHOD cl_gui_cfw=>COMPUTE_PIXEL_FROM_METRIC...more details | ||
| COMPUTE_RATIO_FROM_EXTENSION | Calculates Ratio from Extension | Private |
| CALL METHOD cl_gui_cfw=>COMPUTE_RATIO_FROM_EXTENSION...more details | ||
| DISPATCH | Forward a GUI Event to Proxy Object | Public |
| CALL METHOD cl_gui_cfw=>DISPATCH...more details | ||
| DISPATCH_SYSTEM_EVENTS | Do not use! Forward a GUI Event to a Proxy Object | Public |
| CALL METHOD cl_gui_cfw=>DISPATCH_SYSTEM_EVENTS...more details | ||
| DOCKING_CHANGE_NOTIFY | Internal Use! Docking Handle (Re)Links | Public |
| CALL METHOD cl_gui_cfw=>DOCKING_CHANGE_NOTIFY...more details | ||
| DOCKING_EXTENSIONS | Calculates the Docking Extensions | Private |
| CALL METHOD cl_gui_cfw=>DOCKING_EXTENSIONS...more details | ||
| DYNP_DOCKINGS_INIT | Internal Use Only! Notify Screen of Docking Sizes | Public |
| CALL METHOD cl_gui_cfw=>DYNP_DOCKINGS_INIT...more details | ||
| END_OF_DYNPRO_NOTIFICATION | Only for Kernal! | Public |
| CALL METHOD cl_gui_cfw=>END_OF_DYNPRO_NOTIFICATION...more details | ||
| END_OF_IMODE_NOTIFICATION | Only for Kernal! | Public |
| CALL METHOD cl_gui_cfw=>END_OF_IMODE_NOTIFICATION...more details | ||
| FIRE_CC_CLEANUP | Internal use! Triggers CC-Event | Public |
| CALL METHOD cl_gui_cfw=>FIRE_CC_CLEANUP...more details | ||
| FIRE_CC_INIT | Internal use! Triggers CC-Event | Public |
| CALL METHOD cl_gui_cfw=>FIRE_CC_INIT...more details | ||
| FIRE_FLUSH_ERROR | Do not use! Internal use only! | Public |
| CALL METHOD cl_gui_cfw=>FIRE_FLUSH_ERROR...more details | ||
| FLUSH | Send Buffered Automation Queue to Frontend | Public |
| CALL METHOD cl_gui_cfw=>FLUSH...more details | ||
| GET_CURRENT_EVENT | Returns Current Event Object | Private |
| CALL METHOD cl_gui_cfw=>GET_CURRENT_EVENT...more details | ||
| GET_CURRENT_EVENT_OBJECT | Internal Use! Get Event Object | Public |
| CALL METHOD cl_gui_cfw=>GET_CURRENT_EVENT_OBJECT...more details | ||
| GET_DOCKING_RATIO | Internal Use! Returns Ratio | Public |
| CALL METHOD cl_gui_cfw=>GET_DOCKING_RATIO...more details | ||
| GET_LAST_FOCUS_SHELL | Get Last Focus Shell | Public |
| CALL METHOD cl_gui_cfw=>GET_LAST_FOCUS_SHELL...more details | ||
| GET_LIFETIME_INFO | Internal Use! Returns Lifetime Information | Public |
| CALL METHOD cl_gui_cfw=>GET_LIFETIME_INFO...more details | ||
| GET_LIVING_CONTROL_COUNT | Internal use: Number of controls that call SUBSCRIBE | Public |
| CALL METHOD cl_gui_cfw=>GET_LIVING_CONTROL_COUNT...more details | ||
| GET_LIVING_DYNPRO_CONTROLS | Table of Screen-Specific Controls on Current Screen | Public |
| CALL METHOD cl_gui_cfw=>GET_LIVING_DYNPRO_CONTROLS...more details | ||
| GET_METRIC_FACTORS | Internal Use! Returns Conversion Factors | Public |
| CALL METHOD cl_gui_cfw=>GET_METRIC_FACTORS...more details | ||
| GET_SUBSCRIBER_BY_ID | Internal Use! Shell ID -> CL_GUI_CONTROL | Public |
| CALL METHOD cl_gui_cfw=>GET_SUBSCRIBER_BY_ID...more details | ||
| GUI_DATA_REQUEST | Internal use: GUI data to be sent from frontend | Public |
| CALL METHOD cl_gui_cfw=>GUI_DATA_REQUEST...more details | ||
| HANDLE_DRAGDROP_EVENT | Special Drag&Drop Handling | Private |
| CALL METHOD cl_gui_cfw=>HANDLE_DRAGDROP_EVENT...more details | ||
| HANDLE_FRAMEWORK_EVENT | Non-Control-Related Framework Events | Private |
| CALL METHOD cl_gui_cfw=>HANDLE_FRAMEWORK_EVENT...more details | ||
| HORIZONTAL_RESIZE | Horizontal Resize Event | Private |
| CALL METHOD cl_gui_cfw=>HORIZONTAL_RESIZE...more details | ||
| INVALIDATE_CACHE | Internal Use! Invalidates Cache for Control and Its Subnodes | Public |
| CALL METHOD cl_gui_cfw=>INVALIDATE_CACHE...more details | ||
| IS_ALIVE | Only for Kernal! | Public |
| CALL METHOD cl_gui_cfw=>IS_ALIVE...more details | ||
| IS_CACHE_VALID | Internal Use! Is Cache of Control Valid? | Public |
| CALL METHOD cl_gui_cfw=>IS_CACHE_VALID...more details | ||
| MANAGE_VISIBILITY | Only for Kernal! | Public |
| CALL METHOD cl_gui_cfw=>MANAGE_VISIBILITY...more details | ||
| NOTIFY_BEFORE_FLUSH | Internal Use: Notify Flush Listeners! | Public |
| CALL METHOD cl_gui_cfw=>NOTIFY_BEFORE_FLUSH...more details | ||
| POP_EVENT | Removes an Event from the Event Stack and Sets SYSTEM_STATE | Private |
| CALL METHOD cl_gui_cfw=>POP_EVENT...more details | ||
| PUSH_EVENT | Inserts an Event object into the Stack | Private |
| CALL METHOD cl_gui_cfw=>PUSH_EVENT...more details | ||
| REGISTER_CACHED_CONTROL | Internal Use: Registers a Control to be Cached | Public |
| CALL METHOD cl_gui_cfw=>REGISTER_CACHED_CONTROL...more details | ||
| REGISTER_FLUSH_NOTIFY | Register Flush Notification | Public |
| CALL METHOD cl_gui_cfw=>REGISTER_FLUSH_NOTIFY...more details | ||
| REGISTER_LIFETIME | Internal Use! Registration for Lifetime Management | Public |
| CALL METHOD cl_gui_cfw=>REGISTER_LIFETIME...more details | ||
| REGISTER_SYSTEMEVENTS | Internal Use! Short Cut for System Events | Public |
| CALL METHOD cl_gui_cfw=>REGISTER_SYSTEMEVENTS...more details | ||
| REMOVE_OBJECT | Internal Use! Deregistration of CL_GUI_OBJET in CFW | Public |
| CALL METHOD cl_gui_cfw=>REMOVE_OBJECT...more details | ||
| SET_NEW_OK_CODE | Be Careful: This Sets a new Fcode in Event Handler for PAI | Public |
| CALL METHOD cl_gui_cfw=>SET_NEW_OK_CODE...more details | ||
| SET_VISIBLE_NOTIFICATION | Only for Kernal! | Public |
| CALL METHOD cl_gui_cfw=>SET_VISIBLE_NOTIFICATION...more details | ||
| START | Do Not Use! Framework Initialization | Public |
| CALL METHOD cl_gui_cfw=>START...more details | ||
| STOP | Do Not Use! End Framework | Public |
| CALL METHOD cl_gui_cfw=>STOP...more details | ||
| SUBSCRIBE | Internal Use! Registration of CL_GUI_CONTROL at CFW | Public |
| CALL METHOD cl_gui_cfw=>SUBSCRIBE...more details | ||
| SYNC_DOCKERS | Internal Use! Maintain User Changes to Docker Sizes | Public |
| CALL METHOD cl_gui_cfw=>SYNC_DOCKERS...more details | ||
| UNREGISTER_CACHED_CONTROL | Internal Use! Removes Control from Cache Registration | Public |
| CALL METHOD cl_gui_cfw=>UNREGISTER_CACHED_CONTROL...more details | ||
| UNREGISTER_FLUSH_NOTIFY | Deregister Flush Notification | Public |
| CALL METHOD cl_gui_cfw=>UNREGISTER_FLUSH_NOTIFY...more details | ||
| UNREGISTER_LIFETIME | Called by Free | Public |
| CALL METHOD cl_gui_cfw=>UNREGISTER_LIFETIME...more details | ||
| UNSUBSCRIBE | Internal Use! Deregistration of CL_GUI_COTNROL at CFW | Public |
| CALL METHOD cl_gui_cfw=>UNSUBSCRIBE...more details | ||
| UPDATE_VIEW | Use This Method to Update the View of Your Controls | Public |
| CALL METHOD cl_gui_cfw=>UPDATE_VIEW...more details | ||
| VALIDATE_ALL_CACHES | Internal Use! Validates all Caches | Public |
| CALL METHOD cl_gui_cfw=>VALIDATE_ALL_CACHES...more details | ||
CL_GUI_CFW 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 |
| CACHED_PROPS_CNTLS | Static Attribute | Controls with Cached Properties | LIKE CACHED_PROPS_TYPE | Private | |
| CFW_EVENT_ERROR | Static Attribute | Framework Force a Message | 2 | LIKE I | Private |
| CFW_EVENT_GENERAL | Static Attribute | Framework Data Request Event | 1 | LIKE I | Private |
| CFW_EVENT_HORIZONTAL_RESIZE | Constant | Framework: Resize Handle (Horizontal) | 3 | LIKE I | Private |
| CFW_EVENT_PERSONAS | Static Attribute | Flavor select event | 4 | LIKE I | Private |
| CFW_LIFETIMELIST | Static Attribute | CFW_LIFETIMELIST | LIKE | Private | |
| CFW_MEMBER | Static Attribute | CFW_MEMBER | LIKE TY_CFW_MEMBER | Private | |
| CFW_MEMBERLIST | Static Attribute | CFW_MEMBERLIST | LIKE | Private | |
| CFW_SUBSCRIBER | Static Attribute | CFW_SUBSCRIBER | LIKE TY_CFW_SUBSCRIBER | Private | |
| CFW_SUBSCRIBERLIST | Static Attribute | CFW_SUBSCRIBERLIST | LIKE | Private | |
| CFW_SYSTEMEVENTS | Static Attribute | CFW_SYSTEMEVENTS | LIKE CNTL_EVENTS | Private | |
| DESKTOP_WINDOW | Constant | Desktop | 99 | LIKE I | Public |
| DOCKINGS | Static Attribute | Docking List | LIKE DOCKING_TABLE_TYPE | Private | |
| DOCK_CHANGE_CREATE | Constant | Docking Modification: Create | 1 | LIKE I | Public |
| DOCK_CHANGE_DOCK | Constant | Docking Modification: (Re)Dock | 3 | LIKE I | Public |
| DOCK_CHANGE_EXTENSION | Constant | Docking Modification: Extension | 7 | LIKE I | Public |
| DOCK_CHANGE_FREE | Constant | Docking Modification: Free | 4 | LIKE I | Public |
| DOCK_CHANGE_INVISIBLE | Constant | Docking Modification: Invisible | 5 | LIKE I | Public |
| DOCK_CHANGE_LINK | Constant | Docking Modification: (Re)Link | 2 | LIKE I | Public |
| DOCK_CHANGE_METRIC | Constant | Docking Modification: Metrics | 8 | LIKE I | Public |
| DOCK_CHANGE_VISIBLE | Constant | Docking Modification: Visible | 6 | LIKE I | Public |
| DYNPRO_0 | Constant | Screen 0 | 10 | LIKE I | Public |
| DYNPRO_1 | Constant | Screen 1 | 11 | LIKE I | Public |
| DYNPRO_2 | Constant | Screen 2 | 12 | LIKE I | Public |
| DYNPRO_3 | Constant | Screen 3 | 13 | LIKE I | Public |
| DYNPRO_4 | Constant | Screen 4 | 14 | LIKE I | Public |
| DYNPRO_5 | Constant | Screen 5 | 15 | LIKE I | Public |
| DYNPRO_6 | Constant | Screen 6 | 16 | LIKE I | Public |
| DYNPRO_7 | Constant | Screen 7 | 17 | LIKE I | Public |
| DYNPRO_8 | Constant | Screen 8 | 18 | LIKE I | Public |
| DYNPRO_9 | Constant | Screen 9 | 19 | LIKE I | Public |
| DYNPRO_DEFAULT | Constant | Default Screen | -1 | LIKE I | Public |
| EVENT_STACK | Static Attribute | Event Stack | LIKE EVENT_STCK_TYPE | Private | |
| FALSE | Constant | Boolean Constant | SPACE | LIKE CHAR1 | Public |
| FLUSH_LISTENERS | Static Attribute | Flush Listener | LIKE FLUSH_LISTENERS_TYPE | Private | |
| FLUSH_NOTIFICATION_RUNNING | Static Attribute | Status: Flush Notification Being Sent | LIKE SYCHAR01 | Private | |
| FLUSH_SITUATION_INPUTSTREAM | Constant | Error During Data Input | 2 | LIKE I | Public |
| FLUSH_SITUATION_PBO | Constant | Flush in PBO | 0 | LIKE I | Public |
| FLUSH_SITUATION_SYSTEM_EVENTS | Constant | Flush After System Events | 1 | LIKE I | Public |
| FREE_INTERNAL_CALL | Static Attribute | Internal Communication | LIKE CHAR1 | Private | |
| GUI_DATA_CONSUMER | Static Attribute | Receives Global GUI Data | LIKE CL_GUI_PROPS_CONSUMER | Private | |
| IS_INITIALIZED | Static Attribute | Initial Flag | LIKE CHAR1 | Private | |
| MAIN_WINDOW | Constant | Main Window | 0 | LIKE I | Public |
| MSG_ERR | Constant | Constant | 999 | LIKE SYMSGNO | Public |
| MSG_OK | Constant | Constant | 000 | LIKE SYMSGNO | Public |
| NEW_OK_CODE | Static Attribute | internal field for new_ok_Code | LIKE SYUCOMM | Private | |
| PROPERTY_ALL_PROPS | Constant | Dummy Property: Force Global Properties Being Sent | 1000 | LIKE I | Public |
| RC_FCODE | Constant | dispatchobject new fcode | 2 | LIKE I | Public |
| RC_FOUND | Constant | dispatchobject found | 0 | LIKE I | Public |
| RC_INVALID | Constant | Invalid | -100 | LIKE I | Public |
| RC_NODISPATCH | Constant | dispachtobject not called (wrong time) | 3 | LIKE I | Public |
| RC_NOEVENT | Constant | dispatchobject no event | -1 | LIKE I | Public |
| RC_POSTED | Constant | Posted | -101 | LIKE I | Public |
| RC_UNKNOWN | Constant | dispatchobject unknown | 1 | LIKE I | Public |
| RC_WRONG_STATE | Constant | wrong state | -102 | LIKE I | Public |
| REASON_NO_BATCH | Constant | Reason For Not Working | 5 | LIKE I | Public |
| REASON_NO_GUI | Constant | Reason For Not Working | 6 | LIKE I | Public |
| REASON_NO_INIT | Static Attribute | Reason For Not Working | LIKE I | Public | |
| REDOCK_INITIAL_PIXELS | Constant | Pixel For Horizontal <-> Vertical Redocking | 32 | LIKE I | Private |
| SAVE_OK_CODE | Static Attribute | Internal Field for OK_CODE | LIKE SYUCOMM | Private | |
| SUPP_AREA_SIZE | Static Attribute | Set Support Bit? | LIKE SYCHAR01 | Private | |
| SUPP_XML_BLOBS | Static Attribute | Set Support Bit? | LIKE SYCHAR01 | Private | |
| SYSTEM_STATE | Static Attribute | System_state | LIKE CHAR1 | Public | |
| TOP_WINDOW | Constant | Top | 33 | LIKE I | Public |
| TRUE | Constant | Boolean Constant | 'X' | LIKE CHAR1 | Public |
| VISIBLE_INTERNAL_CALL | Static Attribute | Internal Communication | LIKE CHAR1 | Private |
Events of Class CL_GUI_CFW
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... CC_CLEANUP - Control Composites: Clean UpCC_ON_DYNPRO_LOAD - Control Composites: Initialization
FLUSH_ERROR - Error in Automatic Flush: Handler Must Handle Error
CL_GUI_CFW types
CACHED_PROPS_TYPE - CACHED_PROPS_TYPECACHED_PROP_LINE_TYPE - CACHED_PROP_LINE_TYPE
DOCKING_LINE_TYPE - DOCKING_LINE_TYPE
DOCKING_TABLE_TYPE - DOCKING_TABLE_TYPE
EVENT_STCK_LINE_TYPE - EVENT_STCK_LINE_TYPE
EVENT_STCK_TYPE - EVENT_STCK_TYPE
FLUSH_LISTENERS_TYPE - FLUSH_LISTENERS_TYPE
FLUSH_LISTENER_TYPE - FLUSH_LISTENER_TYPE
TY_CFW_LIFETIME - TY_CFW_LIFETIME
TY_CFW_MEMBER - TY_CFW_MEMBER
TY_CFW_SUBSCRIBER - TY_CFW_SUBSCRIBER
Links to Related Class(s)
CL_GUI_C...Full list of available SAP object classes
Search for further information about these or an SAP related objects