SAP ABAP Class CL_FPM_TREE_CONFIG_READER (Config reader class for tree GUIBB)

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	20100518
2	Interface implementation (CLASS c. INTERFACES i_ref)	IF_FPM_CONFIG_RW_CONSTANTS	Constants for Config Reader / Writer	20100520

Properties

Class	CL_FPM_TREE_CONFIG_READER
Short Description	Config reader class for tree GUIBB
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	20100518	SAP
Last change	20141120
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_FPM_TREE_CONFIG_READER has no forward declaration.

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_FPM_CONFIG_RW_CONSTANTS	☐	☐	Constants for Config Reader / Writer	20100520

Friends

Class CL_FPM_TREE_CONFIG_READER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MD_FEEDER	Instance attribute	Private	☐	Type reference (TYPE)	SEOCLSNAME		Object Type Name	20100518
2	MD_LEAD_SEL_EVENT_ID	Instance attribute	Private	☐	Type reference (TYPE)	FPMGB_S_ACTION-EVENT_ID		ID of the FPM Event	20100518
3	MD_SET_DEFAULT_TBAR_BUTTONS	Instance attribute	Private	☐	Type reference (TYPE)	FPMGB_DEFAULT_BUTTON_SET		Default Button-Set for Hierarchical List GUIBB	20100518
4	MD_TITLE	Instance attribute	Private	☐	Type reference (TYPE)	WDY_CONF_TRANSL_TEXT		Web Dynpro: Configuration: Translatable Text	20100518
5	MT_BUTTON_ACTION	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_BUTTON_ACTION_INT			20100518
6	MT_BUTTON_ROW_ELEMENT	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_BUTTON_ROW_ELEMENT_INT			20100518
7	MT_COLUMN	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_COLUMN_INT			20100518
8	MT_DRAG_DROP	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_DRAG_DROP_INT			20100518
9	MT_PARAMETER	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_PARAMETER_INT			20100518
10	MT_ROW_ACTIONS	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_ROW_ACTIONS_INT			20130807
11	TS_T_BUTTON_ACTION	Instance attribute	Public	☐	Attribute reference (LIKE)				20100520

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20100518
2	GET_BUTTON_ACTION	Instance method	Private	Method		20100518
3	GET_BUTTON_ROW	Instance method	Private	Method		20100518
4	GET_BUTTON_ROW_ELEMENTS	Instance method	Public	Method		20100518
5	GET_COLUMN	Instance method	Public	Method		20100518
6	GET_CTXT_MENU	Instance method	Public	Method	Return a List of Context Menus	20111222
7	GET_CTXT_MENU_ITEM	Instance method	Public	Method	Items of a context menu	20111222
8	GET_DRAG_DROP	Instance method	Public	Method		20100518
9	GET_MASTER_COLUMN	Instance method	Public	Method		20100518
10	GET_PARAMETERS	Instance method	Public	Method		20100518
11	GET_QUICKVIEW	Instance method	Public	Method		20120308
12	GET_ROW_ACTIONS	Instance method	Public	Method		20130807
13	GET_SETTINGS	Instance method	Public	Method		20100518
14	GET_TREE_ATTRIBUTES	Instance method	Public	Method		20120322

Events

Class CL_FPM_TREE_CONFIG_READER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_S_BUTTON_ACTION	Public	Attribute reference (LIKE)			20100520
2	TY_S_BUTTON_ACTION_INT	Private	See coding			20100518	BEGIN OF ty_s_button_action_int . include type ty_s_button_action. types: path type string, END OF ty_s_button_action_int
3	TY_S_BUTTON_ROW_ELEMENT	Public	See coding			20100518	BEGIN OF ty_s_button_row_element , index TYPE wdy_conf_index, text TYPE wdy_conf_transl_text, element_id TYPE fpm_element_id, special_properties TYPE string, display_type TYPE fpmgb_display_type, tooltip TYPE wdy_conf_transl_text, button_action LIKE ts_t_button_action, ctxt_menu_id TYPE fpm_ctxt_menu_id, END OF ty_s_button_row_element
4	TY_S_BUTTON_ROW_ELEMENT_INT	Private	See coding			20100518	BEGIN OF ty_s_button_row_element_int. include type ty_s_button_row_element. types: path type string, END OF ty_s_button_row_element_int
5	TY_S_COLUMN	Public	See coding			20100518	BEGIN OF ty_s_column , 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_properties TYPE string, width TYPE fpmgb_ui_element_width, tag_active TYPE fpmgb_tag_active, tag TYPE fpm_tag_name, tooltip TYPE wdy_conf_transl_text, visibility TYPE fpmgb_column_visibility, ctxt_menu_id TYPE fpm_ctxt_menu_id, END OF ty_s_column
6	TY_S_COLUMN_INT	Private	See coding			20100518	BEGIN OF ty_s_column_int . include type ty_s_column. types: path type string, END OF ty_s_column_int
7	TY_S_DRAG_DROP	Public	See coding			20100518	BEGIN OF ty_s_drag_drop , type TYPE fpmgb_s_dnd_definition-type, enabled TYPE fpmgb_s_dnd_definition-enabled, tags TYPE fpmgb_s_dnd_definition-tags, scope TYPE fpmgb_s_dnd_definition-scope, override TYPE fpmgb_s_dnd_definition-override, END OF ty_s_drag_drop
8	TY_S_DRAG_DROP_INT	Private	See coding			20100518	BEGIN OF ty_s_drag_drop_int . include type ty_s_drag_drop. types: path type string, END OF ty_s_drag_drop_int
9	TY_S_PARAMETER	Public	See coding			20100518	BEGIN OF ty_s_parameter , name TYPE fpmgb_parameter_name, value TYPE fpmgb_parameter_value, END OF ty_s_parameter
10	TY_S_PARAMETER_INT	Private	See coding			20100518	BEGIN OF ty_s_parameter_int . include type ty_s_parameter. types: path TYPE string, END OF ty_s_parameter_int
11	TY_S_ROW_ACTIONS	Public	See coding			20130807	BEGIN OF ty_s_row_actions, element_id TYPE fpm_element_id, event_id TYPE fpm_event_id, text TYPE wdy_conf_transl_text, tooltip TYPE wdy_conf_transl_text, image_source TYPE string, event_parameters TYPE string, action_type TYPE fpm_action_type, index TYPE wdy_conf_index, ctxt_menu_id TYPE fpm_ctxt_menu_id, hide_text TYPE fpm_hide_text, END OF ty_s_row_actions
12	TY_S_ROW_ACTIONS_INT	Private	See coding			20130807	BEGIN OF ty_s_row_actions_int . INCLUDE TYPE ty_s_row_actions. TYPES: path TYPE string, END OF ty_s_row_actions_int
13	TY_T_BUTTON_ACTION	Public	Attribute reference (LIKE)			20100520
14	TY_T_BUTTON_ACTION_INT	Private	See coding			20100518	ty_t_button_action_int TYPE STANDARD TABLE OF ty_s_button_action_int
15	TY_T_BUTTON_ROW_ELEMENT	Public	See coding			20100518	ty_t_button_row_element TYPE STANDARD TABLE OF ty_s_button_row_element
16	TY_T_BUTTON_ROW_ELEMENT_INT	Private	See coding			20100518	ty_t_button_row_element_int TYPE STANDARD TABLE OF ty_s_button_row_element_int
17	TY_T_COLUMN	Public	See coding			20100518	ty_t_column TYPE STANDARD TABLE OF ty_s_column
18	TY_T_COLUMN_INT	Private	See coding			20100518	ty_t_column_int TYPE STANDARD TABLE OF ty_s_column_int
19	TY_T_DRAG_DROP	Public	See coding			20100518	ty_t_drag_drop TYPE STANDARD TABLE OF ty_s_drag_drop
20	TY_T_DRAG_DROP_INT	Private	See coding			20100518	ty_t_drag_drop_int TYPE STANDARD TABLE OF ty_s_drag_drop_int
21	TY_T_PARAMETER	Public	See coding			20100518	ty_t_parameter TYPE STANDARD TABLE OF ty_s_parameter
22	TY_T_PARAMETER_INT	Private	See coding			20100518	ty_t_parameter_int TYPE STANDARD TABLE OF ty_s_parameter_int
23	TY_T_ROW_ACTIONS	Public	See coding			20130807	ty_t_row_actions TYPE STANDARD TABLE OF ty_s_row_actions
24	TY_T_ROW_ACTIONS_INT	Private	See coding			20130807	ty_t_row_actions_int TYPE STANDARD TABLE OF ty_s_row_actions_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	20100518
2	Importing	IR_COMP_READER	Call by reference	☑	Object reference (TYPE REF TO)	IF_WD_CONFIG_COMP_READER		Read Interface for the Component Configuration	20100518
3	Importing	IV_CONFIGURATION_ID	Call by reference	☐	Type reference (TYPE)	WDY_CONFIG_ID		Configuration Identification	20100518
4	Importing	IV_CONFIG_TYPE	Call by reference	☐	Type reference (TYPE)	WDY_CONFIG_TYPE		Type of Web Dynpro Configuration	20100518
5	Importing	IV_NO_VARIANTS	Call by reference	☐	Type reference (TYPE)	BOOLE_D	ABAP_FALSE	Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20100518

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

Method GET_BUTTON_ACTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_BUTTON_ACTION	Call by reference	☐	Type reference (TYPE)	TY_T_BUTTON_ACTION		Button Actions	20100518
2	Importing	ID_PATH	Call by reference	☐	Type reference (TYPE)	STRING			20100518

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

Method GET_BUTTON_ROW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ED_PATH	Value transfer	☐	Type reference (TYPE)	STRING			20100518
2	Importing	ID_PATH	Call by reference	☐	Type reference (TYPE)	STRING			20100518

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

Method GET_BUTTON_ROW_ELEMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_BUTTON_ROW_ELEMENT	Call by reference	☐	Type reference (TYPE)	TY_T_BUTTON_ROW_ELEMENT			20100518

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

Method GET_COLUMN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_COLUMN	Call by reference	☐	Type reference (TYPE)	TY_T_COLUMN		Column	20100518

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

Method GET_CTXT_MENU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_CTXT_MENU	Value transfer	☐	Type reference (TYPE)	TY_T_CTXT_MENU			20111222

#	Exception	Resumable	Description	Created on
1	CX_WD_PERSONALIZATION	☐	Floorplan exceptions	20111222

Method GET_CTXT_MENU_ITEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CTXT_MENU_ID	Call by reference	☐	Type reference (TYPE)	FPM_CTXT_MENU_ID		Context Menu ID	20111222
2	Returning	RT_CTXT_MENU_ITEM	Value transfer	☐	Type reference (TYPE)	TY_T_CTXT_MENU_ITEM			20111222

#	Exception	Resumable	Description	Created on
1	CX_WD_PERSONALIZATION	☐	Personalization Error	20111222

Method GET_DRAG_DROP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DRAG_DROP	Call by reference	☐	Type reference (TYPE)	TY_T_DRAG_DROP			20100518

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

Method GET_MASTER_COLUMN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ED_CTXT_MENU_ID	Call by reference	☐	Type reference (TYPE)	FPM_CTXT_MENU_ID		Context Menu ID	20120202
2	Exporting	ED_DISPLAY_TYPE	Call by reference	☐	Type reference (TYPE)	FPMGB_DISPLAY_TYPE		Display Type	20120214
3	Exporting	ED_HEADER	Call by reference	☐	Type reference (TYPE)	WDY_CONF_TRANSL_TEXT			20100518
4	Exporting	ED_SPECIAL_PROPERTIES	Call by reference	☐	Type reference (TYPE)	STRING			20120214
5	Exporting	ED_TOOLTIP	Call by reference	☐	Type reference (TYPE)	WDY_CONF_TRANSL_TEXT			20100518
6	Exporting	ED_WIDTH	Call by reference	☐	Type reference (TYPE)	FPMGB_UI_ELEMENT_WIDTH			20100518

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

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)	TY_T_PARAMETER		Parameters	20100518

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

Method GET_QUICKVIEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_QUICKVIEW	Call by reference	☐	Type reference (TYPE)	CL_FPM_CONFIG_WRITER=>TY_T_QUICKVIEW			20120308

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

Method GET_ROW_ACTIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ROW_ACTIONS	Call by reference	☐	Type reference (TYPE)	TY_T_ROW_ACTIONS			20130807

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

Method GET_SETTINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ED_ACCESS_DESCR	Call by reference	☐	Type reference (TYPE)	FPM_ACCESSIBILITY_DESCR		Accessibility Description	20100518
2	Exporting	ED_ALLOW_CREATING_VIEWS	Call by reference	☐	Type reference (TYPE)	FPMGB_ALLOW_NEW_VIEWS_ATS		Creation of New Views	20120326
3	Exporting	ED_ALLOW_PERSONALIZATION	Call by reference	☐	Type reference (TYPE)	FPMGB_ALLOW_PERS_ATS		Personalization of List	20120326
4	Exporting	ED_ALLOW_SEARCH	Call by reference	☐	Type reference (TYPE)	FPMGB_TREE_ALLOW_SEARCH		Search Function in Tree UIBB	20130902
5	Exporting	ED_ALLOW_SORTING	Call by reference	☐	Type reference (TYPE)	FPMGB_ALLOW_SORTING_ATS		Location of Sorting function in List ATS UIBB	20120326
6	Exporting	ED_ARIA_LANDMARK	Call by reference	☐	Type reference (TYPE)	FPM_ARIA_LANDMARK		Aria Landmark	20131017
7	Exporting	ED_CHECK_MANDATORY	Call by reference	☐	Type reference (TYPE)	FPMGB_CHECK_MANDATORY		Check Mandatory Fields on Screen	20100518
8	Exporting	ED_CTXT_MENU_ID	Call by reference	☐	Type reference (TYPE)	FPM_CTXT_MENU_ID		Context Menu ID	20120202
9	Exporting	ED_DISPLAY_EMPTY_ROWS	Call by reference	☐	Type reference (TYPE)	FPMGB_TABLE_EMPTY_ROWS		Check to display empty rows	20100608
10	Exporting	ED_DISPLAY_MODE	Call by reference	☐	Type reference (TYPE)	FPMGB_TABLE_DISPLAY_MODE		Display Mode of Table	20120525
11	Exporting	ED_EXPORT_TO_EXCEL	Call by reference	☐	Type reference (TYPE)	FPMGB_EXCEL_EXPORT		Export of List to Spreadsheet	20120905
12	Exporting	ED_FIT_TO_TABLE_WIDTH	Call by reference	☐	Type reference (TYPE)	FPMGB_FIT_TABLE_WIDTH		FPM LIST ATS: Fit Columns to Table Width	20120326
13	Exporting	ED_HEIGHT_MODE_ATS	Call by reference	☐	Type reference (TYPE)	FPMGB_TABLE_HEIGHT_MODE_ATS		Height of List ATS Table	20120326
14	Exporting	ED_INITIAL_LEAD_SELECTION	Call by reference	☐	Type reference (TYPE)	FPMGB_SET_LEAD_SELECTION		Set Lead Selection on Open	20100518
15	Exporting	ED_NO_DATA_TEXT	Call by reference	☐	Type reference (TYPE)	FPM_NO_DATA_TEXT		Text Displayed if No Data is Available	20120326
16	Exporting	ED_ROW_HEIGHT_ATS	Call by reference	☐	Type reference (TYPE)	FPMGB_ROW_HEIGHT		Height of a Table Row (in Pixels)	20120326
17	Exporting	ED_SCROLLABLE_COLUMN_COUNT	Call by reference	☐	Type reference (TYPE)	FPMGB_NON_SCROLLABLE_COLUMNS		FPM List and Tree GUIBB: Scrollable column count	20100608
18	Exporting	ED_SELECTION_CHANGE_BEHAVIOUR	Call by reference	☐	Type reference (TYPE)	FPMGB_SEL_CHNG_BEHVR		Selection change behaviour of the GUIBB LIST	20100518
19	Exporting	ED_SELECTION_MODE	Call by reference	☐	Type reference (TYPE)	FPMGB_SELECTION_MODE		Selection mode of the GUIBB list	20100518
20	Exporting	ED_SEL_EVENT_TYPE	Call by reference	☐	Type reference (TYPE)	FPMGB_SEL_EVENT		Determines whether a normal selection raises an FPM event	20100518
21	Exporting	ED_SEL_EVENT_TYPE_ATS	Call by reference	☐	Type reference (TYPE)	FPMGB_SEL_EVENT_ATS		Raise FPM Event on Selection	20140113
22	Exporting	ED_SHOW_NO_DATA_DEFAULT_TEXT	Call by reference	☐	Type reference (TYPE)	FPM_SHOW_NO_DATA_DEFAULT_TEXT		Show Default Text if No Data is Available	20120326
23	Exporting	ED_SUPPRESS_SELECTION_BUTTONS	Call by reference	☐	Type reference (TYPE)	FPMGB_SUPPRESS_SEL_BUTTONS		Hide Selection Buttons Column	20120417
24	Exporting	ED_TREE_WIDTH	Call by reference	☐	Type reference (TYPE)	FPM_TREE_WIDTH		FPM GUIBB TREE: Tree Width	20100518
25	Exporting	ED_VISIBLE_COL_COUNT	Call by reference	☐	Type reference (TYPE)	FPMGB_COL_COUNT			20100518
26	Exporting	ED_VISIBLE_ROW_COUNT	Call by reference	☐	Type reference (TYPE)	FPMGB_ROW_COUNT			20100518

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

Method GET_TREE_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ED_FEEDER	Call by reference	☐	Type reference (TYPE)	SEOCLSNAME			20120322
2	Exporting	ED_LEAD_SEL_EVENT_ID	Call by reference	☐	Type reference (TYPE)	FPMGB_S_ACTION-EVENT_ID			20120322
3	Exporting	ED_SET_DEFAULT_TBAR_BUTTONS	Call by reference	☐	Type reference (TYPE)	FPMGB_DEFAULT_BUTTON_SET			20120322
4	Exporting	ED_TITLE	Call by reference	☐	Type reference (TYPE)	WDY_CONF_TRANSL_TEXT			20120322

Method GET_TREE_ATTRIBUTES on class CL_FPM_TREE_CONFIG_READER has no exception.

History

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