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
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 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) | |
| 2 | 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 | Static Attribute | Public | Type reference (TYPE) | CHAR01 | X: ActiveX to be called | 19990506 | |||
| 2 | Static Attribute | Public | Type reference (TYPE) | CHAR01 | X: CATT is Running | 20000107 | |||
| 3 | Static Attribute | Protected | Type reference (TYPE) | CHAR1 | Used for Background Check | 19990120 | |||
| 4 | Static Attribute | Protected | Type reference (TYPE) | I | GUID for ABAP Objects Controls | 19981116 | |||
| 5 | Static Attribute | Private | Object reference (TYPE REF TO) | OBJECT | Receives Global GUI Data | 19991206 | |||
| 6 | Static Attribute | Public | Type reference (TYPE) | CHAR01 | X: GUI is running | 19991122 | |||
| 7 | Instance attribute | Protected | Type reference (TYPE) | CNTL_HANDLE | H_CONTROL | 19981019 | |||
| 8 | Static Attribute | Public | Type reference (TYPE) | OLE2_OBJECT | R, FUGR CNTL | 19981116 | |||
| 9 | Static Attribute | Private | Type reference (TYPE) | I | Initialization Status | 19991206 | |||
| 10 | Constant | Private | Type reference (TYPE) | I | 2 | Final Initialization | 19991206 | ||
| 11 | Constant | Private | Type reference (TYPE) | I | 1 | Preliminary Initialization | 19991206 | ||
| 12 | Static Attribute | Public | Type reference (TYPE) | CHAR1 | R, FUGR CNTL | 19981116 | |||
| 13 | Static Attribute | Public | Type reference (TYPE) | CHAR01 | X: JavaBean to be called | 19990506 | |||
| 14 | Instance attribute | Protected | Type reference (TYPE) | CHAR255 | Class ID | 19991105 | |||
| 15 | Instance attribute | Private | Type reference (TYPE) | TY_PROPCACHE | Cache for Datachange Properties | 19990416 | |||
| 16 | Instance attribute | Private | Type reference (TYPE) | I | Current Cursor in Propcache | 19990416 | |||
| 17 | Static Attribute | Protected | Type reference (TYPE) | CHAR01 | Cache Supported by Platform? | 19990416 | |||
| 18 | Static Attribute | Public | Type reference (TYPE) | CHAR01 | X: Web is Active | 19990625 | |||
| 19 | Static Attribute | Protected | Type reference (TYPE) | CHAR01 | DIAG XML Blob supported | 19990503 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Protected | Method | Add new Cached Property | 19990416 | |
| 2 | Instance method | Protected | Method | Assign_Property | 19981013 | |
| 3 | Instance method | Protected | Method | Call_Method | 19981013 | |
| 4 | Instance method | Protected | Method | Call Method rc=GUI_OBJECT, You can Check Obj. With IS_VALID | 19981130 | |
| 5 | Static method | Public | Constructor | CLASS_CONSTRUCTOR | 19981116 | |
| 6 | Static method | Private | Method | Additional External Class Constructor | 19991206 | |
| 7 | Instance method | Public | Constructor | Constructor | 19981013 | |
| 8 | Instance method | Public | Method | Destructor | 19981013 | |
| 9 | Instance method | Protected | Method | Read Value of a Cache Property | 19990416 | |
| 10 | Instance method | Protected | Method | Get_Property | 19981013 | |
| 11 | Instance method | Protected | Method | GetProperty rc=GUI_OBJECT, You Can Check obj With 'IS_VALID' | 19981130 | |
| 12 | Instance method | Protected | Method | Invalidates the Cache | 19991117 | |
| 13 | Instance method | Protected | Method | Property Managed in Cache? | 19990416 | |
| 14 | Instance method | Protected | Method | Query: Is the Cache Valid for this Control? | 19991117 | |
| 15 | Instance method | Public | Method | Check If a GUI_OBJECT Represents a Valid Frontend Object | 19981218 | |
| 16 | Instance method | Protected | Method | Remove Cached Property from Cache | 19990416 | |
| 17 | Instance method | Protected | Method | Write Value of a Cache Property | 19990416 | |
| 18 | Instance method | Protected | Method | Set_Property | 19981013 | |
| 19 | 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 | PROPNAME | Call by reference | Type reference (TYPE) | STRING | Name der Property | 19990416 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Cache ist nicht verfügbar | 19990416 | ||
| 2 | Ungültiger Namen | 19990416 | ||
| 3 | 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 | FROM_OBJ | Call by reference | Object reference (TYPE REF TO) | CL_GUI_OBJECT | Quell-Objekt | 19981019 | |||
| 2 | FROM_PROPERTY | Value transfer | Type reference (TYPE) | C | Name der Quell-Property | 19981019 | |||
| 3 | PROPERTY | Value transfer | Type reference (TYPE) | C | Name der Property | 19981019 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CNTL_ERROR | 19981019 | ||
| 2 | CNTL_SYSTEM_ERROR | 19981019 |
Method CALL_METHOD Signature
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CNTL_ERROR | 19981019 | ||
| 2 | CNTL_SYSTEM_ERROR | 19981019 |
Method CALL_METHOD_RESULT_GUI_OBJECT Signature
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CNTL_ERROR | 19981130 | ||
| 2 | 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 | 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 | CLSID | Value transfer | Type reference (TYPE) | C | Class-Id | 19981019 | |||
| 2 | LIFETIME | Value transfer | Type reference (TYPE) | I | Lebensdauer | 19981019 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CREATE_ERROR | 19981019 | ||
| 2 | LIFETIME_ERROR | 19981019 |
Method FREE Signature
Method FREE on class CL_GUI_OBJECT has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CNTL_ERROR | 19981019 | ||
| 2 | CNTL_SYSTEM_ERROR | 19981019 |
Method GET_CACHE_PROP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | PROPNAME | Call by reference | Type reference (TYPE) | STRING | Name der Property | 19990416 | |||
| 2 | PROPVALUE | Call by reference | Type reference (TYPE) | STRING | Wert der Property | 19990416 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Cache ist nicht verfügbar | 19990416 | ||
| 2 | Ungültiger Name | 19990416 | ||
| 3 | Der Wert ist nicht gültig | 19990416 | ||
| 4 | Property ist nicht im Cache deklariert | 19990416 |
Method GET_PROPERTY Signature
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CNTL_ERROR | 19981013 | ||
| 2 | CNTL_SYSTEM_ERROR | 19981013 |
Method GET_PROPERTY_GUI_OBJECT Signature
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CNTL_ERROR | 19981130 | ||
| 2 | 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 | IS_IN_CACHE | Value transfer | Type reference (TYPE) | CHAR01 | 'X', wenn im Cache Verwaltet | 19990416 | |||
| 2 | PROPNAME | Call by reference | Type reference (TYPE) | STRING | Name der Property | 19990416 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 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 | 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 | 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 | PROPNAME | Call by reference | Type reference (TYPE) | STRING | Name der Property | 19990416 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Cache ist nicht verfügbar | 19990416 | ||
| 2 | Ungültiger Namen | 19990416 | ||
| 3 | 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 | PROPNAME | Call by reference | Type reference (TYPE) | STRING | Name der Property | 19990416 | |||
| 2 | PROPVALUE | Call by reference | Type reference (TYPE) | STRING | Wert der Property | 19990416 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Cache ist nicht verfügbar | 19990416 | ||
| 2 | Ungültiger Propertyname | 19990416 | ||
| 3 | Property ist nicht im Cahce deklariert | 19990416 |
Method SET_PROPERTY Signature
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CNTL_ERROR | 19981013 | ||
| 2 | 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 |