SAP ABAP Interface IF_FPM_TABBED (Tabbed UIBB API)
Hierarchy
☛ SAP_UI (Software Component) User Interface Technology
   ⤷ BC-WD-CMP-FPM (Application Component) Floorplan Manager Web Dynpro ABAP
     ⤷ APB_FPM_CORE (Package) Floorplan Manager (Framework)
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  CL_FPM_TABBED Tabbed UIBB API 20070831
Properties
Interface IF_FPM_TABBED  
Short Description Tabbed UIBB API    
General Data
Package APB_FPM_CORE   Floorplan Manager (Framework) 
Created 20070829   SAP 
Last changed 20130531   SAP 
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 CL_FPM_TABBED Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
2 IF_FPM_OIF Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
Interfaces
# Interface Abstract Final Description Created on
1 IF_FPM_WIRE_MODEL Interface for Communication FPM App CC. Wire Model 20090625
Friends
Interface IF_FPM_TABBED has no friend.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 MO_EVENT Instance attribute Public Object reference (TYPE REF TO) CL_FPM_EVENT CL_FPM_EVENT 20070906
2 MS_COMPONENT_KEY Instance attribute Public Type reference (TYPE) FPM_S_UIBB_KEY Key of a UIBB to be embedded in an FPM based application 20070906
Methods
# Method Level Visibility Method type Description Created on
1 ADD_MASTER_UIBB Instance method Public Method Adds a UIBB to the master area 20070830
2 ADD_TAB Instance method Public Method Adds a tab within a certain tab variant 20070830
3 ADD_TAB_UIBB Instance method Public Method Adds a UIBB to a certain tab 20070830
4 ADD_WIRE Instance method Public Method 20090626
5 GET_ACA_API Instance method Public Method 20080721
6 GET_CURRENT_TAB Instance method Public Method Gets the current selected tab 20070904
7 GET_CURRENT_VARIANT Instance method Public Method Gets the current selected variant 20070830
8 GET_DETAIL_AREA_TITLE Instance method Public Method 20090811
9 GET_MASTER_DETAIL_COLUMN Instance method Public Method 20120628
10 GET_MASTER_UIBB_KEYS Instance method Public Method Returns a list of all UIBBs for a specified master area 20070830
11 GET_TABS Instance method Public Method Returns a list of tabs for a given variant 20070830
12 GET_TABSTRIP_VISIBILITY Instance method Public Method informs about the visibility of the tabstrip 20070921
13 GET_TAB_UIBB_KEYS Instance method Public Method Returns a list of all UIBBs for a specified tab variant 20070830
14 GET_VARIANTS Instance method Public Method Gets a list of available variants 20070830
15 GET_WIRES Instance method Public Method 20090626
16 REMOVE_MASTER_UIBB Instance method Public Method Removes a UIBB from the master area 20070830
17 REMOVE_TAB Instance method Public Method Removes a tab within a certain tab variant 20070830
18 REMOVE_TAB_UIBB Instance method Public Method Removes a UIBB from a certain tab 20070830
19 REMOVE_WIRE Instance method Public Method 20090626
20 RENAME_TAB Instance method Public Method Renames a tab within a certain tab variant 20070830
21 SET_ACTION_TYPE Instance method Public Method Change Action Type of Detail Selection Action 20090810
22 SET_DETAIL_AREA_TITLE Instance method Public Method 20090811
23 SET_MASTER_UIBB_HIDDEN Instance method Public Method 20100508
24 SET_SELECTED_TAB Instance method Public Method Select next active tab 20070830
25 SET_TABSTRIP_VISIBILITY Instance method Public Method Changes the visibility of the tabstrip 20070921
26 SET_TAB_ACTIVE Instance method Public Method 20090120
27 SET_TAB_UIBB_HIDDEN Instance method Public Method 20100508
28 SET_TAB_VISIBLE Instance method Public Method 20080307
29 SET_VARIANT Instance method Public Method Select Variant 20070830
Events
Interface IF_FPM_TABBED has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 TY_S_TAB Public See coding 20070830 BEGIN OF ty_s_tab, variant TYPE string, id TYPE string, name TYPE string, END OF ty_s_tab
2 TY_S_UIBB_TAB_EXT Public See coding 20070831 BEGIN OF ty_s_uibb_tab_ext, variant TYPE string, tab TYPE string, component TYPE string, interface_view TYPE string, config_id TYPE wdy_config_id, config_type TYPE wdy_config_type, config_var TYPE wdy_config_var, hidden TYPE fpm_hidden, instance_id type FPM_INSTANCE_ID, END OF ty_s_uibb_tab_ext
3 TY_T_TAB Public See coding 20070830 ty_t_tab TYPE STANDARD TABLE OF ty_s_tab
4 TY_T_UIBB_TAB_EXT Public See coding 20070831 ty_t_uibb_tab_ext TYPE STANDARD TABLE OF ty_s_uibb_tab_ext
Method Signatures

Method ADD_MASTER_UIBB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_UIBB_KEY Call by reference Type reference (TYPE) FPM_S_UIBB_KEY Key of UIBB to be added 20070830
2 Importing IV_INDEX Call by reference Type reference (TYPE) I 9999 Place for the Insertion 20070830
# Exception Resumable Description Created on
1 CX_FPM_FLOORPLAN Floorplan exceptions 20080206

Method ADD_TAB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_UIBB Call by reference Type reference (TYPE) FPM_T_UIBB_KEY Table of UIBB keys (at least one entry is required) 20070830
2 Importing IV_INDEX Call by reference Type reference (TYPE) I 9999 Index of the new tab (default is add at last place) 20070830
3 Importing IV_TAB_ID Call by reference Type reference (TYPE) STRING The tab id which should be added 20070830
4 Importing IV_TAB_NAME Call by reference Type reference (TYPE) STRING The name of the new tab 20070830
5 Importing IV_VARIANT_ID Call by reference Type reference (TYPE) STRING Variant of the appropriate tab switch 20070830
# Exception Resumable Description Created on
1 CX_FPM_FLOORPLAN Floorplan exceptions 20070925

Method ADD_TAB_UIBB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_UIBB_KEY Call by reference Type reference (TYPE) FPM_S_UIBB_KEY Key of UIBB to be added 20070830
2 Importing IV_INDEX Call by reference Type reference (TYPE) I 9999 Place for the Insertion 20070830
3 Importing IV_TAB_ID Call by reference Type reference (TYPE) STRING The tab id to which the UIBBs should be added 20070830
4 Importing IV_VARIANT_ID Call by reference Type reference (TYPE) STRING Variant of the appropriate tab switch 20070830
# Exception Resumable Description Created on
1 CX_FPM_FLOORPLAN Floorplan exceptions 20070924

Method ADD_WIRE Signature

Method ADD_WIRE on Interface IF_FPM_TABBED has no parameter.
Method ADD_WIRE on Interface IF_FPM_TABBED has no exception.

Method GET_ACA_API Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RO_ACA_API Value transfer Object reference (TYPE REF TO) IF_FPM_ACA Additional Content Area API 20080721

Method GET_ACA_API on Interface IF_FPM_TABBED has no exception.

Method GET_CURRENT_TAB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_TAB_ID Value transfer Type reference (TYPE) STRING 20070904

Method GET_CURRENT_TAB on Interface IF_FPM_TABBED has no exception.

Method GET_CURRENT_VARIANT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_VARIANT_ID Value transfer Type reference (TYPE) STRING Variant ID 20070831

Method GET_CURRENT_VARIANT on Interface IF_FPM_TABBED has no exception.

Method GET_DETAIL_AREA_TITLE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_TITLE Value transfer Type reference (TYPE) STRING 20090811

Method GET_DETAIL_AREA_TITLE on Interface IF_FPM_TABBED has no exception.

Method GET_MASTER_DETAIL_COLUMN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_MASTER_DETAIL_COLUMN_NAME Value transfer Type reference (TYPE) STRING 20120628

Method GET_MASTER_DETAIL_COLUMN on Interface IF_FPM_TABBED has no exception.

Method GET_MASTER_UIBB_KEYS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_UIBB Call by reference Type reference (TYPE) FPM_T_UIBB_KEY List of UIBBs 20070830

Method GET_MASTER_UIBB_KEYS on Interface IF_FPM_TABBED has no exception.

Method GET_TABS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_TAB Value transfer Type reference (TYPE) TY_T_TAB List of tabs 20070831
2 Importing IV_VARIANT_ID Call by reference Type reference (TYPE) STRING Variant ID (current variant if skipped) 20070830
# Exception Resumable Description Created on
1 CX_FPM_FLOORPLAN Floorplan exceptions 20070924

Method GET_TABSTRIP_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) BOOLE_D Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') 20070921

Method GET_TABSTRIP_VISIBILITY on Interface IF_FPM_TABBED has no exception.

Method GET_TAB_UIBB_KEYS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_UIBB Value transfer Type reference (TYPE) TY_T_UIBB_TAB_EXT List of UIBBs 20070831
2 Importing IV_TAB_ID Call by reference Type reference (TYPE) STRING The tab id to which the UIBBs should be read 20070830
3 Importing IV_VARIANT_ID Call by reference Type reference (TYPE) STRING Variant of the appropriate tab switch 20070830
# Exception Resumable Description Created on
1 CX_FPM_FLOORPLAN Floorplan exceptions 20070924

Method GET_VARIANTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_VARIANT Value transfer Type reference (TYPE) IF_FPM_OIF=>TY_T_VARIANT Variant IDs 20070831

Method GET_VARIANTS on Interface IF_FPM_TABBED has no exception.

Method GET_WIRES Signature

Method GET_WIRES on Interface IF_FPM_TABBED has no parameter.
Method GET_WIRES on Interface IF_FPM_TABBED has no exception.

Method REMOVE_MASTER_UIBB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_INDEX Call by reference Type reference (TYPE) I Index of UIBB to be removed 20070830
# Exception Resumable Description Created on
1 CX_FPM_FLOORPLAN Floorplan exceptions 20070924

Method REMOVE_TAB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_TAB_ID Call by reference Type reference (TYPE) STRING Tab ID (current tab if skipped) 20070830
2 Importing IV_VARIANT_ID Call by reference Type reference (TYPE) STRING Variant ID (current variant if skipped) 20070830
# Exception Resumable Description Created on
1 CX_FPM_FLOORPLAN Floorplan exceptions 20070924

Method REMOVE_TAB_UIBB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_INDEX Call by reference Type reference (TYPE) I Place for the Insertion 20070830
2 Importing IV_TAB_ID Call by reference Type reference (TYPE) STRING The tab id to which the UIBBs should be added 20070830
3 Importing IV_VARIANT_ID Call by reference Type reference (TYPE) STRING Variant of the appropriate tab switch 20070830
# Exception Resumable Description Created on
1 CX_FPM_FLOORPLAN Floorplan exceptions 20070924

Method REMOVE_WIRE Signature

Method REMOVE_WIRE on Interface IF_FPM_TABBED has no parameter.
Method REMOVE_WIRE on Interface IF_FPM_TABBED has no exception.

Method RENAME_TAB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_NEW_NAME Call by reference Type reference (TYPE) STRING New name of the tab 20070830
2 Importing IV_TAB_ID Call by reference Type reference (TYPE) STRING The tab which should be renamed 20070830
3 Importing IV_VARIANT_ID Call by reference Type reference (TYPE) STRING Variant of the appropriate tab switch 20070830
# Exception Resumable Description Created on
1 CX_FPM_FLOORPLAN Floorplan exceptions 20070925

Method SET_ACTION_TYPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ACTION_TYPE Call by reference Type reference (TYPE) FPM_ACTION_TYPE_SELECT_DETAIL Action Type of OVP Call Personalization Dialog Event 20090810
2 Importing IV_VARIANT Call by reference Type reference (TYPE) FPM_VARIANT_ID FPM: ID of the variant 20090810
# Exception Resumable Description Created on
1 CX_FPM_FLOORPLAN Floorplan exceptions 20090810

Method SET_DETAIL_AREA_TITLE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_TITLE Call by reference Type reference (TYPE) STRING 20090811

Method SET_DETAIL_AREA_TITLE on Interface IF_FPM_TABBED has no exception.

Method SET_MASTER_UIBB_HIDDEN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_HIDDEN Call by reference Type reference (TYPE) BOOLE_D Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') 20100508
2 Importing IV_INDEX Call by reference Type reference (TYPE) I 20100508
# Exception Resumable Description Created on
1 CX_FPM_FLOORPLAN Floorplan exceptions 20100508

Method SET_SELECTED_TAB Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_TAB_ID Call by reference Type reference (TYPE) STRING ID of new active tab 20070831
2 Importing IV_VARIANT_ID Call by reference Type reference (TYPE) STRING Variant ID 20070831
# Exception Resumable Description Created on
1 CX_FPM_FLOORPLAN Floorplan exceptions 20070925

Method SET_TABSTRIP_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) BOOLE_D Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') 20070921

Method SET_TABSTRIP_VISIBILITY on Interface IF_FPM_TABBED has no exception.

Method SET_TAB_ACTIVE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_IS_ACTIVE Call by reference Type reference (TYPE) BOOLE_D Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') 20090120
2 Importing IV_TAB_ID Call by reference Type reference (TYPE) STRING 20090120

Method SET_TAB_ACTIVE on Interface IF_FPM_TABBED has no exception.

Method SET_TAB_UIBB_HIDDEN Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_HIDDEN Call by reference Type reference (TYPE) FPM_HIDDEN Element is hidden 20100508
2 Importing IV_INDEX Call by reference Type reference (TYPE) I 20100508
3 Importing IV_TAB_ID Call by reference Type reference (TYPE) STRING 20100508
4 Importing IV_VARIANT_ID Call by reference Type reference (TYPE) STRING 20100508
# Exception Resumable Description Created on
1 CX_FPM_FLOORPLAN Floorplan exceptions 20100508

Method SET_TAB_VISIBLE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_TAB_ID Call by reference Type reference (TYPE) STRING 20080307
2 Importing IV_VISIBLE Call by reference Type reference (TYPE) BOOLE_D Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') 20080307

Method SET_TAB_VISIBLE on Interface IF_FPM_TABBED has no exception.

Method SET_VARIANT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_VARIANT_ID Call by reference Type reference (TYPE) STRING new active variant ID 20070831
# Exception Resumable Description Created on
1 CX_FPM_FLOORPLAN Floorplan exceptions 20070924
History
Last changed by/on SAP  20130531 
SAP Release Created in 700