SAP ABAP Class CL_FPM_GUIBB_BASE_CONF_READER (Configuration Reader GUIBB Base)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ BC-WD-CMP-FPM (Application Component) Floorplan Manager Web Dynpro ABAP
     ⤷ APB_FPM_GUIBB (Package) Generic UI building blocks

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	20090825

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_FPM_LIST_CONFIG_READER	Config reader class for list GUIBB	20091027

Properties

Class	CL_FPM_GUIBB_BASE_CONF_READER
Short Description	Configuration Reader GUIBB Base
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_GUIBB	Generic UI building blocks
Created	20090825	SAP
Last change	20141120
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	IF_FPM_OIF	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
2	IF_FPM_TABBED	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_FPM_GUIBB_BASE_CONF_READER has no interface implemented.

Friends

Class CL_FPM_GUIBB_BASE_CONF_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'		20090825
2	GC_TABBED	Constant	Public	☐	Type reference (TYPE)	STRING	'TABBED'		20090825
3	MR_COLUMN_STRUCTURE	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_ABAP_DATADESCR		Runtime Type Services	20090825
4	MR_ELEMENT_ACTION_STRUCTURE	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_ABAP_DATADESCR		Runtime Type Services	20090825
5	MR_ELEMENT_STRUCTURE	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_ABAP_DATADESCR		Runtime Type Services	20090825
6	MR_LIST_STRUCTURE	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_ABAP_DATADESCR		Runtime Type Services	20090825
7	MR_PARAMETER_STRUCTURE	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_ABAP_DATADESCR		Runtime Type Services	20090825
8	MR_SETTING_STRUCTURE	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_ABAP_DATADESCR		Runtime Type Services	20090825
9	MR_TOOLBAR_STRUCTURE	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_ABAP_DATADESCR		Runtime Type Services	20090825
10	MT_COLUMN	Instance attribute	Protected	☐	Type reference (TYPE)	TY_T_COLUMNS			20110112
11	MT_ELEMENTS	Instance attribute	Protected	☐	Type reference (TYPE)	TY_T_ELEMENTS			20090825
12	MT_ELEMENT_ACTIONS	Instance attribute	Protected	☐	Type reference (TYPE)	TY_T_ELEMENTS_ACTION			20090825
13	MT_LIST	Instance attribute	Protected	☐	Type reference (TYPE)	TY_T_LIST			20090825
14	MT_PARAMETERS	Instance attribute	Protected	☐	Type reference (TYPE)	TY_T_PARAMETER		Table of UIBB keys (with location in OIF)	20090825
15	MT_SETTINGS	Instance attribute	Protected	☐	Type reference (TYPE)	TY_T_SETTINGS			20090825
16	MT_TOOLBAR	Instance attribute	Protected	☐	Type reference (TYPE)	TY_T_TOOLBAR			20090825
17	MV_LIST_NODE_ID	Instance attribute	Protected	☐	Type reference (TYPE)	STRING			20090825
18	MV_LIST_PATH	Instance attribute	Protected	☐	Type reference (TYPE)	STRING			20090825

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20090825
2	CREATE_LIST_NODE_ID	Instance method	Protected	Method		20090825
3	GET_BR_ELEMENTS	Instance method	Public	Method		20090825
4	GET_BR_ELEMENT_ACTIONS	Instance method	Public	Method		20090825
5	GET_COLUMNS	Instance method	Public	Method		20090825
6	GET_LIST_ATTRIBUTES	Instance method	Public	Method		20090825
7	GET_PARAMETERS	Instance method	Public	Method		20090825
8	GET_SETTINGS	Instance method	Public	Method		20090825
9	GET_TOOLBAR	Instance method	Protected	Method		20090825

Events

Class CL_FPM_GUIBB_BASE_CONF_READER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_S_COLUMNS	Protected	See coding			20090825	BEGIN OF ty_s_columns , name TYPE name_komp, display_type TYPE fpmgb_display_type, index TYPE wdy_conf_index, header TYPE wdy_conf_transl_text, element_id TYPE fpm_element_id, special_parameters TYPE string, path TYPE string, END OF ty_s_columns
2	TY_S_ELEMENTS	Protected	See coding			20090825	BEGIN OF ty_s_elements, display_type TYPE fpmgb_display_type, index TYPE wdy_conf_index, text TYPE wdy_conf_transl_text, element_id TYPE string, path TYPE string, END OF ty_s_elements
3	TY_S_ELEMENT_ACTION	Protected	See coding			20090825	BEGIN OF ty_s_element_action , event_id TYPE fpm_event_id, text TYPE string, index TYPE wdy_conf_index, element_index TYPE wdy_conf_index, path TYPE string, END OF ty_s_element_action
4	TY_S_LIST	Protected	See coding			20090825	BEGIN OF ty_s_list , feeder TYPE c LENGTH 30, title TYPE wdy_conf_transl_text, lead_sel_event_id TYPE c LENGTH 30, END OF ty_s_list
5	TY_S_PARAMETER	Protected	See coding			20090825	BEGIN OF ty_s_parameter , name TYPE fpmgb_parameter_name, value TYPE fpmgb_parameter_value, path TYPE string, END OF ty_s_parameter
6	TY_S_SETTINGS	Protected	See coding			20090825	BEGIN OF ty_s_settings , visible_col_count TYPE int4, visible_row_count TYPE int4, sel_event_type TYPE c LENGTH 1, selection_mode TYPE n LENGTH 2, selection_change_behaviour TYPE n LENGTH 2, ctxt_menu_id TYPE fpm_ctxt_menu_id, style_of_rendering TYPE fpmgb_list_render_style, access_descr TYPE wdy_conf_transl_text, check_mandatory TYPE fpmgb_check_mandatory, export_excel TYPE fpmgb_excel_export, list_width TYPE fpm_list_width, initial_lead_selection TYPE fpmgb_set_lead_selection, table_visibility TYPE fpmgb_table_visibility, display_empty_rows TYPE fpmgb_table_empty_rows, scrollable_column_count TYPE fpmgb_non_scrollable_columns, enable_h_scrolling TYPE fpmgb_enabling_h_scrolling, grid_mode TYPE fpmgb_table_grid_mode, display_mode TYPE fpmgb_table_display_mode, aria_landmark type fpm_aria_landmark, path TYPE string, END OF ty_s_settings
7	TY_S_TOOLBAR	Protected	See coding			20090825	BEGIN OF ty_s_toolbar, display_type TYPE fpmgb_display_type, index TYPE wdy_conf_index, text TYPE wdy_conf_transl_text, element_id TYPE string, path TYPE string, END OF ty_s_toolbar
8	TY_T_COLUMNS	Protected	See coding			20090825	ty_t_columns TYPE STANDARD TABLE OF ty_s_columns
9	TY_T_ELEMENTS	Protected	See coding			20090825	ty_t_elements TYPE STANDARD TABLE OF ty_s_elements
10	TY_T_ELEMENTS_ACTION	Protected	See coding			20090825	ty_t_elements_action TYPE STANDARD TABLE OF ty_s_element_action
11	TY_T_LIST	Protected	See coding			20090825	ty_t_list TYPE STANDARD TABLE OF ty_s_list
12	TY_T_PARAMETER	Protected	See coding			20090825	ty_t_parameter TYPE STANDARD TABLE OF ty_s_parameter
13	TY_T_SETTINGS	Protected	See coding			20090825	ty_t_settings TYPE STANDARD TABLE OF ty_s_settings
14	TY_T_TOOLBAR	Protected	See coding			20090825	ty_t_toolbar TYPE STANDARD TABLE OF ty_s_toolbar

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	20090825
2	Importing	IR_COMP_READER	Call by reference	☑	Object reference (TYPE REF TO)	IF_WD_CONFIG_COMP_READER		Read Interface for the Component Configuration	20090825
3	Importing	IV_CONFIGURATION_ID	Call by reference	☐	Type reference (TYPE)	WDY_CONFIG_ID		Configuration Identification	20090825
4	Importing	IV_CONFIG_TYPE	Call by reference	☐	Type reference (TYPE)	WDY_CONFIG_TYPE		Type of Web Dynpro Configuration	20090825

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

Method CREATE_LIST_NODE_ID Signature

Method CREATE_LIST_NODE_ID on class CL_FPM_GUIBB_BASE_CONF_READER has no parameter.

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

Method GET_BR_ELEMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_BR_ELEMENTS	Call by reference	☐	Type reference (TYPE)	IF_FPM_GUIBB_LIST_CONFIG=>TY_T_BR_ELEMENTS			20090825

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

Method GET_BR_ELEMENT_ACTIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_BR_ELEMENT_ACTIONS	Call by reference	☐	Type reference (TYPE)	IF_FPM_GUIBB_LIST_CONFIG=>TY_T_BR_ELEMENTS_ACTION			20090825
2	Importing	IV_BR_ELEMENT_INDEX	Call by reference	☐	Type reference (TYPE)	WDY_CONF_INDEX			20090825

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

Method GET_COLUMNS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_COLUMNS	Call by reference	☐	Type reference (TYPE)	IF_FPM_GUIBB_LIST_CONFIG=>TY_T_COLUMNS			20090825

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

Method GET_LIST_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_FEEDER	Call by reference	☐	Type reference (TYPE)	CHAR30		30 Characters	20090825
2	Exporting	EV_LEAD_SEL_EVENT_ID	Call by reference	☐	Type reference (TYPE)	CHAR30		30 Characters	20090825
3	Exporting	EV_TITLE	Call by reference	☐	Type reference (TYPE)	WDY_CONF_TRANSL_TEXT		Web Dynpro: Configuration: Translatable Text	20090825

Method GET_LIST_ATTRIBUTES on class CL_FPM_GUIBB_BASE_CONF_READER has no exception.

Method GET_PARAMETERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_PARAMETERS	Call by reference	☐	Type reference (TYPE)	IF_FPM_GUIBB_LIST_CONFIG=>TY_T_PARAMETER			20090825

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

Method GET_SETTINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_ACCESS_DESCR	Call by reference	☐	Type reference (TYPE)	WDY_CONF_TRANSL_TEXT		Web Dynpro: Configuration: Translatable Text	20120227
2	Exporting	EV_ARIA_LANDMARK	Call by reference	☐	Type reference (TYPE)	FPM_ARIA_LANDMARK		Aria Landmark	20131104
3	Exporting	EV_CHECK_MANDATORY	Call by reference	☐	Type reference (TYPE)	FPMGB_CHECK_MANDATORY		Check Mandatory Fields on Screen	20120227
4	Exporting	EV_CTXT_MENU_ID	Call by reference	☐	Type reference (TYPE)	FPM_CTXT_MENU_ID		Context Menu ID	20120131
5	Exporting	EV_DISPLAY_EMPTY_ROWS	Call by reference	☐	Type reference (TYPE)	FPMGB_TABLE_EMPTY_ROWS		Hide Empty Rows in Table	20120227
6	Exporting	EV_DISPLAY_MODE	Call by reference	☐	Type reference (TYPE)	FPMGB_TABLE_DISPLAY_MODE		Display Mode of Table	20120227
7	Exporting	EV_ENABLE_H_SCROLLING	Call by reference	☐	Type reference (TYPE)	FPMGB_ENABLING_H_SCROLLING		Enable Horizontal Scrollbar in a List or Tree GUIBB	20120227
8	Exporting	EV_EXPORT_EXCEL	Call by reference	☐	Type reference (TYPE)	FPMGB_EXCEL_EXPORT		Export of List to Spreadsheet	20120227
9	Exporting	EV_GRID_MODE	Call by reference	☐	Type reference (TYPE)	FPMGB_TABLE_GRID_MODE		Display Mode of Table Gridlines	20120227
10	Exporting	EV_INITIAL_LEAD_SELECTION	Call by reference	☐	Type reference (TYPE)	FPMGB_SET_LEAD_SELECTION		Set Lead Selection on Open	20120227
11	Exporting	EV_LIST_WIDTH	Call by reference	☐	Type reference (TYPE)	FPM_LIST_WIDTH		FPM GUIBB List: Width	20120227
12	Exporting	EV_SCROLLABLE_COLUMN_COUNT	Call by reference	☐	Type reference (TYPE)	FPMGB_NON_SCROLLABLE_COLUMNS		No. of Fixed Columns in List and Tree GUIBBs	20120227
13	Exporting	EV_SELECTION_CHANGE_BEHAVIOUR	Call by reference	☐	Type reference (TYPE)	FPMGB_SEL_CHNG_BEHVR		Selection change behaviour of the GUIBB list	20090825
14	Exporting	EV_SELECTION_MODE	Call by reference	☐	Type reference (TYPE)	FPMGB_SELECTION_MODE		Selection mode of the GUIBB list	20090825
15	Exporting	EV_SEL_EVENT_TYPE	Call by reference	☐	Type reference (TYPE)	FPMGB_SEL_EVENT		Should normal Selection in list cause FPM event or not	20090825
16	Exporting	EV_STYLE_OF_RENDERING	Call by reference	☐	Type reference (TYPE)	FPMGB_LIST_RENDER_STYLE		Rendering Style of FPM List GUIBB	20120227
17	Exporting	EV_TABLE_VISIBILITY	Call by reference	☐	Type reference (TYPE)	FPMGB_TABLE_VISIBILITY		Hide Empty List	20120227
18	Exporting	EV_VISIBLE_COLUMN_COUNTS	Call by reference	☐	Type reference (TYPE)	FPMGB_COL_COUNT		Column count	20090825
19	Exporting	EV_VISIBLE_ROW_COUNTS	Call by reference	☐	Type reference (TYPE)	FPMGB_ROW_COUNT		Row count	20090825

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

Method GET_TOOLBAR Signature

Method GET_TOOLBAR on class CL_FPM_GUIBB_BASE_CONF_READER has no parameter.
Method GET_TOOLBAR on class CL_FPM_GUIBB_BASE_CONF_READER has no exception.

History

Last changed by/on	SAP	20141120
SAP Release Created in	730