SAP ABAP Class CL_GUI_PROPS_CONSUMER (Receives Global GUI Props)
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_GUI_DYNAMIC_DATA | Interface for Processing Dynamic Control Data | 19991228 |
Properties
| Class | CL_GUI_PROPS_CONSUMER | |
| Short Description | Receives Global GUI Props | |
| Super Class | ||
| Instantiability of a Class | 1 | Protected |
| Final |
General Data
| Message Class | ||
| Program status | S | System Program |
| Category | 0 | |
| Package | SCET | Control Enabling Technology / Control Framework |
| Created | 19991228 | 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) |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_GUI_DYNAMIC_DATA | Interface for Processing Dynamic Control Data | 19991228 |
Friends
Class CL_GUI_PROPS_CONSUMER has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Static Attribute | Private | Type reference (TYPE) | SYCHAR01 | ActiveX? | 19991228 | |||
| 2 | Static Attribute | Public | Type reference (TYPE) | SYCHAR01 | Catt? | 20000126 | |||
| 3 | Static Attribute | Private | Object reference (TYPE REF TO) | LCL_COLOR_CONSUMER | Receives the Colors | 20000114 | |||
| 4 | Static Attribute | Protected | Type reference (TYPE) | CONSUMERS_TYPE | Consumers | 19991228 | |||
| 5 | Static Attribute | Public | Type reference (TYPE) | EUDB-NAME | Context ID | 20000908 | |||
| 6 | Instance attribute | Private | Type reference (TYPE) | SYCHAR01 | Change of Factors? | 19991228 | |||
| 7 | Static Attribute | Public | Type reference (TYPE) | SYCHAR01 | GUI Available? | 20000918 | |||
| 8 | Static Attribute | Public | Type reference (TYPE) | SYCHAR01 | Initialized? | 20000918 | |||
| 9 | Static Attribute | Protected | Type reference (TYPE) | SYCHAR01 | Java-Beans? | 19991228 | |||
| 10 | Static Attribute | Private | Object reference (TYPE REF TO) | LCL_LIST_DIM_CONSUMER | Receives List Dimensions | 20000901 | |||
| 11 | Static Attribute | Protected | Type reference (TYPE) | CNTL_METRIC_FACTORS | Conversion Factors | 19991228 | |||
| 12 | Static Attribute | Private | Type reference (TYPE) | SYCHAR01 | Data Available? | 20000918 | |||
| 13 | Static Attribute | Private | Type reference (TYPE) | SYCHAR01 | Handler Available? | 20000922 | |||
| 14 | Static Attribute | Public | Type reference (TYPE) | SYCHAR01 | WebGui? | 19991228 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Constructor | Class constructor | 19991228 | |
| 2 | Instance method | Public | Constructor | Constructor | 19991228 | |
| 3 | Static method | Public | Method | Internal use! | 19991228 | |
| 4 | Static method | Private | Method | Force CFW Initialization | 20000922 | |
| 5 | Static method | Public | Method | Returns the Current Colors | 20000918 | |
| 6 | Static method | Public | Method | Returns the Current List Dimensions | 20000907 | |
| 7 | Instance method | Public | Method | Internal Use! Conversion Factors of Metrics Supported | 19991228 | |
| 8 | Static method | Public | Method | Internal Use! Triggers Color Change Event | 20000918 | |
| 9 | Static method | Public | Method | Internal use! Triggers List-Dim-Change Event | 20000918 | |
| 10 | Static method | Public | Method | Internal Use! | 20000918 | |
| 11 | Static method | Private | Method | Initialization | 20000918 | |
| 12 | Static method | Private | Method | List Dimension and Colors Available? | 20000918 | |
| 13 | Static method | Public | Method | Internal use! | 19991228 | |
| 14 | Instance method | Public | Method | Internal Use! Conversion Factor Update | 20000112 | |
| 15 | Static method | Public | Method | Forces Update of GUI Data | 20000918 |
Events
| # | Event | Type | Visibility | Description | Created on |
|---|---|---|---|---|---|
| 1 | COLOR_CHANGE | Static Event (1) |
Public (2) |
Change of the Colors | 20000918 |
| 2 | GLOBAL_PROP_CHANGE | Static Event (1) |
Public (2) |
Change of Global GUI Data | 20000114 |
| 3 | GUI_DATA_REQUEST | Static Event (1) |
Public (2) |
Internal use! Consumer Requests GUI Data | 20000918 |
| 4 | LIST_DIMENSION_CHANGE | Static Event (1) |
Public (2) |
Change of List Dimensions | 20000901 |
| 5 | METRIC_FACTORS_CHANGE | Static Event (1) |
Public (2) |
Internal Use! Change of Conversion Factors | 20000918 |
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | CONSUMERS_TYPE | Protected | See coding | CONSUMERS_TYPE | 19991228 | |
|
| 2 | ONE_CONSUMER_TYPE | Protected | See coding | ONE_CONSUMER_TYPE | 19991228 | |
Method Signatures
Method CLASS_CONSTRUCTOR Signature
Method CLASS_CONSTRUCTOR on class CL_GUI_PROPS_CONSUMER has no parameter.
Method CLASS_CONSTRUCTOR on class CL_GUI_PROPS_CONSUMER has no exception.
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | NAMESPACE | Call by reference | Type reference (TYPE) | STRING | 'GUI' | Namespace, auf den gehört wird | 19991228 |
Method CONSTRUCTOR on class CL_GUI_PROPS_CONSUMER has no exception.
Method CREATE_CONSUMER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CONSUMER | Value transfer | Object reference (TYPE REF TO) | CL_GUI_PROPS_CONSUMER | Der Consumer | 19991228 | |||
| 2 | NAMESPACE | Call by reference | Type reference (TYPE) | STRING | 'GUI' | Namespace für Consumer | 19991228 |
Method CREATE_CONSUMER on class CL_GUI_PROPS_CONSUMER has no exception.
Method FORCE_DATA_REQUEST_HANDLER Signature
Method FORCE_DATA_REQUEST_HANDLER on class CL_GUI_PROPS_CONSUMER has no parameter.
Method FORCE_DATA_REQUEST_HANDLER on class CL_GUI_PROPS_CONSUMER has no exception.
Method GET_COLORS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | COLORS | Value transfer | Type reference (TYPE) | CNTL_COLORS | Die Farben | 20000116 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Nicht verfügbar | 20000918 |
Method GET_LIST_DIMENSION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DIMENSION | Value transfer | Type reference (TYPE) | CNTL_LIST_DIM | List-Dimension | 20000908 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | List-Dimension nicht verfügbar,z.B. weil kein Gui oder CATT | 20000908 |
Method GET_METRIC_FACTORS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | METRIC_FACTORS | Value transfer | Type reference (TYPE) | CNTL_METRIC_FACTORS | Faktoren | 19991228 |
Method GET_METRIC_FACTORS on class CL_GUI_PROPS_CONSUMER has no exception.
Method HANDLE_COLOR_CHANGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | COLORS | Call by reference | Type reference (TYPE) | CNTL_COLORS | Die Farben | 20000918 |
Method HANDLE_COLOR_CHANGE on class CL_GUI_PROPS_CONSUMER has no exception.
Method HANDLE_LIST_DIM_CHANGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DIMENSION | Call by reference | Type reference (TYPE) | CNTL_LIST_DIM | List-Dimension | 20000908 |
Method HANDLE_LIST_DIM_CHANGE on class CL_GUI_PROPS_CONSUMER has no exception.
Method INIT Signature
Method INIT on class CL_GUI_PROPS_CONSUMER has no parameter.
Method INIT on class CL_GUI_PROPS_CONSUMER has no exception.
Method INIT_GUI_DATA Signature
Method INIT_GUI_DATA on class CL_GUI_PROPS_CONSUMER has no parameter.
Method INIT_GUI_DATA on class CL_GUI_PROPS_CONSUMER has no exception.
Method IS_DATA_AVAILABLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | AVAILABLE | Value transfer | Type reference (TYPE) | SYCHAR01 | CHAR01-Datenelement fuer SYST | 20000918 |
Method IS_DATA_AVAILABLE on class CL_GUI_PROPS_CONSUMER has no exception.
Method SET_DEFAULT_FACTORS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ACTIVEX | Value transfer | Type reference (TYPE) | SYCHAR01 | 'X' | ActiveX unterstützt? | 19991228 | ||
| 2 | CATT_ACTIVE | Value transfer | Type reference (TYPE) | SYCHAR01 | CATT aktiv? | 20000126 | |||
| 3 | GUI_IS_RUNNING | Value transfer | Type reference (TYPE) | SYCHAR01 | Gui vorhanden? | 20000918 | |||
| 4 | JAVABEAN | Value transfer | Type reference (TYPE) | SYCHAR01 | Java-Beans unterstützt? | 19991228 | |||
| 5 | WWW_ACTIVE | Value transfer | Type reference (TYPE) | SYCHAR01 | WebGui aktiv? | 19991228 |
Method SET_DEFAULT_FACTORS on class CL_GUI_PROPS_CONSUMER has no exception.
Method SET_METRIC_FACTORS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | METRIC_FACTORS | Call by reference | Type reference (TYPE) | CNTL_METRIC_FACTORS | Umrechnungsfaktoren | 20000112 |
Method SET_METRIC_FACTORS on class CL_GUI_PROPS_CONSUMER has no exception.
Method SYNC_GUI_DATA Signature
Method SYNC_GUI_DATA on class CL_GUI_PROPS_CONSUMER has no parameter.
Method SYNC_GUI_DATA on class CL_GUI_PROPS_CONSUMER has no exception.
Event Signatures
Event COLOR_CHANGE Signature
| # | Parameter | Type | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | COLORS | Exporting | Value transfer | Type reference (TYPE) | CNTL_COLORS | Die Farben | 20000918 |
Event GLOBAL_PROP_CHANGE Signature
Event GLOBAL_PROP_CHANGE on class CL_GUI_PROPS_CONSUMER has no parameter.
Event GUI_DATA_REQUEST Signature
Event GUI_DATA_REQUEST on class CL_GUI_PROPS_CONSUMER has no parameter.
Event LIST_DIMENSION_CHANGE Signature
| # | Parameter | Type | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | DIMENSION | Exporting | Value transfer | Type reference (TYPE) | CNTL_LIST_DIM | List-Dimension | 20000908 |
Event METRIC_FACTORS_CHANGE Signature
| # | Parameter | Type | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | METRIC_FACTORS | Exporting | Value transfer | Type reference (TYPE) | CNTL_METRIC_FACTORS | Die Umrechnungsfaktoren | 20000918 |
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 50A |