SAP ABAP Class CL_GUI_OBJECT (Proxy Class for a GUI Object)
Hierarchy
SAP_BASIS (Software Component) SAP Basis Component
   BC-FES-GUI (Application Component) Graphical User Interface
     SCET (Package) Control Enabling Technology / Control Framework
Meta Relationship - Using
# Relationship type Using Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  IF_CACHED_PROP Access to Cached Property Implementation 19990417
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Inheritance (c INHERITING FROM c_ref)  CL_FORMPAINTER_BASEWINDOW SAP Form Painter Window Base Class 19990914
2 Inheritance (c INHERITING FROM c_ref)  CL_GUI_CONTROL Proxy Class for Control in GUI 00000000
3 Inheritance (c INHERITING FROM c_ref)  CL_GUI_ECL_MATRIX Represents a Complete Data Type with 13 Floats 19991124
4 Inheritance (c INHERITING FROM c_ref)  CL_GUI_FRONTEND_SERVICES Frontend Services 00000000
5 Inheritance (c INHERITING FROM c_ref)  CL_GUI_RESOURCES GUI Resources (Fonts, Colors, ...) 19990218
6 Inheritance (c INHERITING FROM c_ref)  CL_IOS_GUIPROXY INTERNAL: Proxyobjects of Frontendclasses 20040503
7 Inheritance (c INHERITING FROM c_ref)  CL_IOS_JGPROXY INTERNAL USE 20040616
8 Inheritance (c INHERITING FROM c_ref)  CL_KW_AUTOMATION_OBJECT For Internal Use 19991220
9 Inheritance (c INHERITING FROM c_ref)  CL_TABLEPAINTER_BASETABLE SAP Table Painter Table Base Class 20000315
10 Inheritance (c INHERITING FROM c_ref)  C_OI_AUTOMATION_OBJECT For Internal Use 00000000
Properties
Class CL_GUI_OBJECT  
Short Description Proxy Class for a GUI Object    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status S  System Program 
Category 0   
Package SCET   Control Enabling Technology / Control Framework 
Created 19981013   SAP 
Last change 20130531   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 CNTL Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
2 OLE2 Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
Interfaces
# Interface Abstract Final Description Created on
1 IF_CACHED_PROP Access to Cached Property Implementation 19990417
Friends
Class CL_GUI_OBJECT has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 ACTIVEX Static Attribute Public Type reference (TYPE) CHAR01 X: ActiveX to be called 19990506
2 CATT_ACTIV Static Attribute Public Type reference (TYPE) CHAR01 X: CATT is Running 20000107
3 CONTROLS_SUPPORTED Static Attribute Protected Type reference (TYPE) CHAR1 Used for Background Check 19990120
4 GLOBAL_GUID Static Attribute Protected Type reference (TYPE) I GUID for ABAP Objects Controls 19981116
5 GUI_DATA_CONSUMER Static Attribute Private Object reference (TYPE REF TO) OBJECT Receives Global GUI Data 19991206
6 GUI_IS_RUNNING Static Attribute Public Type reference (TYPE) CHAR01 X: GUI is running 19991122
7 H_CONTROL Instance attribute Protected Type reference (TYPE) CNTL_HANDLE H_CONTROL 19981019
8 H_GUI Static Attribute Public Type reference (TYPE) OLE2_OBJECT R, FUGR CNTL 19981116
9 INIT_STATE Static Attribute Private Type reference (TYPE) I Initialization Status 19991206
10 INIT_STATE_FINAL Constant Private Type reference (TYPE) I 2 Final Initialization 19991206
11 INIT_STATE_PRELIMINARY Constant Private Type reference (TYPE) I 1 Preliminary Initialization 19991206
12 IS_INIT Static Attribute Public Type reference (TYPE) CHAR1 R, FUGR CNTL 19981116
13 JAVABEAN Static Attribute Public Type reference (TYPE) CHAR01 X: JavaBean to be called 19990506
14 M_CLSID Instance attribute Protected Type reference (TYPE) CHAR255 Class ID 19991105
15 PROPERTY_CACHE Instance attribute Private Type reference (TYPE) TY_PROPCACHE Cache for Datachange Properties 19990416
16 PROP_CACHE_CURSOR Instance attribute Private Type reference (TYPE) I Current Cursor in Propcache 19990416
17 PROP_CACHE_SUPPORTED Static Attribute Protected Type reference (TYPE) CHAR01 Cache Supported by Platform? 19990416
18 WWW_ACTIVE Static Attribute Public Type reference (TYPE) CHAR01 X: Web is Active 19990625
19 XML_BLOB_SUPPORT Static Attribute Protected Type reference (TYPE) CHAR01 DIAG XML Blob supported 19990503
Methods
# Method Level Visibility Method type Description Created on
1 ADD_CACHE_PROP Instance method Protected Method Add new Cached Property 19990416
2 ASSIGN_PROPERTY Instance method Protected Method Assign_Property 19981013
3 CALL_METHOD Instance method Protected Method Call_Method 19981013
4 CALL_METHOD_RESULT_GUI_OBJECT Instance method Protected Method Call Method rc=GUI_OBJECT, You can Check Obj. With IS_VALID 19981130
5 CLASS_CONSTRUCTOR Static method Public Constructor CLASS_CONSTRUCTOR 19981116
6 CLASS_INIT Static method Private Method Additional External Class Constructor 19991206
7 CONSTRUCTOR Instance method Public Constructor Constructor 19981013
8 FREE Instance method Public Method Destructor 19981013
9 GET_CACHE_PROP Instance method Protected Method Read Value of a Cache Property 19990416
10 GET_PROPERTY Instance method Protected Method Get_Property 19981013
11 GET_PROPERTY_GUI_OBJECT Instance method Protected Method GetProperty rc=GUI_OBJECT, You Can Check obj With 'IS_VALID' 19981130
12 INVALIDATE_CACHE Instance method Protected Method Invalidates the Cache 19991117
13 IS_CACHED_PROP Instance method Protected Method Property Managed in Cache? 19990416
14 IS_CACHE_VALID Instance method Protected Method Query: Is the Cache Valid for this Control? 19991117
15 IS_VALID Instance method Public Method Check If a GUI_OBJECT Represents a Valid Frontend Object 19981218
16 REMOVE_CACHE_PROP Instance method Protected Method Remove Cached Property from Cache 19990416
17 SET_CACHE_PROP Instance method Protected Method Write Value of a Cache Property 19990416
18 SET_PROPERTY Instance method Protected Method Set_Property 19981013
19 VALIDATE_CACHE Instance method Private Method Validates the Cache 19991117
Events
Class CL_GUI_OBJECT has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 TY_PROPCACHE Private See coding PropertyCache for DataChangePropagation 19990416
2 TY_PROPCACHEENTRY Private See coding Entry in Property Cache 19990416
Method Signatures

Method ADD_CACHE_PROP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing PROPNAME Call by reference Type reference (TYPE) STRING Name der Property 19990416
# Exception Resumable Description Created on
1 CACHE_NOT_INIT Cache ist nicht verfügbar 19990416
2 INVALID_NAME Ungültiger Namen 19990416
3 PROP_ALREADY_DEFINED Property ist bereits im Cache deklariert 19990416

Method ASSIGN_PROPERTY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing FROM_OBJ Call by reference Object reference (TYPE REF TO) CL_GUI_OBJECT Quell-Objekt 19981019
2 Importing FROM_PROPERTY Value transfer Type reference (TYPE) C Name der Quell-Property 19981019
3 Importing PROPERTY Value transfer Type reference (TYPE) C Name der Property 19981019
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19981019
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 19981019

Method CALL_METHOD Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing KEEP_CACHE Call by reference Type reference (TYPE) CHAR01 Darf der Cacheinhalt weiterhin verwendet werden ? 19990512
2 Importing METHOD Value transfer Type reference (TYPE) C Name 19981016
3 Importing P1 Call by reference Type reference (TYPE) ANY Parameter 19981016
4 Importing P10 Call by reference Type reference (TYPE) ANY Parameter 19981016
5 Importing P11 Call by reference Type reference (TYPE) ANY Parameter 19981016
6 Importing P12 Call by reference Type reference (TYPE) ANY Parameter 19981016
7 Importing P13 Call by reference Type reference (TYPE) ANY Parameter 19981016
8 Importing P14 Call by reference Type reference (TYPE) ANY Parameter 19981016
9 Importing P15 Call by reference Type reference (TYPE) ANY Parameter 19981016
10 Importing P16 Call by reference Type reference (TYPE) ANY Parameter 19981016
11 Importing P2 Call by reference Type reference (TYPE) ANY Parameter 19981016
12 Importing P3 Call by reference Type reference (TYPE) ANY Parameter 19981016
13 Importing P4 Call by reference Type reference (TYPE) ANY Parameter 19981016
14 Importing P5 Call by reference Type reference (TYPE) ANY Parameter 19981016
15 Importing P6 Call by reference Type reference (TYPE) ANY Parameter 19981016
16 Importing P7 Call by reference Type reference (TYPE) ANY Parameter 19981016
17 Importing P8 Call by reference Type reference (TYPE) ANY Parameter 19981016
18 Importing P9 Call by reference Type reference (TYPE) ANY Parameter 19981016
19 Importing P_COUNT Value transfer Type reference (TYPE) I Anzahl gültige Parameter 19981016
20 Importing QUEUE_ONLY Value transfer Type reference (TYPE) C 'X' Queue_Only Verwendung von RESULT 19981016
21 Exporting RESULT Call by reference Type reference (TYPE) ANY Ergebnis des Aufrufs 19981016
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19981019
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 19981019

Method CALL_METHOD_RESULT_GUI_OBJECT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing METHOD Value transfer Type reference (TYPE) C Name 19981130
2 Importing P1 Call by reference Type reference (TYPE) ANY Parameter 19981130
3 Importing P10 Call by reference Type reference (TYPE) ANY Parameter 19981130
4 Importing P11 Call by reference Type reference (TYPE) ANY Parameter 19981130
5 Importing P12 Call by reference Type reference (TYPE) ANY Parameter 19981130
6 Importing P13 Call by reference Type reference (TYPE) ANY Parameter 19981130
7 Importing P14 Call by reference Type reference (TYPE) ANY Parameter 19981130
8 Importing P15 Call by reference Type reference (TYPE) ANY Parameter 19981130
9 Importing P16 Call by reference Type reference (TYPE) ANY Parameter 19981130
10 Importing P2 Call by reference Type reference (TYPE) ANY Parameter 19981130
11 Importing P3 Call by reference Type reference (TYPE) ANY Parameter 19981130
12 Importing P4 Call by reference Type reference (TYPE) ANY Parameter 19981130
13 Importing P5 Call by reference Type reference (TYPE) ANY Parameter 19981130
14 Importing P6 Call by reference Type reference (TYPE) ANY Parameter 19981130
15 Importing P7 Call by reference Type reference (TYPE) ANY Parameter 19981130
16 Importing P8 Call by reference Type reference (TYPE) ANY Parameter 19981130
17 Importing P9 Call by reference Type reference (TYPE) ANY Parameter 19981130
18 Importing P_COUNT Value transfer Type reference (TYPE) I Anzahl gültige Parameter 19981130
19 Importing QUEUE_ONLY Value transfer Type reference (TYPE) C 'X' Queue_Only Verwendung von RESULT 19981130
20 Importing RESULT_AS_GUI_OBJECT Value transfer Object reference (TYPE REF TO) CL_GUI_OBJECT Ergebnis des Aufrufs 19981130
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19981130
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 19981130

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_GUI_OBJECT has no parameter.
Method CLASS_CONSTRUCTOR on class CL_GUI_OBJECT has no exception.

Method CLASS_INIT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RCODE Value transfer Type reference (TYPE) I Returncode 19991206

Method CLASS_INIT on class CL_GUI_OBJECT has no exception.

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CLSID Value transfer Type reference (TYPE) C Class-Id 19981019
2 Importing LIFETIME Value transfer Type reference (TYPE) I Lebensdauer 19981019
# Exception Resumable Description Created on
1 CREATE_ERROR CREATE_ERROR 19981019
2 LIFETIME_ERROR LIFETIME_ERROR 19981019

Method FREE Signature

Method FREE on class CL_GUI_OBJECT has no parameter.
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19981019
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 19981019

Method GET_CACHE_PROP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing PROPNAME Call by reference Type reference (TYPE) STRING Name der Property 19990416
2 Exporting PROPVALUE Call by reference Type reference (TYPE) STRING Wert der Property 19990416
# Exception Resumable Description Created on
1 CACHE_NOT_INIT Cache ist nicht verfügbar 19990416
2 INVALID_NAME Ungültiger Name 19990416
3 PROP_INVALID Der Wert ist nicht gültig 19990416
4 PROP_NOT_FOUND Property ist nicht im Cache deklariert 19990416

Method GET_PROPERTY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing P1 Call by reference Type reference (TYPE) ANY Parameter 19981013
2 Importing P10 Call by reference Type reference (TYPE) ANY Parameter 19981013
3 Importing P11 Call by reference Type reference (TYPE) ANY Parameter 19981013
4 Importing P12 Call by reference Type reference (TYPE) ANY Parameter 19981013
5 Importing P13 Call by reference Type reference (TYPE) ANY Parameter 19981013
6 Importing P14 Call by reference Type reference (TYPE) ANY Parameter 19981013
7 Importing P15 Call by reference Type reference (TYPE) ANY Parameter 19981013
8 Importing P16 Call by reference Type reference (TYPE) ANY Parameter 19981013
9 Importing P2 Call by reference Type reference (TYPE) ANY Parameter 19981013
10 Importing P3 Call by reference Type reference (TYPE) ANY Parameter 19981013
11 Importing P4 Call by reference Type reference (TYPE) ANY Parameter 19981013
12 Importing P5 Call by reference Type reference (TYPE) ANY Parameter 19981013
13 Importing P6 Call by reference Type reference (TYPE) ANY Parameter 19981013
14 Importing P7 Call by reference Type reference (TYPE) ANY Parameter 19981013
15 Importing P8 Call by reference Type reference (TYPE) ANY Parameter 19981013
16 Importing P9 Call by reference Type reference (TYPE) ANY Parameter 19981013
17 Importing PROPERTY Value transfer Type reference (TYPE) C Name 19981013
18 Importing P_COUNT Value transfer Type reference (TYPE) I Anzahl gültige Parameter 19981013
19 Importing QUEUE_ONLY Value transfer Type reference (TYPE) C 'X' Queue_Only usage of VALUE 19981014
20 Exporting VALUE Call by reference Type reference (TYPE) ANY Wert 19981013
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19981013
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 19981013

Method GET_PROPERTY_GUI_OBJECT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing P1 Call by reference Type reference (TYPE) ANY Parameter 19981130
2 Importing P10 Call by reference Type reference (TYPE) ANY Parameter 19981130
3 Importing P11 Call by reference Type reference (TYPE) ANY Parameter 19981130
4 Importing P12 Call by reference Type reference (TYPE) ANY Parameter 19981130
5 Importing P13 Call by reference Type reference (TYPE) ANY Parameter 19981130
6 Importing P14 Call by reference Type reference (TYPE) ANY Parameter 19981130
7 Importing P15 Call by reference Type reference (TYPE) ANY Parameter 19981130
8 Importing P16 Call by reference Type reference (TYPE) ANY Parameter 19981130
9 Importing P2 Call by reference Type reference (TYPE) ANY Parameter 19981130
10 Importing P3 Call by reference Type reference (TYPE) ANY Parameter 19981130
11 Importing P4 Call by reference Type reference (TYPE) ANY Parameter 19981130
12 Importing P5 Call by reference Type reference (TYPE) ANY Parameter 19981130
13 Importing P6 Call by reference Type reference (TYPE) ANY Parameter 19981130
14 Importing P7 Call by reference Type reference (TYPE) ANY Parameter 19981130
15 Importing P8 Call by reference Type reference (TYPE) ANY Parameter 19981130
16 Importing P9 Call by reference Type reference (TYPE) ANY Parameter 19981130
17 Importing PROPERTY Value transfer Type reference (TYPE) C Name 19981130
18 Importing P_COUNT Value transfer Type reference (TYPE) I Anzahl gültige Parameter 19981130
19 Importing QUEUE_ONLY Value transfer Type reference (TYPE) C 'X' Queue_Only usage of VALUE 19981130
20 Importing VALUE_AS_GUI_OBJECT Value transfer Object reference (TYPE REF TO) CL_GUI_OBJECT Wert 19981130
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19981130
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 19981130

Method INVALIDATE_CACHE Signature

Method INVALIDATE_CACHE on class CL_GUI_OBJECT has no parameter.
Method INVALIDATE_CACHE on class CL_GUI_OBJECT has no exception.

Method IS_CACHED_PROP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning IS_IN_CACHE Value transfer Type reference (TYPE) CHAR01 'X', wenn im Cache Verwaltet 19990416
2 Importing PROPNAME Call by reference Type reference (TYPE) STRING Name der Property 19990416
# Exception Resumable Description Created on
1 CACHE_NOT_INIT Cache ist nicht verfügbar 19990416

Method IS_CACHE_VALID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning VALID Value transfer Type reference (TYPE) CHAR01 X: gültig SPACE: nicht gültig 19991117

Method IS_CACHE_VALID on class CL_GUI_OBJECT has no exception.

Method IS_VALID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting RESULT Value transfer Type reference (TYPE) I 0: not valid, 1: valid 19981218

Method IS_VALID on class CL_GUI_OBJECT has no exception.

Method REMOVE_CACHE_PROP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing PROPNAME Call by reference Type reference (TYPE) STRING Name der Property 19990416
# Exception Resumable Description Created on
1 CACHE_NOT_INIT Cache ist nicht verfügbar 19990416
2 INVALID_NAME Ungültiger Namen 19990416
3 PROP_NOT_FOUND Property ist nicht im Cache deklariert 19990416

Method SET_CACHE_PROP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing PROPNAME Call by reference Type reference (TYPE) STRING Name der Property 19990416
2 Importing PROPVALUE Call by reference Type reference (TYPE) STRING Wert der Property 19990416
# Exception Resumable Description Created on
1 CACHE_NOT_INIT Cache ist nicht verfügbar 19990416
2 INVALID_NAME Ungültiger Propertyname 19990416
3 PROP_NOT_FOUND Property ist nicht im Cahce deklariert 19990416

Method SET_PROPERTY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing KEEP_CACHE Call by reference Type reference (TYPE) CHAR01 Darf der Cacheinhalt weiterhin verwendet werden ? 19990511
2 Importing P1 Call by reference Type reference (TYPE) ANY Parameter 19981013
3 Importing P10 Call by reference Type reference (TYPE) ANY Parameter 19981013
4 Importing P11 Call by reference Type reference (TYPE) ANY Parameter 19981013
5 Importing P12 Call by reference Type reference (TYPE) ANY Parameter 19981013
6 Importing P13 Call by reference Type reference (TYPE) ANY Parameter 19981013
7 Importing P14 Call by reference Type reference (TYPE) ANY Parameter 19981013
8 Importing P15 Call by reference Type reference (TYPE) ANY Parameter 19981013
9 Importing P16 Call by reference Type reference (TYPE) ANY Parameter 19981013
10 Importing P2 Call by reference Type reference (TYPE) ANY Parameter 19981013
11 Importing P3 Call by reference Type reference (TYPE) ANY Parameter 19981013
12 Importing P4 Call by reference Type reference (TYPE) ANY Parameter 19981013
13 Importing P5 Call by reference Type reference (TYPE) ANY Parameter 19981013
14 Importing P6 Call by reference Type reference (TYPE) ANY Parameter 19981013
15 Importing P7 Call by reference Type reference (TYPE) ANY Parameter 19981013
16 Importing P8 Call by reference Type reference (TYPE) ANY Parameter 19981013
17 Importing P9 Call by reference Type reference (TYPE) ANY Parameter 19981013
18 Importing PROPERTY Value transfer Type reference (TYPE) C Name 19981013
19 Importing P_COUNT Value transfer Type reference (TYPE) I Anzahl gültige Parameter 19981013
20 Importing VALUE Call by reference Type reference (TYPE) ANY Neuer Wert 19981013
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19981013
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 19981013

Method VALIDATE_CACHE Signature

Method VALIDATE_CACHE on class CL_GUI_OBJECT has no parameter.
Method VALIDATE_CACHE on class CL_GUI_OBJECT has no exception.
History
Last changed by/on SAP  20130531 
SAP Release Created in