SAP ABAP Class /IWBEP/CL_SBUI_COMPONENT (SB: UI component)
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
Meta Relationship - Using
# Relationship type Using Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  /IWBEP/IF_SBCM_MSG_CONTEXT SB: message context 20120118
2 Interface implementation (CLASS c. INTERFACES i_ref)  /IWBEP/IF_SBUI_COMPONENT SB: UI component (displays something in a window) 20120113
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Inheritance (c INHERITING FROM c_ref)  /IWBEP/CL_SBUI_CONTROL_HANDLER SB: UI control handler 20120116
2 Inheritance (c INHERITING FROM c_ref)  /IWBEP/CL_SBUI_DYNPRO_HANDLER SB: UI dynpro handler (state of a screen) 20120116
3 Inheritance (c INHERITING FROM c_ref)  /IWBEP/CL_SBUI_TABSTRIP SB: UI tabstrip (handles one control in host dynpro) 20120304
Properties
Class /IWBEP/CL_SBUI_COMPONENT  
Short Description SB: UI component    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class /IWBEP/SBUI    
Program status P  SAP Standard Production Program 
Category 0   
Package /IWBEP/SB_UI_BASE   Gateway Service Builder UI - API and SPI 
Created 20120113   SAP 
Last change 20141120    
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 /IWBEP/IF_SBUI_COMPONENT Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
2 /IWBEP/IF_SBUI_SETUP_SERVICE Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
3 ABAP Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
4 CL_GUI_CONTAINER Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
5 CNTL 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
2 /IWBEP/IF_SBUI_COMPONENT SB: UI component (displays something in a window) 20120113
Friends
Class /IWBEP/CL_SBUI_COMPONENT has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 GC_METRIC_DYNPRO Instance attribute Protected Attribute reference (LIKE) 20120218
2 GC_METRIC_MILLIMETER Instance attribute Protected Attribute reference (LIKE) 20120218
3 GC_METRIC_PIXEL Instance attribute Protected Attribute reference (LIKE) 20120218
4 GC_METRIC_RELATIVE Instance attribute Protected Attribute reference (LIKE) 20120218
5 MO_CONTROLLER Instance attribute Protected Object reference (TYPE REF TO) /IWBEP/IF_SBUI_CONTROLLER controller 20120113
6 MO_DISPLAY_OPTIONS Instance attribute Private Object reference (TYPE REF TO) /IWBEP/IF_SBUI_DISPLAY_OPTIONS display options 20130413
7 MO_MESSAGE_UTILITY Instance attribute Protected Object reference (TYPE REF TO) /IWBEP/IF_SBCM_MSG_UTILITY message utility 20120308
8 MO_PARENT Instance attribute Protected Object reference (TYPE REF TO) /IWBEP/IF_SBUI_COMPOSITE parent 20120116
9 MO_SETUP_SERVICE Instance attribute Protected Object reference (TYPE REF TO) /IWBEP/IF_SBUI_SETUP_SERVICE setup service 20120625
10 MS_NAME Instance attribute Public Attribute reference (LIKE) 20120119
11 MS_SIZE Instance attribute Private Type reference (TYPE) /IWBEP/IF_SBUI_COMPONENT=>TY_S_SIZE calculated size 20120113
12 MT_DYNPRO_CONTAINER Instance attribute Private Type reference (TYPE) TY_T_CONTAINER dynpro-bound containers 20120213
13 MV_CATEGORY Instance attribute Public Attribute reference (LIKE) 20120216
14 MV_DISABLED Instance attribute Public Attribute reference (LIKE) 20130417
15 MV_DYNPRO_ACTIVE Instance attribute Private Type reference (TYPE) ABAP_BOOL dynpro-bound containers enabled? 20120213
16 MV_ICON Instance attribute Public Attribute reference (LIKE) 20130419
17 MV_LABEL Instance attribute Public Attribute reference (LIKE) 20120119
Methods
# Method Level Visibility Method type Description Created on
1 CONSTRUCTOR Instance method Public Constructor CONSTRUCTOR 20120113
2 CONVERT_SIZE_METRIC Instance method Protected Method utility: convert size into target metric 20120124
3 CREATE_CONTROL_CONTAINER Instance method Protected Method utility: build container (inside parent or linked to dynpro) 20120124
4 CREATE_CONTROL_TOOLBAR Instance method Protected Method utility: build local control menu (toolbar with client area) 20120128
5 CREATE_ICON_TOOLTIP Instance method Protected Method utility: create icon with tooltip 20130506
6 DELETE_CONTROL_CONTAINER Instance method Protected Method utility: free container and the whole content 20120124
7 DO_BACKUP_DISPLAY_STATE Instance method Protected Method template method (optional): backup display state (memento) 20130913
8 DO_PROPOSE_CLIENT_SIZE Instance method Protected Method template method (optional): calculate requested client size 20120525
9 DO_RESTORE_DISPLAY_STATE Instance method Protected Method template method (optional): restore display state (memento) 20130913
10 DO_SEARCH_INTERACTIVE Instance method Protected Method template method (optional): search interactive components 20120218
11 DO_SEARCH_INTERACTIVE_PRECHECK Instance method Protected Method template method (optional): search interactive pre-check 20120613
12 DO_UPDATE_SIZING Instance method Protected Method template method (optional): calculate inner elements sizing 20120116
13 ENABLE_CONTROL_DISPLAY Instance method Protected Method utility: enable or disable control display on dynpro level 20120213
14 FREE Instance method Public Method free all allocated resources (mainly controls) 20120615
15 GET_ANCESTOR_NODE Instance method Protected Method utility: get ancestor node with given node type 20120320
16 GET_AVAILABLE_HEIGHT Instance method Protected Method utility: get available height in a target metric 20120228
17 GET_AVAILABLE_WIDTH Instance method Protected Method utility: get available width in a target metric 20120228
18 GET_CONTAINER_VISIBILITY Instance method Protected Method utility: get container visibility 20120718
19 GET_INTERACTIVE Instance method Public Method 20120218
20 GET_OPTIONS Instance method Public Method 20130413
21 GET_PARENT Instance method Public Method 20120218
22 GET_PROPOSED_AREA Instance method Protected Method utility: get proposed client area 20120525
23 GET_SIZE Instance method Public Method 20120117
24 GET_STATE Instance method Public Method 20130916
25 GET_VISIBILITY Instance method Public Method 20120718
26 RAISE_CONTROL_ERROR Instance method Protected Method utility: raise control framework error 20120116
27 SET_CONTAINER_VISIBILITY Instance method Protected Method utility: set container visibility 20120124
28 SET_OPTIONS Instance method Public Method 20130413
29 SET_PARENT Instance method Public Method 20120304
30 SET_SIZE Instance method Public Method 20120117
31 SET_STATE Instance method Public Method 20130916
32 SET_VISIBILITY Instance method Public Method 20120117
Events
Class /IWBEP/CL_SBUI_COMPONENT has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 TY_METRIC Protected Attribute reference (LIKE) 20120218
2 TY_POSITION Protected Attribute reference (LIKE) 20120524
3 TY_SIZE Protected Attribute reference (LIKE) 20120218
4 TY_S_AREA Protected Attribute reference (LIKE) 20120524
5 TY_S_CONTAINER Private See coding control container 20120213 BEGIN OF ty_s_container , object TYPE REF TO cl_gui_container , parent TYPE REF TO cl_gui_container , visible TYPE abap_bool , END OF ty_s_container
6 TY_S_NAME Protected Attribute reference (LIKE) 20120218
7 TY_S_SIZE Protected Attribute reference (LIKE) 20120218
8 TY_T_COMPONENT Protected Attribute reference (LIKE) 20130417
9 TY_T_CONTAINER Private See coding control container table 20120213 ty_t_container TYPE SORTED TABLE OF ty_s_container WITH UNIQUE KEY object
10 TY_T_INTERACTIVE Protected Attribute reference (LIKE) 20120218
Method Signatures

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_CONTROLLER Call by reference Object reference (TYPE REF TO) /IWBEP/IF_SBUI_CONTROLLER main controller 20120113
2 Importing IV_NAME Call by reference Type reference (TYPE) /IWBEP/SBUI_COMPONENT component name 20120119
3 Importing IV_PLUGIN Call by reference Type reference (TYPE) /IWBEP/SBUI_PLUGIN component plugin 20120119
# Exception Resumable Description Created on
1 /IWBEP/CX_SBCM_EXCEPTION SB: exception 20120113

Method CONVERT_SIZE_METRIC Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_SIZE Call by reference Type reference (TYPE) TY_S_SIZE source size 20120124
2 Importing IV_METRIC Call by reference Type reference (TYPE) TY_METRIC target metric 20120124
3 Returning RS_SIZE Value transfer Type reference (TYPE) TY_S_SIZE target size 20120124
# Exception Resumable Description Created on
1 /IWBEP/CX_SBCM_EXCEPTION SB: exception 20120124

Method CREATE_CONTROL_CONTAINER 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) CL_GUI_CONTAINER parent container 20120124
2 Importing IV_AREA Call by reference Type reference (TYPE) SCREEN-NAME screen area to be linked 20120124
3 Importing IV_STYLE Call by reference Type reference (TYPE) I special container style 20120615
4 Importing IV_TYPE Call by reference Type reference (TYPE) I CL_GUI_CONTAINER=>CONTAINER_TYPE_SIMPLE special container type 20120615
5 Importing IV_VISIBLE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE initially visible or not ? 20120124
6 Returning RO_CONTAINER Value transfer Object reference (TYPE REF TO) CL_GUI_CONTAINER new container 20120124
# Exception Resumable Description Created on
1 /IWBEP/CX_SBCM_EXCEPTION SB: exception 20120124

Method CREATE_CONTROL_TOOLBAR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EO_CLIENT Call by reference Object reference (TYPE REF TO) CL_GUI_CONTAINER remaining client container underneath the toolbar 20120128
2 Exporting EO_TOOLBAR Call by reference Object reference (TYPE REF TO) CL_GUI_TOOLBAR toolbar control 20120128
3 Importing IO_PARENT Value transfer Object reference (TYPE REF TO) CL_GUI_CONTAINER parent container 20120128
4 Importing IT_BUTTON Call by reference Type reference (TYPE) TTB_BUTTON toolbar buttons 20120128
# Exception Resumable Description Created on
1 /IWBEP/CX_SBCM_EXCEPTION SB: exception 20120128

Method CREATE_ICON_TOOLTIP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ICON Call by reference Type reference (TYPE) ICON_D image 20130506
2 Importing IV_TOOLTIP Call by reference Type reference (TYPE) CSEQUENCE tooltip 20130506
3 Returning RV_RESULT Value transfer Type reference (TYPE) TV_IMAGE tree icon 20130506
# Exception Resumable Description Created on
1 /IWBEP/CX_SBCM_EXCEPTION SB: exception 20130506

Method DELETE_CONTROL_CONTAINER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_CONTAINER Call by reference Object reference (TYPE REF TO) CL_GUI_CONTAINER container to be destroyed 20120124
# Exception Resumable Description Created on
1 /IWBEP/CX_SBCM_EXCEPTION SB: exception 20120124

Method DO_BACKUP_DISPLAY_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 display state (settings of one component, memento) 20130913
# Exception Resumable Description Created on
1 /IWBEP/CX_SBCM_EXCEPTION SB: exception 20130913

Method DO_PROPOSE_CLIENT_SIZE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RS_SIZE Value transfer Type reference (TYPE) TY_S_SIZE client size 20120525
# Exception Resumable Description Created on
1 /IWBEP/CX_SBCM_EXCEPTION SB: exception 20120525

Method DO_RESTORE_DISPLAY_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 display state (settings of one component, memento) 20130913
# Exception Resumable Description Created on
1 /IWBEP/CX_SBCM_EXCEPTION SB: exception 20130913

Method DO_SEARCH_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 interactive components 20120218
# Exception Resumable Description Created on
1 /IWBEP/CX_SBCM_EXCEPTION SB: exception 20120218

Method DO_SEARCH_INTERACTIVE_PRECHECK 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 RV_CONTINUE Value transfer Type reference (TYPE) ABAP_BOOL exclude me from search 20120613
# Exception Resumable Description Created on
1 /IWBEP/CX_SBCM_EXCEPTION SB: exception 20120613

Method DO_UPDATE_SIZING Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_SIZE Call by reference Type reference (TYPE) /IWBEP/IF_SBUI_COMPONENT=>TY_S_SIZE new size of the whole component 20120116
# Exception Resumable Description Created on
1 /IWBEP/CX_SBCM_EXCEPTION SB: exception 20120116

Method ENABLE_CONTROL_DISPLAY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ACTIVE Call by reference Type reference (TYPE) ABAP_BOOL active or not ? 20120213
# Exception Resumable Description Created on
1 /IWBEP/CX_SBCM_EXCEPTION SB: exception 20120213

Method FREE Signature

Method FREE on class /IWBEP/CL_SBUI_COMPONENT has no parameter.
# Exception Resumable Description Created on
1 /IWBEP/CX_SBCM_EXCEPTION SB: exception 20120615

Method GET_ANCESTOR_NODE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_NODE Call by reference Object reference (TYPE REF TO) /IWBEP/IF_SBDM_NODE node to start search upwards the tree 20120320
2 Importing IS_NODE_TYPE Call by reference Type reference (TYPE) /IWBEP/S_SBDM_NODE_TYPE node type of the ancestor that is searched 20120320
3 Importing IV_DISTANCE Call by reference Type reference (TYPE) I 1 logical distance of ancestor ( 1, 2, ... topmost == 0 ) 20130522
4 Returning RO_ANCESTOR Value transfer Object reference (TYPE REF TO) /IWBEP/IF_SBDM_NODE ancestor with the request node type ( initial == not found ) 20120320
# Exception Resumable Description Created on
1 /IWBEP/CX_SBCM_EXCEPTION SB: exception 20120320

Method GET_AVAILABLE_HEIGHT 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) /IWBEP/IF_SBUI_COMPONENT=>TY_METRIC target metric 20120228
2 Returning RV_HEIGHT Value transfer Type reference (TYPE) TY_SIZE available height 20120228
# Exception Resumable Description Created on
1 /IWBEP/CX_SBCM_EXCEPTION SB: exception 20120228

Method GET_AVAILABLE_WIDTH 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) /IWBEP/IF_SBUI_COMPONENT=>TY_METRIC target metric 20120228
2 Returning RV_WIDTH Value transfer Type reference (TYPE) TY_SIZE available width 20120228
# Exception Resumable Description Created on
1 /IWBEP/CX_SBCM_EXCEPTION SB: exception 20120228

Method GET_CONTAINER_VISIBILITY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_CONTAINER Call by reference Object reference (TYPE REF TO) CL_GUI_CONTAINER container 20120718
2 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 GET_INTERACTIVE Signature

Method GET_INTERACTIVE on class /IWBEP/CL_SBUI_COMPONENT has no parameter.
Method GET_INTERACTIVE on class /IWBEP/CL_SBUI_COMPONENT has no exception.

Method GET_OPTIONS Signature

Method GET_OPTIONS on class /IWBEP/CL_SBUI_COMPONENT has no parameter.
Method GET_OPTIONS on class /IWBEP/CL_SBUI_COMPONENT has no exception.

Method GET_PARENT Signature

Method GET_PARENT on class /IWBEP/CL_SBUI_COMPONENT has no parameter.
Method GET_PARENT on class /IWBEP/CL_SBUI_COMPONENT has no exception.

Method GET_PROPOSED_AREA 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 target metric 20120525
2 Returning RS_AREA Value transfer Type reference (TYPE) TY_S_AREA proposed area 20120525
# Exception Resumable Description Created on
1 /IWBEP/CX_SBCM_EXCEPTION SB: exception 20120525

Method GET_SIZE Signature

Method GET_SIZE on class /IWBEP/CL_SBUI_COMPONENT has no parameter.
Method GET_SIZE on class /IWBEP/CL_SBUI_COMPONENT has no exception.

Method GET_STATE Signature

Method GET_STATE on class /IWBEP/CL_SBUI_COMPONENT has no parameter.
Method GET_STATE on class /IWBEP/CL_SBUI_COMPONENT has no exception.

Method GET_VISIBILITY Signature

Method GET_VISIBILITY on class /IWBEP/CL_SBUI_COMPONENT has no parameter.
Method GET_VISIBILITY on class /IWBEP/CL_SBUI_COMPONENT has no exception.

Method RAISE_CONTROL_ERROR Signature

Method RAISE_CONTROL_ERROR on class /IWBEP/CL_SBUI_COMPONENT has no parameter.
# Exception Resumable Description Created on
1 /IWBEP/CX_SBCM_EXCEPTION SB: exception 20120116

Method SET_CONTAINER_VISIBILITY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_CONTAINER Call by reference Object reference (TYPE REF TO) CL_GUI_CONTAINER container 20120124
2 Importing IV_VISIBLE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE visible or not ? 20120124
# Exception Resumable Description Created on
1 /IWBEP/CX_SBCM_EXCEPTION SB: exception 20120124

Method SET_OPTIONS Signature

Method SET_OPTIONS on class /IWBEP/CL_SBUI_COMPONENT has no parameter.
Method SET_OPTIONS on class /IWBEP/CL_SBUI_COMPONENT has no exception.

Method SET_PARENT Signature

Method SET_PARENT on class /IWBEP/CL_SBUI_COMPONENT has no parameter.
Method SET_PARENT on class /IWBEP/CL_SBUI_COMPONENT has no exception.

Method SET_SIZE Signature

Method SET_SIZE on class /IWBEP/CL_SBUI_COMPONENT has no parameter.
Method SET_SIZE on class /IWBEP/CL_SBUI_COMPONENT has no exception.

Method SET_STATE Signature

Method SET_STATE on class /IWBEP/CL_SBUI_COMPONENT has no parameter.
Method SET_STATE on class /IWBEP/CL_SBUI_COMPONENT has no exception.

Method SET_VISIBILITY Signature

Method SET_VISIBILITY on class /IWBEP/CL_SBUI_COMPONENT has no parameter.
Method SET_VISIBILITY on class /IWBEP/CL_SBUI_COMPONENT has no exception.
History
Last changed by/on SAP  20141120 
SAP Release Created in 200