ABAP OO Class Methods

CL_GUI_OBJECT SAP Class - Proxy Class for a GUI Object







CL_GUI_OBJECT 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_OBJECT including details of:

  • Interface class implementations
  • Inheritance details
  • Methods defined within class ( including link to full details )
  • Attributes ( including initial values )
  • Class Events

Also check out the Resources section below to view useful tips, screenshots, links and general information related to this SAP class and its methods, or even add your own for future reference.


Interface class implementations

This OO class has an interface implementation which means it has access to all methods within the interface class. Here are the interface classes for CL_GUI_OBJECT
IF_CACHED_PROP



Methods of CL_GUI_OBJECT







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 CL_ABAP_CHAR_UTILITIES=>methodname EXPORTING/IMPORTING...



ADD_CACHE_PROP - Add new Cached Property
ASSIGN_PROPERTY - Assign_Property
CALL_METHOD - Call_Method
CALL_METHOD_RESULT_GUI_OBJECT - Call Method rc=GUI_OBJECT, You can Check Obj. With IS_VALID
CLASS_CONSTRUCTOR - CLASS_CONSTRUCTOR
CLASS_INIT - Additional External Class Constructor
CONSTRUCTOR - Constructor
FREE - Destructor
GET_CACHE_PROP - Read Value of a Cache Property
GET_PROPERTY - Get_Property
GET_PROPERTY_GUI_OBJECT - GetProperty rc=GUI_OBJECT, You Can Check obj With 'IS_VALID'
INVALIDATE_CACHE - Invalidates the Cache
IS_CACHED_PROP - Property Managed in Cache?
IS_CACHE_VALID - Query: Is the Cache Valid for this Control?
IS_VALID - Check If a GUI_OBJECT Represents a Valid Frontend Object
REMOVE_CACHE_PROP - Remove Cached Property from Cache
SET_CACHE_PROP - Write Value of a Cache Property
SET_PROPERTY - Set_Property
VALIDATE_CACHE - Validates the Cache


CL_GUI_OBJECT Attributes

List of attributes within class CL_GUI_OBJECT. These can be referenced using the following syntax CL_GUI_OBJECT=>. Although depending on where you are inserting the ABAP code you do need to check if the attribute is public or private.


NameDescriptionInitial Value
ACTIVEX X: ActiveX to be called
CATT_ACTIV X: CATT is Running
CONTROLS_SUPPORTED Used for Background Check
GLOBAL_GUID GUID for ABAP Objects Controls
GUI_DATA_CONSUMER Receives Global GUI Data
GUI_IS_RUNNING X: GUI is running
H_CONTROL H_CONTROL
H_GUI R, FUGR CNTL
INIT_STATE Initialization Status
INIT_STATE_FINAL Final Initialization 2
INIT_STATE_PRELIMINARY Preliminary Initialization 1
IS_INIT R, FUGR CNTL
JAVABEAN X: JavaBean to be called
M_CLSID Class ID
PROPERTY_CACHE Cache for Datachange Properties
PROP_CACHE_CURSOR Current Cursor in Propcache
PROP_CACHE_SUPPORTED Cache Supported by Platform?
WWW_ACTIVE X: Web is Active
XML_BLOB_SUPPORT DIAG XML Blob supported




Events of the Class CL_GUI_OBJECT

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...