SAP ABAP Class CL_GFW_MUX (GFW: Multiplexer for Graphical Framework)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-FES-GRA (Application Component) Graphic
⤷
SGRB (Package) ABAP Graphic Proxies
⤷
⤷
Properties
| Class | CL_GFW_MUX | |
| Short Description | GFW: Multiplexer for Graphical Framework | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SGRB | ABAP Graphic Proxies |
| Created | 19971126 | SAP |
| Last change | 20000901 | 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
Class CL_GFW_MUX has no interface implemented.
Friends
Class CL_GFW_MUX 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) | TY_COMPOSITE_TAB1 | tab where proxies register | 20000807 | |||
| 2 | Static Attribute | Private | Type reference (TYPE) | I | 0 | Control graphic counter for improving performance | 19980423 | ||
| 3 | Static Attribute | Private | Type reference (TYPE) | I | 0 | NOGUI graphic counter to (prevent flush and graph_receive) | 19991217 | ||
| 4 | Static Attribute | Private | Type reference (TYPE) | I | 0 | Program graphic counter for improving performance | 19980423 | ||
| 5 | Constant | Public | Type reference (TYPE) | I | 3 | Event synchronization: Send event to application after sync. | 19980109 | ||
| 6 | Constant | Public | Type reference (TYPE) | I | 2 | Event synchronization: Send event to application bef. sync. | 19980109 | ||
| 7 | Constant | Public | Type reference (TYPE) | I | 1 | Event synchronisation: Don't send event to application | 19980109 | ||
| 8 | Static Attribute | Private | Type reference (TYPE) | GFW_BOOLEAN | GFW_TRUE | Controls available at front end | 19980423 | ||
| 9 | Static Attribute | Private | Type reference (TYPE) | GFW_BOOLEAN | GFW_FALSE | Prevent CONTROL_FLUSH call if controls are not available | 19980423 | ||
| 10 | Static Attribute | Private | Type reference (TYPE) | GFW_BOOLEAN | GFW_FALSE | Wait loop active | 19980423 | ||
| 11 | Static Attribute | Private | Type reference (TYPE) | TY_MAIN_TAB1 | Tab withproduct specific part of main proxies | 20000808 | |||
| 12 | Static Attribute | Private | Type reference (TYPE) | TY_GP_LIST1 | List of subscribed GPs (may need to be synchronized) | 19980423 | |||
| 13 | Static Attribute | Private | Type reference (TYPE) | I | 1 | Next free composite id | 20000804 | ||
| 14 | Static Attribute | Private | Type reference (TYPE) | GFW_SYNCJOB_LIST | Job list for synchronizations | 19980423 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Method | Activate+Event dispatch of prog. graphics (if used) | 19980423 | |
| 2 | Static method | Public | Method | Add new list | 20000803 | |
| 3 | Static method | Public | Method | Add a slave graphics proxy | 19980423 | |
| 4 | Static method | Public | Method | Add a synchronization job | 19980423 | |
| 5 | Static method | Public | Method | Remove composite proxy from MUX | 20000803 | |
| 6 | Static method | Public | Method | Delete a slave graphics proxy | 19980423 | |
| 7 | Static method | Public | Method | Remove a synchronization job | 19980423 | |
| 8 | Static method | Public | Method | Destructor replacement | 19971126 | |
| 9 | Static method | Public | Method | Determine change flags for CU objects | 19981106 | |
| 10 | Static method | Public | Method | Register with MUX | 20000803 | |
| 11 | Static method | Public | Method | A CU object was changed/a flag was set | 19981106 | |
| 12 | Static method | Public | Method | Subscribe a graphics proxy + Register with CFW | 19980423 | |
| 13 | Static method | Public | Method | Synchronize an event | 19980423 | |
| 14 | Static method | Public | Method | Unsubscribe a graphics proxy | 19980423 | |
| 15 | Static method | Public | Method | Update customizing object list for a graphics proxy | 19990818 |
Events
Class CL_GFW_MUX has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TY_COMPOSITE_TAB | Private | See coding | composite proxy | 20000807 | |
|
| 2 | TY_COMPOSITE_TAB1 | Private | See coding | list of composite proxies | 20000807 | |
|
| 3 | TY_CU_OBJECT | Private | See coding | Customizing object (with changed flag) | 19981106 | |
|
| 4 | TY_CU_OBJECT_LIST | Private | See coding | List of Customizing objects (and changed flags) | 19981106 | |
|
| 5 | TY_GP_LIST | Private | See coding | Single graphic proxy | 19980423 | |
|
| 6 | TY_GP_LIST1 | Private | See coding | List of graphic proxies | 19980610 | |
|
| 7 | TY_MAIN_TAB | Private | See coding | list of | 20000807 | |
|
| 8 | TY_MAIN_TAB1 | Private | See coding | TY_MAIN_TAB1 | 20000807 | |
Method Signatures
Method ACTIVATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RETVAL | Call by reference | Type reference (TYPE) | SYMSGNO | If OK, RETVAL = CL_GFW->OK, if failed RETVAL <> CL_GFW->OK | 19980423 |
Method ACTIVATE on class CL_GFW_MUX has no exception.
Method ADD_COMPOSITE_PROXY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | COMPOSITE_ID | Call by reference | Type reference (TYPE) | I | ID of connection | 20000804 | |||
| 2 | MAIN | Call by reference | Object reference (TYPE REF TO) | CL_GUI_GP | Reference to main proxy | 20000804 | |||
| 3 | PROD_MAIN | Call by reference | Object reference (TYPE REF TO) | IF_GP_MAIN | Reference to product-specific section of main proxy | 20000809 | |||
| 4 | SUBPROXIES | Call by reference | Type reference (TYPE) | GFW_SUBPROXY_LIST | List of references to subproxies | 20000804 |
Method ADD_COMPOSITE_PROXY on class CL_GFW_MUX has no exception.
Method ADD_SLAVE_TO_SYNCJOB Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RETVAL | Call by reference | Type reference (TYPE) | SYMSGNO | If OK, RETVAL = CL_GFW->OK, if failed RETVAL <> CL_GFW->OK | 19980423 | |||
| 2 | SYNCJOB | Call by reference | Type reference (TYPE) | GFW_SYNCJOB | Description of synchronization job | 19980423 |
Method ADD_SLAVE_TO_SYNCJOB on class CL_GFW_MUX has no exception.
Method ADD_SYNCJOB Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RETVAL | Call by reference | Type reference (TYPE) | SYMSGNO | If OK, RETVAL = CL_GFW->OK, if failed RETVAL <> CL_GFW->OK | 19980423 | |||
| 2 | SYNCJOB | Call by reference | Type reference (TYPE) | GFW_SYNCJOB | Description of synchronization job | 19980423 |
Method ADD_SYNCJOB on class CL_GFW_MUX has no exception.
Method DELETE_COMPOSITE_PROXY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ID | Call by reference | Type reference (TYPE) | I | ID of composite | 20000831 | |||
| 2 | RETVAL | Call by reference | Type reference (TYPE) | SYMSGNO | CL_GFW=>OK, if OK | 20000831 |
Method DELETE_COMPOSITE_PROXY on class CL_GFW_MUX has no exception.
Method DEL_SLAVE_FROM_SYNCJOB Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RETVAL | Call by reference | Type reference (TYPE) | SYMSGNO | If OK, RETVAL = CL_GFW->OK, if failed RETVAL <> CL_GFW->OK | 19980423 | |||
| 2 | SYNCJOB | Call by reference | Type reference (TYPE) | GFW_SYNCJOB | Description of synchronization job | 19980423 |
Method DEL_SLAVE_FROM_SYNCJOB on class CL_GFW_MUX has no exception.
Method DEL_SYNCJOB Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RETVAL | Call by reference | Type reference (TYPE) | SYMSGNO | If OK, RETVAL = CL_GFW->OK, if failed RETVAL <> CL_GFW->OK | 19980423 | |||
| 2 | SYNCJOB | Call by reference | Type reference (TYPE) | GFW_SYNCJOB | Description of synchronization job | 19980423 |
Method DEL_SYNCJOB on class CL_GFW_MUX has no exception.
Method FREE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RETVAL | Value transfer | Type reference (TYPE) | SYMSGNO | If OK, RETVAL = CL_GFW->OK, if failed RETVAL <> CL_GFW->OK | 19971126 |
Method FREE on class CL_GFW_MUX has no exception.
Method GET_CHANGED_CU_OBJECT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CUOBJ_CHANGED | Call by reference | Type reference (TYPE) | GFW_BOOLEAN | TRUE = (At least) one customizing object was changed | 19981106 | |||
| 2 | CUOBJ_CHANGED_LIST | Call by reference | Type reference (TYPE) | GFW_CU_CHANGED_OBJECT_LIST | List of customizing objects with changed flag | 19990712 | |||
| 3 | CUOBJ_LIST | Call by reference | Type reference (TYPE) | GFW_CU_OBJECT_LIST | DO NOT USE | 19981106 | |||
| 4 | GP | Call by reference | Object reference (TYPE REF TO) | IF_GP_NOTIFICATION | GP for which the changed customizing objects are determined | 19981106 | |||
| 5 | RESET_CHANGED_FLAG | Call by reference | Type reference (TYPE) | GFW_BOOLEAN | gfw_false | Reset / delete flags | 19981106 |
Method GET_CHANGED_CU_OBJECT on class CL_GFW_MUX has no exception.
Method NOTIFY_COMPOSITE_PROXY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | FILL_MODE | Call by reference | Type reference (TYPE) | I | Kind of data to be read | 20000901 | |||
| 2 | REG_PROXY | Call by reference | Object reference (TYPE REF TO) | CL_GUI_GP | Proxy to be registered | 20000808 | |||
| 3 | RETVAL | Call by reference | Type reference (TYPE) | SYMSGNO | CL_GFW=>OK, if ok | 20000808 |
Method NOTIFY_COMPOSITE_PROXY on class CL_GFW_MUX has no exception.
Method SET_CHANGED_CU_OBJECT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CHANGED_ATTR_ID_LIST | Call by reference | Type reference (TYPE) | GFW_CU_ATTR_ID_LIST | list of changed attributes in cu object | 19990712 | |||
| 2 | CUOBJ | Call by reference | Object reference (TYPE REF TO) | IF_CUSTOMIZING | Changed Customizing object | 19981106 |
Method SET_CHANGED_CU_OBJECT on class CL_GFW_MUX has no exception.
Method SUBSCRIBE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CUOBJ_LIST | Call by reference | Type reference (TYPE) | GFW_CU_OBJECT_LIST | List of Customizing objects used | 19981106 | |||
| 2 | DISPATCHER | Call by reference | Object reference (TYPE REF TO) | CL_GUI_CONTROL | Event handler (for program graphics only) | 19980423 | |||
| 3 | GP | Call by reference | Object reference (TYPE REF TO) | IF_GRAPHIC_PROXY | Graphic proxy (may need to be synchronized) | 19980423 | |||
| 4 | GP_NOTIFY_REF | Call by reference | Object reference (TYPE REF TO) | IF_GP_NOTIFICATION | GP handle for synchronizing Customizing changes | 19981106 | |||
| 5 | RETVAL | Call by reference | Type reference (TYPE) | SYMSGNO | CL_GFW -> OK: Successful | 19980423 | |||
| 6 | SHELLID | Call by reference | Type reference (TYPE) | I | 0 | Shell ID of GP (for controls, not for program graphics) | 19980423 | ||
| 7 | WINID | Call by reference | Type reference (TYPE) | GRWINID | Win ID of GP (unique for all GPs) | 19980610 |
Method SUBSCRIBE on class CL_GFW_MUX has no exception.
Method SYNCHRONIZE_EVENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CURR_GP | Call by reference | Object reference (TYPE REF TO) | IF_GRAPHIC_PROXY | Graphic proxy that sent the event | 19980423 | |||
| 2 | EVENT | Call by reference | Type reference (TYPE) | GFW_EVENT | GFW descriptino of the event (event code + parameter) | 19980423 | |||
| 3 | RETVAL | Call by reference | Type reference (TYPE) | SYMSGNO | If OK, RETVAL = CL_GFW->OK, if failed RETVAL <> CL_GFW->OK | 19980423 |
Method SYNCHRONIZE_EVENT on class CL_GFW_MUX has no exception.
Method UNSUBSCRIBE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GP | Call by reference | Object reference (TYPE REF TO) | IF_GRAPHIC_PROXY | (IF_DISPATCHER) unsubscribing graphics proxy | 19980423 | |||
| 2 | RETVAL | Call by reference | Type reference (TYPE) | SYMSGNO | If OK, RETVAL = CL_GFW->OK, if failed RETVAL <> CL_GFW->OK | 19980423 |
Method UNSUBSCRIBE on class CL_GFW_MUX has no exception.
Method UPDATE_CUOBJ_LIST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CUOBJ_LIST | Call by reference | Type reference (TYPE) | GFW_CU_OBJECT_LIST | new list of customizing objects used by gp | 19990818 | |||
| 2 | GP | Call by reference | Object reference (TYPE REF TO) | IF_GRAPHIC_PROXY | Graphics proxy | 19990818 | |||
| 3 | RETVAL | Call by reference | Type reference (TYPE) | SYMSGNO | CL_GFW -> OK: Successful | 19990818 |
Method UPDATE_CUOBJ_LIST on class CL_GFW_MUX has no exception.
History
| Last changed by/on | SAP | 20000901 |
| SAP Release Created in |