SAP ABAP Interface /IWBEP/IF_SBUI_COMPONENT (SB: UI component (displays something in a window))
Hierarchy
☛
SAP_GWFND (Software Component) SAP Gateway Foundation
⤷
OPU-BSE-SB (Application Component) Gateway Service Builder
⤷
/IWBEP/SB_UI_BASE (Package) Gateway Service Builder UI - API and SPI
SAP_GWFND (Software Component) SAP Gateway Foundation⤷
OPU-BSE-SB (Application Component) Gateway Service Builder⤷
/IWBEP/SB_UI_BASE (Package) Gateway Service Builder UI - API and SPI
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface composition (i COMPRISING i_ref) | /IWBEP/IF_SBUI_COMPOSITE | SB: UI composite (contains other components) | 20120131 |
| 2 | Interface composition (i COMPRISING i_ref) | /IWBEP/IF_SBUI_CONTROL_HANDLER | SB: UI control handler behavior | 20120118 |
| 3 | Interface implementation (CLASS c. INTERFACES i_ref) | /IWBEP/CL_SBUI_COMPONENT | SB: UI component | 20120113 |
Properties
| Interface | /IWBEP/IF_SBUI_COMPONENT | |
| Short Description | SB: UI component (displays something in a window) |
General Data
| Package | /IWBEP/SB_UI_BASE | Gateway Service Builder UI - API and SPI |
| Created | 20120113 | SAP |
| Last changed | 20141120 | |
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | /IWBEP/IF_SBUI_CONTROLLER | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
| 2 | /IWBEP/IF_SBUI_INTERACTIVE | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
| 3 | /IWBEP/IF_SBUI_SETUP_SERVICE | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
| 4 | ABAP | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | /IWBEP/IF_SBCM_MSG_CONTEXT | SB: message context | 20120118 |
Friends
Interface /IWBEP/IF_SBUI_COMPONENT has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GC_CATEGORY_CONTAINER | Constant | Public | Type reference (TYPE) | /IWBEP/SBUI_COMPONENT_CATEGORY | 'C' | category container | 20120123 | |
| 2 | GC_CATEGORY_DETAIL | Constant | Public | Type reference (TYPE) | /IWBEP/SBUI_COMPONENT_CATEGORY | 'D' | category edit (detail) | 20130507 | |
| 3 | GC_CATEGORY_EDIT | Constant | Public | Type reference (TYPE) | /IWBEP/SBUI_COMPONENT_CATEGORY | 'E' | category edit (master) | 20120116 | |
| 4 | GC_CATEGORY_EXPLORE | Constant | Public | Type reference (TYPE) | /IWBEP/SBUI_COMPONENT_CATEGORY | 'X' | category explore | 20120116 | |
| 5 | GC_CATEGORY_NAVIGATE | Constant | Public | Type reference (TYPE) | /IWBEP/SBUI_COMPONENT_CATEGORY | 'N' | category navigate | 20120116 | |
| 6 | GC_CATEGORY_NOTIFY | Constant | Public | Type reference (TYPE) | /IWBEP/SBUI_COMPONENT_CATEGORY | 'I' | category notify | 20120116 | |
| 7 | GC_METRIC_DYNPRO | Constant | Public | Type reference (TYPE) | TY_METRIC | '1' | GUI metric dynpro | 20120113 | |
| 8 | GC_METRIC_MILLIMETER | Constant | Public | Type reference (TYPE) | TY_METRIC | '3' | GUI metric millimeter | 20120113 | |
| 9 | GC_METRIC_PIXEL | Constant | Public | Type reference (TYPE) | TY_METRIC | '2' | GUI metric pixel | 20120113 | |
| 10 | GC_METRIC_RELATIVE | Constant | Public | Type reference (TYPE) | TY_METRIC | '4' | GUI metric relative | 20120113 | |
| 11 | GC_TYPE_ALV_GRID | Constant | Public | Type reference (TYPE) | /IWBEP/SBUI_COMPONENT_TYPE | 'G' | type ALV grid | 20120116 | |
| 12 | GC_TYPE_ALV_TREE | Constant | Public | Type reference (TYPE) | /IWBEP/SBUI_COMPONENT_TYPE | 'T' | type ALV tree | 20120116 | |
| 13 | GC_TYPE_DIALOG | Constant | Public | Type reference (TYPE) | /IWBEP/SBUI_COMPONENT_TYPE | 'D' | type dialog | 20120119 | |
| 14 | GC_TYPE_SCREEN | Constant | Public | Type reference (TYPE) | /IWBEP/SBUI_COMPONENT_TYPE | 'M' | type screen | 20120119 | |
| 15 | GC_TYPE_SUBSCREEN | Constant | Public | Type reference (TYPE) | /IWBEP/SBUI_COMPONENT_TYPE | 'S' | type subscreen | 20120116 | |
| 16 | GC_TYPE_VIEW | Constant | Public | Type reference (TYPE) | /IWBEP/SBUI_COMPONENT_TYPE | 'V' | type control | 20120217 | |
| 17 | GC_TYPE_WIZARD | Constant | Public | Type reference (TYPE) | /IWBEP/SBUI_COMPONENT_TYPE | 'W' | type wizard | 20120119 | |
| 18 | MS_NAME | Instance attribute | Public | Type reference (TYPE) | TY_S_NAME | component name (plugin and component) | 20120116 | ||
| 19 | MV_CATEGORY | Instance attribute | Public | Type reference (TYPE) | /IWBEP/SBUI_COMPONENT_CATEGORY | component category | 20120216 | ||
| 20 | MV_DISABLED | Instance attribute | Public | Type reference (TYPE) | ABAP_BOOL | indicates state is inactive | 20130417 | ||
| 21 | MV_ICON | Instance attribute | Public | Type reference (TYPE) | /IWBEP/SBUI_ICON | component icon | 20130419 | ||
| 22 | MV_LABEL | Instance attribute | Public | Type reference (TYPE) | /IWBEP/SBUI_COMPONENT_LABEL | component label | 20120116 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | GET_INTERACTIVE |
Instance method | Public | Method | get interactive componentes from sub-tree, starting with me | 20120410 |
| 2 | GET_OPTIONS |
Instance method | Public | Method | get display options | 20130413 |
| 3 | GET_PARENT |
Instance method | Public | Method | get current parent | 20120131 |
| 4 | GET_SIZE |
Instance method | Public | Method | get calculated size of the whole component | 20120113 |
| 5 | GET_STATE |
Instance method | Public | Method | get display state | 20130913 |
| 6 | GET_VISIBILITY |
Instance method | Public | Method | get visibility of this component (ask parent) | 20120718 |
| 7 | SET_OPTIONS |
Instance method | Public | Method | set display options | 20130413 |
| 8 | SET_PARENT |
Instance method | Public | Method | set new parent (initial == detach from previous parent only) | 20120116 |
| 9 | SET_SIZE |
Instance method | Public | Method | set calculated size of the whole component | 20120113 |
| 10 | SET_STATE |
Instance method | Public | Method | set display state | 20130913 |
| 11 | SET_VISIBILITY |
Instance method | Public | Method | set visibility of this component (notfiy parent) | 20120116 |
Events
Interface /IWBEP/IF_SBUI_COMPONENT has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TY_METRIC | Public | Type reference (TYPE) | /IWBEP/IF_SBUI_SETUP_SERVICE=>TY_METRIC | gui sizing metric | 20120113 | |
| 2 | TY_POSITION | Public | Type reference (TYPE) | /IWBEP/IF_SBUI_SETUP_SERVICE=>TY_POSITION | simple position value | 20120524 | |
| 3 | TY_SIZE | Public | Type reference (TYPE) | /IWBEP/IF_SBUI_SETUP_SERVICE=>TY_SIZE | simple size value | 20120126 | |
| 4 | TY_S_AREA | Public | Type reference (TYPE) | /IWBEP/IF_SBUI_SETUP_SERVICE=>TY_S_AREA | component area (left, top, right, bottom) | 20120524 | |
| 5 | TY_S_NAME | Public | Type reference (TYPE) | /IWBEP/IF_SBUI_SETUP_SERVICE=>TY_S_COMPONENT_NAME | component name (plugin, component) | 20120116 | |
| 6 | TY_S_SIZE | Public | Type reference (TYPE) | /IWBEP/IF_SBUI_SETUP_SERVICE=>TY_S_SIZE | component size (width, height) | 20120113 | |
| 7 | TY_T_COMPONENT | Public | See coding | collection of components | 20130413 | TY_T_COMPONENT type standard table of ref to /IWBEP/IF_SBUI_COMPONENT with default key
|
|
| 8 | TY_T_INTERACTIVE | Public | Type reference (TYPE) | /IWBEP/T_SBUI_INTERACTIVE | collection of interative components | 20120218 | |
Method Signatures
Method GET_INTERACTIVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IO_SCOPE | Call by reference | Object reference (TYPE REF TO) | /IWBEP/IF_SBUI_DYNPRO_BASED | search scope restriction to a screen (excluding subscreens) | 20120613 | ||
| 2 |  Returning |
RT_INTERACTIVE | Value transfer | Type reference (TYPE) | TY_T_INTERACTIVE | collaction of interactive components | 20120410 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  /IWBEP/CX_SBCM_EXCEPTION |
SB: exception | 20120410 |
Method GET_OPTIONS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RO_OPTIONS | Value transfer | Object reference (TYPE REF TO) | /IWBEP/IF_SBUI_DISPLAY_OPTIONS | display options | 20130413 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /IWBEP/CX_SBCM_EXCEPTION |
SB: exception | 20130413 |
Method GET_PARENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RO_PARENT | Value transfer | Object reference (TYPE REF TO) | /IWBEP/IF_SBUI_COMPOSITE | parent, can be initial | 20120131 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /IWBEP/CX_SBCM_EXCEPTION |
SB: exception | 20120131 |
Method GET_SIZE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_METRIC | Call by reference | Type reference (TYPE) | TY_METRIC | gui sizing metric | 20120113 | ||
| 2 | Importing |
IV_PROPOSAL | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | proposed size requested, not real current size | 20120618 | |
| 3 | Returning |
RS_SIZE | Value transfer | Type reference (TYPE) | TY_S_SIZE | calculated size | 20120113 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /IWBEP/CX_SBCM_EXCEPTION |
SB: exception | 20120113 |
Method GET_STATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RO_STATE | Value transfer | Object reference (TYPE REF TO) | /IWBEP/IF_SBUI_DISPLAY_STATE | current settings (memento) | 20130913 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /IWBEP/CX_SBCM_EXCEPTION |
SB: exception | 20130913 |
Method GET_VISIBILITY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RV_VISIBLE | Value transfer | Type reference (TYPE) | ABAP_BOOL | visible or not ? | 20120718 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /IWBEP/CX_SBCM_EXCEPTION |
SB: exception | 20120718 |
Method SET_OPTIONS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_OPTIONS | Value transfer | Object reference (TYPE REF TO) | /IWBEP/IF_SBUI_DISPLAY_OPTIONS | display options | 20130413 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /IWBEP/CX_SBCM_EXCEPTION |
SB: exception | 20130413 |
Method SET_PARENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_PARENT | Call by reference | Object reference (TYPE REF TO) | /IWBEP/IF_SBUI_COMPOSITE | parent (initial == detach from previous parent only) | 20120116 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /IWBEP/CX_SBCM_EXCEPTION |
SB: exception | 20120116 |
Method SET_SIZE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IS_SIZE | Value transfer | Type reference (TYPE) | TY_S_SIZE | calculated size | 20120113 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /IWBEP/CX_SBCM_EXCEPTION |
SB: exception | 20120113 |
Method SET_STATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_STATE | Call by reference | Object reference (TYPE REF TO) | /IWBEP/IF_SBUI_DISPLAY_STATE | settings to be restored (memento) | 20130913 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /IWBEP/CX_SBCM_EXCEPTION |
SB: exception | 20130913 |
Method SET_VISIBILITY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_VISIBLE | Call by reference | Type reference (TYPE) | ABAP_BOOL | visible or not ? | 20120116 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | /IWBEP/CX_SBCM_EXCEPTION |
SB: exception | 20120116 |
History
| Last changed by/on | SAP | 20141120 |
| SAP Release Created in | 200 |
