SAP ABAP Class CL_GUI_DIALOGBOX_CONTAINER (Container for Custom Controls in the Screen Area)
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 | Inheritance (c INHERITING FROM c_ref) | CL_GUI_CONTAINER | Abstract Container for GUI Controls | 00000000 |
Meta Relationship - Used By
Properties
| Class | CL_GUI_DIALOGBOX_CONTAINER | |
| Short Description | Container for Custom Controls in the Screen Area | |
| Super Class | CL_GUI_CONTAINER | Abstract Container for GUI Controls |
| 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 | 19981203 | SAP |
| Last change | 20130531 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class CL_GUI_DIALOGBOX_CONTAINER has no forward declaration.
Interfaces
Class CL_GUI_DIALOGBOX_CONTAINER has no interface implemented.
Friends
Class CL_GUI_DIALOGBOX_CONTAINER has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Instance attribute | Protected | Type reference (TYPE) | I | 8 | Close Event ID | 19990113 | ||
| 2 | Constant | Protected | Type reference (TYPE) | I | 440 | Constant | 19990812 | ||
| 3 | Constant | Protected | Type reference (TYPE) | I | 430 | Constant | 19990812 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Constructor | Constructor | 19981203 | |
| 2 | Instance method | Public | Method | Gets Current Caption | 19990812 | |
| 3 | Instance method | Public | Method | Gets Current Horizontal Scroll Range of Control | 19990812 | |
| 4 | Instance method | Public | Method | Gets Current Vertical Scroll Range of Control | 19990812 | |
| 5 | Instance method | Public | Method | Register/Deregister Close Event | 19990813 | |
| 6 | Instance method | Public | Method | Sets a New Caption | 19990204 | |
| 7 | Instance method | Public | Method | Sets Horizontal Scroll Range of Control | 19990812 | |
| 8 | Instance method | Public | Method | Sets Vertical Scroll Range of Control | 19990812 |
Events
| # | Event | Type | Visibility | Description | Created on |
|---|---|---|---|---|---|
| 1 | CLOSE | Instance Event (0) |
Public (2) |
Close Button Triggered in Dialog Box | 19990112 |
Types
Class CL_GUI_DIALOGBOX_CONTAINER has no local type.
Method Signatures
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CAPTION | Value transfer | Type reference (TYPE) | C | Caption of Dialogbox | 19981216 | |||
| 2 | DYNNR | Value transfer | Type reference (TYPE) | SYDYNNR | Dynpro to which this control is linked to | 19981203 | |||
| 3 | HEIGHT | Value transfer | Type reference (TYPE) | I | 30 | Height of this container | 19981203 | ||
| 4 | LEFT | Value transfer | Type reference (TYPE) | I | 0 | Left Position of Dialogbox | 19981216 | ||
| 5 | LIFETIME | Value transfer | Type reference (TYPE) | I | lifetime_default | Lifetime | 19981215 | ||
| 6 | METRIC | Value transfer | Type reference (TYPE) | I | 0 | Metric | 19990622 | ||
| 7 | NAME | Value transfer | Type reference (TYPE) | STRING | Name | 20000112 | |||
| 8 | NO_AUTODEF_PROGID_DYNNR | Value transfer | Type reference (TYPE) | C | dont autodefine progid and dynnr? | 19990325 | |||
| 9 | PARENT | Value transfer | Object reference (TYPE REF TO) | CL_GUI_CONTAINER | Parent container | 19981203 | |||
| 10 | REPID | Value transfer | Type reference (TYPE) | SYREPID | Report to which this control is linked to | 19981203 | |||
| 11 | STYLE | Value transfer | Type reference (TYPE) | I | Windows style attributes applied to this container | 19981203 | |||
| 12 | TOP | Value transfer | Type reference (TYPE) | I | 0 | Top Position of Dialogbox | 19981216 | ||
| 13 | WIDTH | Value transfer | Type reference (TYPE) | I | 30 | Width of this container | 19981203 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CNTL_ERROR | 19981203 | ||
| 2 | CNTL_SYSTEM_ERROR | 19981203 | ||
| 3 | CREATE_ERROR | 19981203 | ||
| 4 | Error when registering event | 19990813 | ||
| 5 | Event already registered | 19990813 | ||
| 6 | LIFETIME_DYNPRO_DYNPRO_LINK | 19981203 | ||
| 7 | LIFETIME_ERROR | 19981203 |
Method GET_CAPTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CAPTION | Call by reference | Type reference (TYPE) | C | Actual caption of control | 19990812 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | cntl_error | 19990812 | ||
| 2 | cntl_system_error | 19990812 |
Method GET_HSCROLL_RANGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | HSCROLL_RANGE | Call by reference | Type reference (TYPE) | I | Actual horizontal scroll range of control | 19990812 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | cntl_error | 19990812 | ||
| 2 | cntl_system_error | 19990812 |
Method GET_VSCROLL_RANGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | VSCROLL_RANGE | Call by reference | Type reference (TYPE) | I | Actual vertical scroll range of control | 19990812 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | cntl_error | 19990812 | ||
| 2 | cntl_system_error | 19990812 |
Method REG_EVENT_CLOSE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | REGISTER | Call by reference | Type reference (TYPE) | I | 1 | True = register, False = unregister | 19990813 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Error: control not initialized | 19990813 | ||
| 2 | Error while registering event close | 19990813 | ||
| 3 | Error while unregistering event close | 19990813 | ||
| 4 | Event is already registered | 19990813 | ||
| 5 | Event was not registered, thus unregistration makes no sense | 19990813 |
Method SET_CAPTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CAPTION | Value transfer | Type reference (TYPE) | C | New Caption | 19990204 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | cntl_error | 19990204 | ||
| 2 | cntl_system_error | 19990204 |
Method SET_HSCROLL_RANGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | HSCROLL_RANGE | Value transfer | Type reference (TYPE) | I | New horizontal scroll range of control | 19990812 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | cntl_error | 19990812 | ||
| 2 | cntl_system_error | 19990812 |
Method SET_VSCROLL_RANGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | VSCROLL_RANGE | Value transfer | Type reference (TYPE) | I | New vertical scroll range of control | 19990812 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | cntl_error | 19990812 | ||
| 2 | cntl_system_error | 19990812 |
Event Signatures
Event CLOSE Signature
Event CLOSE on class CL_GUI_DIALOGBOX_CONTAINER has no parameter.
Meta Relationship - Used By (full list)
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in |