SAP ABAP Interface IF_SAT_UI_CTRL_FACTORY (*NO* Reuse: Builder to hide Concrete Control Implementation)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-DWB-TOO (Application Component) Workbench Tools: Editors, Painters, Modelers
⤷
SABP_TOOLS_STDIO (Package) *NO* REUSE - UI Libraries for ABAP Runtime Tools only !!!!!!
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-DWB-TOO (Application Component) Workbench Tools: Editors, Painters, Modelers⤷
SABP_TOOLS_STDIO (Package) *NO* REUSE - UI Libraries for ABAP Runtime Tools only !!!!!!
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_SAT_UI_CTRL_FACTORY | *NO* Reuse: Factory for UI Controls | 20071108 |
| 2 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_SAT_UI_CTRL_FACTORY_TEST | *NO* Reuse: Factory for Testing Purposes | 20071108 |
Properties
| Interface | IF_SAT_UI_CTRL_FACTORY | |
| Short Description | *NO* Reuse: Builder to hide Concrete Control Implementation |
General Data
| Package | SABP_TOOLS_STDIO | *NO* REUSE - UI Libraries for ABAP Runtime Tools only !!!!!! |
| Created | 20071003 | SAP |
| Last changed | 20130531 | SAP |
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | ABAP | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
| 2 | CL_GUI_DOCKING_CONTAINER | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
| 3 | CL_GUI_OBJECT | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
| 4 | CNTL | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
| 5 | IF_SAT_UI_TREE | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
Interfaces
Interface IF_SAT_UI_CTRL_FACTORY has no interface.
Friends
Interface IF_SAT_UI_CTRL_FACTORY has no friend.
Attributes
Interface IF_SAT_UI_CTRL_FACTORY has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CREATE_CUSTOM_CONTAINER |
Instance method | Public | Method | Creates a Custom Container | 20071003 |
| 2 | CREATE_DOCKING_CONTAINER |
Instance method | Public | Method | Creates a Docking Container | 20071003 |
| 3 | CREATE_GRID_CONTROL |
Instance method | Public | Method | Factory for Grid Control | 20071108 |
| 4 | CREATE_LIST_TREE_CONTROL |
Instance method | Public | Method | Creates a List Tree Control | 20071109 |
| 5 | CREATE_SIMPLE_CONTAINER |
Instance method | Public | Method | Creates a Simple Container | 20071003 |
| 6 | CREATE_SPLITTER_CONTAINER |
Instance method | Public | Method | Creates a Splitter Container | 20071003 |
| 7 | CREATE_TREE_CONTROL |
Instance method | Public | Method | Factory for Tree Control | 20071109 |
Events
Interface IF_SAT_UI_CTRL_FACTORY has no event.
Types
Interface IF_SAT_UI_CTRL_FACTORY has no local type.
Method Signatures
Method CREATE_CUSTOM_CONTAINER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
CONTAINER_NAME | Call by reference | Type reference (TYPE) | C | Name of the Screen CustCtrl Name to Link Container To | 20071003 | ||
| 2 | Importing |
DYNNR | Call by reference | Type reference (TYPE) | SYDYNNR | Report To Which this Container is Linked | 20071003 | ||
| 3 | Importing |
LIFETIME | Call by reference | Type reference (TYPE) | I | CL_GUI_CONTROL=>LIFETIME_DEFAULT | Lifetime | 20071003 | |
| 4 | Importing |
NO_AUTODEF_PROGID_DYNNR | Call by reference | Type reference (TYPE) | C | Don't Autodefined Progid and Dynnr? | 20071003 | ||
| 5 | Importing |
PARENT | Call by reference | Object reference (TYPE REF TO) | CL_GUI_CONTAINER | Parent container | 20071003 | ||
| 6 | Importing |
REPID | Call by reference | Type reference (TYPE) | SYREPID | Screen to Which this Container is Linked | 20071003 | ||
| 7 |  Returning |
RESULT | Value transfer | Object reference (TYPE REF TO) | CL_GUI_CUSTOM_CONTAINER | Container for Custom Controls in the Screen Area | 20071003 | ||
| 8 | Importing |
STYLE | Call by reference | Type reference (TYPE) | I | Windows Style Attributes Applied to this Container | 20071003 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CNTL_ERROR |
Invalid Parent Control | 20071003 | |
| 2 | CNTL_SYSTEM_ERROR |
System Error | 20071003 | |
| 3 | CREATE_ERROR |
Create Error | 20071003 | |
| 4 | LIFETIME_DYNPRO_DYNPRO_LINK |
Lifetime Error | 20071003 | |
| 5 | LIFETIME_ERROR |
Lifetime Error | 20071003 |
Method CREATE_DOCKING_CONTAINER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
CAPTION | Call by reference | Type reference (TYPE) | C | Caption | 20071003 | ||
| 2 | Importing |
DYNNR | Call by reference | Type reference (TYPE) | SYDYNNR | Screen to Which This Docking Control is Linked | 20071003 | ||
| 3 | Importing |
EXTENSION | Call by reference | Type reference (TYPE) | I | 50 | Control Extension | 20071003 | |
| 4 | Importing |
LIFETIME | Call by reference | Type reference (TYPE) | I | CL_GUI_CONTROL=>LIFETIME_DEFAULT | Lifetime | 20071003 | |
| 5 | Importing |
METRIC | Call by reference | Type reference (TYPE) | I | 0 | Metric | 20071003 | |
| 6 | Importing |
NAME | Call by reference | Type reference (TYPE) | STRING | Name | 20071003 | ||
| 7 | Importing |
NO_AUTODEF_PROGID_DYNNR | Call by reference | Type reference (TYPE) | C | Don't Autodefined Progid and Dynnr? | 20071003 | ||
| 8 | Importing |
PARENT | Call by reference | Object reference (TYPE REF TO) | CL_GUI_CONTAINER | Parent container | 20071003 | ||
| 9 | Importing |
RATIO | Call by reference | Type reference (TYPE) | I | Percentage of Screen: Takes Priority Over EXTENSION | 20071003 | ||
| 10 | Importing |
REPID | Call by reference | Type reference (TYPE) | SYREPID | Report to Which This Docking Control is Linked | 20071003 | ||
| 11 | Returning |
RESULT | Value transfer | Object reference (TYPE REF TO) | CL_GUI_DOCKING_CONTAINER | Docking Control Container | 20071003 | ||
| 12 | Importing |
SIDE | Call by reference | Type reference (TYPE) | I | CL_GUI_DOCKING_CONTAINER=>DOCK_AT_LEFT | Side to Which Control is Docked | 20071003 | |
| 13 | Importing |
STYLE | Call by reference | Type reference (TYPE) | I | Windows Style Attributes Applied to This Docking Container | 20071003 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CNTL_ERROR |
Invalid Parent Control | 20071003 | |
| 2 | CNTL_SYSTEM_ERROR |
System Error | 20071003 | |
| 3 | CREATE_ERROR |
Create Error | 20071003 | |
| 4 | LIFETIME_DYNPRO_DYNPRO_LINK |
Lifetime Error | 20071003 | |
| 5 | LIFETIME_ERROR |
Lifetime Error | 20071003 |
Method CREATE_GRID_CONTROL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ADDITIONAL_INFO | Call by reference | Type reference (TYPE) | IF_SAT_UI_GRID=>TY_S_ADDITIONAL_INFO | 20071108 | |||
| 2 | Importing |
CLICKED_ON_RETURN | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20071108 | ||
| 3 | Importing |
CONTAINER | Call by reference | Object reference (TYPE REF TO) | CL_GUI_CONTAINER | 20071108 | |||
| 4 | Importing |
CONTENT_TABLE_REFERENCE | Call by reference | Object reference (TYPE REF TO) | DATA | 20071108 | |||
| 5 | Importing |
HANDLER_OPTIONS | Call by reference | Type reference (TYPE) | STRING | 20071108 | |||
| 6 | Importing |
HEADER_TITLE | Call by reference | Type reference (TYPE) | CSEQUENCE | 20071108 | |||
| 7 | Importing |
LAYOUT | Call by reference | Type reference (TYPE) | LVC_S_LAYO | 20071108 | |||
| 8 | Importing |
MASTER | Call by reference | Object reference (TYPE REF TO) | CL_SAT_UI_GRID | 20071108 | |||
| 9 | Returning |
RESULT | Value transfer | Object reference (TYPE REF TO) | IF_SAT_UI_GRID_CTRL | ALV List Viewer | 20071108 | ||
| 10 | Importing |
TOOLBAR_OPTIONS | Call by reference | Type reference (TYPE) | STRING | 20071108 | |||
| 11 | Importing |
WITH_USER_VARIANT | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20071108 |
Method CREATE_GRID_CONTROL on Interface IF_SAT_UI_CTRL_FACTORY has no exception.
Method CREATE_LIST_TREE_CONTROL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
CONTAINER | Call by reference | Object reference (TYPE REF TO) | CL_GUI_CONTAINER | Abstract Container for GUI Controls | 20071109 | ||
| 2 | Importing |
HANDLER_OPTIONS | Call by reference | Type reference (TYPE) | STRING | 20071109 | |||
| 3 | Importing |
MASTER | Call by reference | Object reference (TYPE REF TO) | CL_SAT_UI_LIST_TREE | Base class for simple tree controls | 20071109 | ||
| 4 | Returning |
RESULT | Value transfer | Object reference (TYPE REF TO) | IF_SAT_UI_LIST_TREE_CTRL | List Tree Control | 20071109 |
Method CREATE_LIST_TREE_CONTROL on Interface IF_SAT_UI_CTRL_FACTORY has no exception.
Method CREATE_SIMPLE_CONTAINER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
AUTOALIGN | Call by reference | Type reference (TYPE) | SYCHAR01 | Use Autoalign? Default: No for Containers | 20071003 | ||
| 2 | Importing |
LIFETIME | Call by reference | Type reference (TYPE) | I | CL_GUI_CONTROL=>LIFETIME_DEFAULT | Lifetime | 20071003 | |
| 3 | Importing |
NAME | Call by reference | Type reference (TYPE) | STRING | Name | 20071003 | ||
| 4 | Importing |
PARENT | Call by reference | Object reference (TYPE REF TO) | CL_GUI_CONTAINER | Parent Container | 20071003 | ||
| 5 | Returning |
RESULT | Value transfer | Object reference (TYPE REF TO) | CL_GUI_SIMPLE_CONTAINER | Anonymous Container | 20071003 | ||
| 6 | Importing |
STYLE | Call by reference | Type reference (TYPE) | I | Window Style | 20071003 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CNTL_ERROR |
Invalid Parent Control | 20071003 | |
| 2 | CNTL_SYSTEM_ERROR |
System Error | 20071003 | |
| 3 | CREATE_ERROR |
Create Error | 20071003 | |
| 4 | LIFETIME_DYNPRO_ILLEGAL_PARENT |
Lifetime Error | 20071003 | |
| 5 | LIFETIME_ERROR |
Lifetime Error | 20071003 |
Method CREATE_SPLITTER_CONTAINER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ALIGN | Call by reference | Type reference (TYPE) | I | 15 | Alignment | 20071003 | |
| 2 | Importing |
COLUMNS | Call by reference | Type reference (TYPE) | I | Number of Columns to be Displayed | 20071003 | ||
| 3 | Importing |
HEIGHT | Call by reference | Type reference (TYPE) | I | Hght | 20071003 | ||
| 4 | Importing |
LEFT | Call by reference | Type reference (TYPE) | I | Left-aligned | 20071003 | ||
| 5 | Importing |
LINK_DYNNR | Call by reference | Type reference (TYPE) | SY-DYNNR | Screen Number | 20071003 | ||
| 6 | Importing |
LINK_REPID | Call by reference | Type reference (TYPE) | SY-REPID | Report Name | 20071003 | ||
| 7 | Importing |
METRIC | Call by reference | Type reference (TYPE) | CNTL_METRIC | CNTL_METRIC_DYNPRO | Metric | 20071003 | |
| 8 | Importing |
NAME | Call by reference | Type reference (TYPE) | STRING | Name | 20071003 | ||
| 9 | Importing |
NO_AUTODEF_PROGID_DYNNR | Call by reference | Type reference (TYPE) | C | Don't Autodefined Progid and Dynnr? | 20071003 | ||
| 10 | Importing |
PARENT | Call by reference | Object reference (TYPE REF TO) | CL_GUI_CONTAINER | Parent Container | 20071003 | ||
| 11 | Returning |
RESULT | Value transfer | Object reference (TYPE REF TO) | CL_GUI_SPLITTER_CONTAINER | Docking Control Container | 20071003 | ||
| 12 | Importing |
ROWS | Call by reference | Type reference (TYPE) | I | Number of Rows to be displayed | 20071003 | ||
| 13 | Importing |
SHELLSTYLE | Call by reference | Type reference (TYPE) | I | Window Style | 20071003 | ||
| 14 | Importing |
TOP | Call by reference | Type reference (TYPE) | I | top | 20071003 | ||
| 15 | Importing |
WIDTH | Call by reference | Type reference (TYPE) | I | NPlWidth | 20071003 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CNTL_ERROR |
Invalid Parent Control | 20071003 | |
| 2 | CNTL_SYSTEM_ERROR |
System Error | 20071003 |
Method CREATE_TREE_CONTROL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ADDITIONAL_INFO | Call by reference | Type reference (TYPE) | IF_SAT_UI_TREE=>TY_S_ADDITIONAL_INFO | Additional Info (Check Components) | 20071109 | ||
| 2 | Importing |
CONTAINER | Call by reference | Object reference (TYPE REF TO) | CL_GUI_CONTAINER | 20071109 | |||
| 3 | Importing |
CONTENT_TABLE_REFERENCE | Call by reference | Object reference (TYPE REF TO) | DATA | 20071109 | |||
| 4 | Importing |
CONTENT_TABLE_TYPE | Call by reference | Type reference (TYPE) | INDEX TABLE | 20071109 | |||
| 5 | Importing |
HANDLER_OPTIONS | Call by reference | Type reference (TYPE) | STRING | 20071109 | |||
| 6 | Importing |
HEADER | Call by reference | Type reference (TYPE) | TREEV_HHDR | 20071109 | |||
| 7 | Importing |
HEADER_TITLE | Call by reference | Type reference (TYPE) | CSEQUENCE | 20071109 | |||
| 8 | Importing |
MASTER | Call by reference | Object reference (TYPE REF TO) | CL_SAT_UI_TREE | 20071109 | |||
| 9 | Returning |
RESULT | Value transfer | Object reference (TYPE REF TO) | IF_SAT_UI_TREE_CTRL | ALV List Viewer | 20071109 | ||
| 10 | Importing |
TOOLBAR_OPTIONS | Call by reference | Type reference (TYPE) | STRING | 20071109 |
Method CREATE_TREE_CONTROL on Interface IF_SAT_UI_CTRL_FACTORY has no exception.
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 710 |
