SAP ABAP Class CL_FPM_TABBED_CONFIG_READER (Configuration Reader for tabbed UIBB)

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 - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_FPM_CONFIG_READER	Configuration Reader for OIF	20090115

Properties

Class	CL_FPM_TABBED_CONFIG_READER
Short Description	Configuration Reader for tabbed UIBB
Super Class	CL_FPM_CONFIG_READER	Configuration Reader for OIF
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	APB_FPM_CORE	Floorplan Manager (Framework)
Created	20090115	SAP
Last change	20140121	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_FPM_TABBED_CONFIG_WRITER	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...
3	IF_FPM_TABBED	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_FPM_TABBED_CONFIG_READER has no interface implemented.

Friends

Class CL_FPM_TABBED_CONFIG_READER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	COMPONENT_NAME	Constant	Public	☐	Type reference (TYPE)	STRING	'FPM_OIF_COMPONENT'		20090115
2	GC_TABBED	Constant	Public	☐	Type reference (TYPE)	STRING	'TABBED'		20090115
3	MR_PROPERTIES_STRUCTURE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ABAP_DATADESCR		Runtime Type Services	20090117
4	MR_TABBED_STRUCTURE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ABAP_DATADESCR		Runtime Type Services	20090115
5	MR_TAB_STRUCTURE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ABAP_DATADESCR			20090116
6	MR_TAB_UIBB_STRUCTURE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ABAP_DATADESCR		Runtime Type Services	20090116
7	MR_UIBB_STRUCTURE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ABAP_DATADESCR		Runtime Type Services	20090115
8	MR_VARIANT_STRUCTURE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ABAP_DATADESCR		Runtime Type Services	20090115
9	MR_WIRE_PLUG_STRUCTURE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_ABAP_DATADESCR		Runtime Type Services	20090701
10	MS_WIRE_PLUG	Instance attribute	Private	☐	Type reference (TYPE)	TY_S_WIRE_PLUG_EXT			20090701
11	MT_CONF_COMP_USAGE	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_CONF_COMP_USAGE_INT			20120217
12	MT_MASTER_UIBB	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_MASTER_UIBB_INT			20120216
13	MT_MASTER_UIBBS	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_UIBB_EXT		Table of UIBB keys (with location in OIF)	20090116
14	MT_PROPERTIES	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_PROPERTIES			20090117
15	MT_TAB	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_TAB_INT			20120217
16	MT_TAB_UIBBS	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_UIBB_TAB_EXT		Table of UIBB keys (with location in OIF)	20090116
17	MT_UIBB	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_TAB_UIBBS_INT			20120217
18	MT_VARIANT	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_VARIANT_INT			20120216
19	MT_WIRE	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_WIRE_INT			20120217
20	MV_TABBED_NODE_ID	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20090128
21	MV_TABBED_PATH	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20090116

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20090115
2	CREATE_TABBED_NODE_ID	Instance method	Private	Method		20090115
3	GET_APP_SPECIFIC_CC	Instance method	Public	Method		20120217
4	GET_CONF_COMP_USAGE	Instance method	Public	Method		20120217
5	GET_MASTER_UIBB	Instance method	Public	Method	Returns a list of all UIBBs for a specified master area	20120216
6	GET_MASTER_UIBB_KEYS	Instance method	Public	Method	Obsolet! Use GET_MASTER_UIBB instead	20090115
7	GET_PROPERTIES	Instance method	Public	Method		20120217
8	GET_TABS	Instance method	Public	Method	Returns a list of tabs for a given variant	20090115
9	GET_TABSTRIP_VISIBILITY	Instance method	Public	Method	informs about the visibility of the tabstrip	20090115
10	GET_TAB_UIBB	Instance method	Public	Method	Returns a list of all UIBBs for a specified tab variant	20120217
11	GET_TAB_UIBB_KEYS	Instance method	Public	Method	Obsollet! Use GET_TAB_UIBB	20090115
12	GET_VARIANT	Instance method	Public	Method	get a list of available variants	20120216
13	GET_VARIANTS	Instance method	Public	Method	OBSOLET! Use: GET_VARIANT	20090115
14	GET_WIRE	Instance method	Public	Method	Returns a list of tabs for a given variant	20120217
15	GET_WIRE_PLUG	Instance method	Public	Method		20090701

Events

Class CL_FPM_TABBED_CONFIG_READER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_S_CONF_COMP_USAGE	Public	See coding			20120217	BEGIN OF ty_s_conf_comp_usage , parent_path TYPE fpm_s_uibb_conf_comp_usage-parent_path, child_path TYPE fpm_s_uibb_conf_comp_usage-child_path, config_id TYPE fpm_s_uibb_conf_comp_usage-config_id, config_type TYPE fpm_s_uibb_conf_comp_usage-config_type, config_var TYPE fpm_s_uibb_conf_comp_usage-config_var, description TYPE fpm_s_uibb_conf_comp_usage-description, fpm_primary_attribute TYPE fpm_element_id, END OF ty_s_conf_comp_usage
2	TY_S_CONF_COMP_USAGE_INT	Private	See coding			20120217	BEGIN OF ty_s_conf_comp_usage_int. INCLUDE TYPE cl_fpm_tabbed_config_reader=>ty_s_conf_comp_usage. TYPES: path TYPE string, END OF ty_s_conf_comp_usage_int
3	TY_S_MASTER_UIBB	Public	See coding			20120216	BEGIN OF ty_s_master_uibb, component TYPE fpm_component_name, interface_view TYPE fpm_view_name, config_id TYPE wdy_config_id, config_type TYPE wdy_config_type, config_var TYPE wdy_config_var, needs_stretching TYPE fpm_needs_stretching, instance_id TYPE fpm_instance_id, hidden TYPE fpm_hidden, index TYPE fpm_index, fpm_primary_attribute TYPE fpm_element_id, END OF ty_s_master_uibb
4	TY_S_MASTER_UIBB_INT	Private	See coding			20120216	BEGIN OF ty_s_master_uibb_int. INCLUDE TYPE ty_s_master_uibb. TYPES: path TYPE string, END OF ty_s_master_uibb_int
5	TY_S_PROPERTIES	Public	See coding			20090117	BEGIN OF ty_s_properties, left_right_layout TYPE fpm_tab_left_right, use_ddlb TYPE wdy_boolean, one_tab_visibility TYPE wdy_boolean, master_rendering TYPE wdy_boolean, padding TYPE fpm_padding, END OF ty_s_properties
6	TY_S_TAB	Private	See coding			20090116	BEGIN OF ty_s_tab, variant TYPE string, id TYPE string, name TYPE string, index TYPE fpm_index, fpm_primary_attribute TYPE fpm_element_id, path TYPE string, END OF ty_s_tab
7	TY_S_TAB_INT	Private	See coding			20120217	BEGIN OF ty_s_tab_int. INCLUDE TYPE IF_FPM_TABBED=>TY_s_TAB. TYPES: path TYPE string, END OF ty_s_tab_int
8	TY_S_TAB_UIBBS_INT	Private	See coding			20120217	BEGIN OF ty_s_tab_uibbs_int. INCLUDE TYPE cl_fpm_tabbed_config_writer=>ty_s_tab_uibb. TYPES: path TYPE string, END OF ty_s_tab_uibbs_int
9	TY_S_UIBB_EXT	Private	See coding			20090116	BEGIN OF ty_s_uibb_ext, variant TYPE string, mainview TYPE string, subview 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, needs_stretching TYPE fpm_needs_stretching, hidden TYPE fpm_hidden, path TYPE string, instance_id TYPE fpm_instance_id, END OF ty_s_uibb_ext
10	TY_S_UIBB_TAB_EXT	Private	See coding			20090116	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, path TYPE string, instance_id TYPE fpm_instance_id, END OF ty_s_uibb_tab_ext
11	TY_S_VARIANT_INT	Private	See coding			20120216	BEGIN OF ty_s_variant_int. INCLUDE TYPE cl_fpm_tabbed_config_writer=>ty_s_tab_variant. TYPES: path TYPE string, END OF ty_s_variant_int
12	TY_S_WIRE_INT	Private	See coding			20120217	BEGIN OF ty_s_wire_int. INCLUDE TYPE cl_fpm_tabbed_config_writer=>ty_s_tab_wire. TYPES: path TYPE string, END OF ty_s_wire_int
13	TY_S_WIRE_PLUG_EXT	Private	See coding			20090701	BEGIN OF ty_s_wire_plug_ext. INCLUDE TYPE fpm_s_uibb_instance_key AS wire_plug. TYPES: path TYPE string, END OF ty_s_wire_plug_ext
14	TY_T_CONF_COMP_USAGE	Public	See coding			20120217	ty_t_conf_comp_usage TYPE STANDARD TABLE OF ty_s_conf_comp_usage
15	TY_T_CONF_COMP_USAGE_INT	Private	See coding			20120217	ty_t_conf_comp_usage_int TYPE STANDARD TABLE OF ty_s_conf_comp_usage_int
16	TY_T_MASTER_UIBB	Public	See coding			20120216	ty_t_master_uibb TYPE STANDARD TABLE OF ty_s_master_uibb
17	TY_T_MASTER_UIBB_INT	Private	See coding			20120216	ty_t_master_uibb_int TYPE STANDARD TABLE OF ty_s_master_uibb_int
18	TY_T_PROPERTIES	Private	See coding			20090117	ty_t_properties TYPE STANDARD TABLE OF ty_s_properties
19	TY_T_TAB	Private	See coding			20090116	ty_t_tab TYPE STANDARD TABLE OF ty_s_tab
20	TY_T_TAB_INT	Private	See coding			20120217	ty_t_tab_int TYPE STANDARD TABLE OF ty_s_tab_int
21	TY_T_TAB_UIBBS_INT	Private	See coding			20120217	ty_t_tab_uibbs_int TYPE STANDARD TABLE OF ty_s_tab_uibbs_int
22	TY_T_UIBB_EXT	Private	See coding			20090116	ty_t_uibb_ext TYPE STANDARD TABLE OF ty_s_uibb_ext
23	TY_T_UIBB_TAB_EXT	Private	See coding			20090116	ty_t_uibb_tab_ext TYPE STANDARD TABLE OF ty_s_uibb_tab_ext
24	TY_T_VARIANT_INT	Private	See coding			20120216	ty_t_variant_int TYPE STANDARD TABLE OF ty_s_variant_int
25	TY_T_WIRE_INT	Private	See coding			20120217	ty_t_wire_int TYPE STANDARD TABLE OF ty_s_wire_int

Method Signatures

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_APPL_READER	Call by reference	☑	Object reference (TYPE REF TO)	IF_WD_CONFIG_APPL_READER		Read Interface for Application Configuration	20090115
2	Importing	IR_COMP_READER	Call by reference	☑	Object reference (TYPE REF TO)	IF_WD_CONFIG_COMP_READER		Read Interface for the Component Configuration	20090115
3	Importing	IV_CONFIGURATION_ID	Call by reference	☐	Type reference (TYPE)	WDY_CONFIG_ID		Configuration Identification	20090115
4	Importing	IV_CONFIG_TYPE	Call by reference	☐	Type reference (TYPE)	WDY_CONFIG_TYPE		Type of Web Dynpro Configuration	20090115

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20090121

Method CREATE_TABBED_NODE_ID Signature

Method CREATE_TABBED_NODE_ID on class CL_FPM_TABBED_CONFIG_READER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20090121

Method GET_APP_SPECIFIC_CC Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ED_COMPONENT	Call by reference	☐	Type reference (TYPE)	FPM_COMPONENT_NAME			20120217
2	Exporting	ED_CONFIG_ID	Call by reference	☐	Type reference (TYPE)	WDY_CONFIG_ID			20120217
3	Exporting	ED_CONFIG_TYPE	Call by reference	☐	Type reference (TYPE)	WDY_CONFIG_TYPE			20120217
4	Exporting	ED_CONFIG_VAR	Call by reference	☐	Type reference (TYPE)	WDY_CONFIG_VAR			20120217

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20120217

Method GET_CONF_COMP_USAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CONF_COMP_USAGE	Call by reference	☐	Type reference (TYPE)	TY_T_CONF_COMP_USAGE			20120217

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20120217

Method GET_MASTER_UIBB 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)	TY_T_MASTER_UIBB		List of UIBBs	20120216

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20120216

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	20090115

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20090121

Method GET_PROPERTIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ES_PROPERTIES	Value transfer	☐	Type reference (TYPE)	TY_S_PROPERTIES			20120217

Method GET_PROPERTIES on class CL_FPM_TABBED_CONFIG_READER 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	Call by reference	☐	Type reference (TYPE)	IF_FPM_TABBED=>TY_T_TAB		List of tabs	20090115
2	Importing	IV_VARIANT_ID	Call by reference	☑	Type reference (TYPE)	STRING		Variant ID (current variant if skipped)	20090115

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20090115

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 (=' ')	20090115

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20090121

Method GET_TAB_UIBB 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)	CL_FPM_TABBED_CONFIG_WRITER=>TY_T_TAB_UIBBS		List of UIBBs	20120217
2	Importing	IV_TAB_ID	Call by reference	☑	Type reference (TYPE)	STRING		The tab id to which the UIBBs should be read	20120217
3	Importing	IV_VARIANT_ID	Call by reference	☑	Type reference (TYPE)	STRING		Variant of the appropriate tab switch	20120217

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20120217

Method GET_TAB_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)	IF_FPM_TABBED=>TY_T_UIBB_TAB_EXT		List of UIBBs	20090115
2	Importing	IV_TAB_ID	Call by reference	☑	Type reference (TYPE)	STRING		The tab id to which the UIBBs should be read	20090115
3	Importing	IV_VARIANT_ID	Call by reference	☑	Type reference (TYPE)	STRING		Variant of the appropriate tab switch	20090115

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20090115

Method GET_VARIANT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_VARIANT	Call by reference	☐	Type reference (TYPE)	CL_FPM_TABBED_CONFIG_WRITER=>TY_T_TAB_VARIANT		Table of Variants	20120216

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20120216

Method GET_VARIANTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_VARIANT	Call by reference	☐	Type reference (TYPE)	IF_FPM_OIF=>TY_T_VARIANT		Table of OIF Variants	20090115

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20090121

Method GET_WIRE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_WIRE	Call by reference	☐	Type reference (TYPE)	CL_FPM_TABBED_CONFIG_WRITER=>TY_T_TAB_WIRES		List of wires	20120217
2	Importing	IV_VARIANT_ID	Call by reference	☑	Type reference (TYPE)	STRING		Variant ID (current variant if skipped)	20120217

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20120217

Method GET_WIRE_PLUG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RS_WIRE_PLUG	Value transfer	☐	Type reference (TYPE)	FPM_S_UIBB_INSTANCE_KEY		UIBB Instance Key	20090701

#	Exception	Resumable	Description	Created on
1	CX_FPM_FLOORPLAN	☐	Floorplan exceptions	20090701

History

Last changed by/on	SAP	20140121
SAP Release Created in	720