SAP ABAP Class CL_FPM_FORM_CONFIG_READER (Configuration Reader for Form UIBB)
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 20090126
Properties
Class CL_FPM_FORM_CONFIG_READER  
Short Description Configuration Reader for Form 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_GUIBB   Generic UI building blocks 
Created 20090126   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_GUIBB_FORM_CONFIG Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
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_FORM_CONFIG_READER has no interface implemented.
Friends
Class CL_FPM_FORM_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' 20090126
2 GC_TABBED Constant Public Type reference (TYPE) STRING 'TABBED' 20090126
3 MR_BR_ELEMENT_ACTION_STRUCTURE Instance attribute Private Object reference (TYPE REF TO) CL_ABAP_DATADESCR Runtime Type Services 20090127
4 MR_BR_ELEMENT_STRUCTURE Instance attribute Private Object reference (TYPE REF TO) CL_ABAP_DATADESCR Runtime Type Services 20090127
5 MR_BUTTON_ROW_STRUCTURE Instance attribute Private Object reference (TYPE REF TO) CL_ABAP_DATADESCR Runtime Type Services 20090126
6 MR_ELEMENT_ACTION_STRUCTURE Instance attribute Private Object reference (TYPE REF TO) CL_ABAP_DATADESCR Runtime Type Services 20090126
7 MR_ELEMENT_STRUCTURE Instance attribute Private Object reference (TYPE REF TO) CL_ABAP_DATADESCR Runtime Type Services 20090126
8 MR_FORM_STRUCTURE Instance attribute Private Object reference (TYPE REF TO) CL_ABAP_DATADESCR Runtime Type Services 20090126
9 MR_GROUP_STRUCTURE Instance attribute Private Object reference (TYPE REF TO) CL_ABAP_DATADESCR Runtime Type Services 20090126
10 MR_MELTING_GROUP_STRUCTURE Instance attribute Private Object reference (TYPE REF TO) CL_ABAP_DATADESCR Runtime Type Services 20090126
11 MR_MGRP_ELEMENT_STRUCTURE Instance attribute Private Object reference (TYPE REF TO) CL_ABAP_DATADESCR Runtime Type Services 20090127
12 MR_MG_ELEMENT_ACTION_STRUCTURE Instance attribute Private Object reference (TYPE REF TO) CL_ABAP_DATADESCR Runtime Type Services 20090127
13 MR_PARAMETER_STRUCTURE Instance attribute Private Object reference (TYPE REF TO) CL_ABAP_DATADESCR Runtime Type Services 20090126
14 MT_BR_ELEMENTS Instance attribute Private Type reference (TYPE) TY_T_BR_ELEMENTS 20090127
15 MT_BR_ELEMENT_ACTIONS Instance attribute Private Type reference (TYPE) TY_T_BR_ELEMENTS_ACTION 20090127
16 MT_BUTTON_ROWS Instance attribute Private Type reference (TYPE) TY_T_BUTTON_ROWS 20090126
17 MT_ELEMENTS Instance attribute Private Type reference (TYPE) TY_T_ELEMENTS 20090126
18 MT_ELEMENT_ACTIONS Instance attribute Private Type reference (TYPE) TY_T_ELEMENT_ACTION 20090128
19 MT_FORM Instance attribute Private Type reference (TYPE) TY_T_FORM 20090126
20 MT_GROUPS Instance attribute Private Type reference (TYPE) TY_T_GROUPS 20090126
21 MT_MELTING_GROUPS Instance attribute Private Type reference (TYPE) TY_T_MELTING_GROUPS 20090126
22 MT_MGRP_ELEMENTS Instance attribute Private Type reference (TYPE) TY_T_MGROUP_ELEMENTS 20090127
23 MT_MG_ELEMENT_ACTIONS Instance attribute Private Type reference (TYPE) TY_T_BR_ELEMENTS_ACTION 20090127
24 MT_PARAMETERS Instance attribute Private Type reference (TYPE) TY_T_PARAMETER Table of UIBB keys (with location in OIF) 20090126
25 MV_FORM_NODE_ID Instance attribute Private Type reference (TYPE) STRING 20090126
26 MV_FORM_PATH Instance attribute Private Type reference (TYPE) STRING 20090126
Methods
# Method Level Visibility Method type Description Created on
1 CONSTRUCTOR Instance method Public Constructor CONSTRUCTOR 20090126
2 CREATE_FORM_NODE_ID Instance method Private Method 20090126
3 GET_BR_ELEMENTS Instance method Public Method 20090126
4 GET_BR_ELEMENT_ACTIONS Instance method Public Method 20090126
5 GET_BUTTON_ROWS Instance method Public Method 20090126
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_DROP Instance method Public Method 20120309
9 GET_ELEMENTS Instance method Public Method 20090126
10 GET_ELEMENT_ACTIONS Instance method Public Method 20090126
11 GET_FORM_ATTRIBUTES Instance method Public Method 20090126
12 GET_GROUPS Instance method Public Method 20090126
13 GET_MELTING_GROUPS Instance method Public Method 20090126
14 GET_MGRP_ELEMENTS Instance method Public Method 20090127
15 GET_MGRP_ELEMENT_ACTION Instance method Public Method 20090127
16 GET_PARAMETERS Instance method Public Method 20090126
17 GET_QUICKVIEW Instance method Public Method 20120308
Events
Class CL_FPM_FORM_CONFIG_READER has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 TY_S_BR_ELEMENTS Private See coding 20090126 BEGIN OF ty_s_br_elements , display_type TYPE fpmgb_display_type, index TYPE wdy_conf_index, text TYPE wdy_conf_transl_text, element_id TYPE fpm_element_id, special_properties TYPE string, instance_style type fpm_instance_style, br_element_index TYPE i, row TYPE fpmgb_row, column TYPE fpmgb_column, path TYPE string, END OF ty_s_br_elements
2 TY_S_BR_ELEMENT_ACTION Private See coding 20090126 BEGIN OF ty_s_br_element_action , event_id TYPE fpm_event_id, text TYPE string, index TYPE wdy_conf_index, br_element_index TYPE wdy_conf_index, path TYPE string, END OF ty_s_br_element_action
3 TY_S_BUTTON_ROWS Private See coding 20090126 BEGIN OF ty_s_button_rows , row TYPE fpmgb_row, element_id TYPE fpm_element_id, br_index TYPE i, group_index TYPE wdy_conf_index, group_location TYPE fpm_location, path TYPE string, END OF ty_s_button_rows
4 TY_S_DROP Public See coding 20120309 BEGIN OF ty_s_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_drop
5 TY_S_ELEMENTS Private See coding 20090126 BEGIN OF ty_s_elements, name TYPE name_komp, display_type TYPE fpmgb_display_type, row TYPE fpmgb_row, column TYPE fpmgb_column, text TYPE wdy_conf_transl_text, visibility_label TYPE fpm_visibility, 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, explanation TYPE wdy_conf_transl_text, ctxt_menu_id TYPE fpm_ctxt_menu_id, instance_style TYPE fpm_instance_style, label_instance_style TYPE fpm_label_instance_style, element_index TYPE i, group_index TYPE wdy_conf_index, group_location TYPE fpm_location, path TYPE string, END OF ty_s_elements
6 TY_S_ELEMENT_ACTION Private See coding 20090126 BEGIN OF ty_s_element_action, event_id TYPE fpm_event_id, text TYPE string, index TYPE wdy_conf_index, row TYPE fpmgb_row, column TYPE fpmgb_column, path TYPE string, END OF ty_s_element_action
7 TY_S_FORM Private See coding 20090126 BEGIN OF ty_s_form , feeder TYPE c LENGTH 30, title TYPE wdy_conf_transl_text, layout_type TYPE fpmgb_layout_type, guideline TYPE fpm_guideline_version, check_mandatory TYPE fpmgb_check_mandatory, no_on_enter_after_f4 TYPE fpmgb_no_on_enter_after_f4, ctxt_menu_id TYPE fpm_ctxt_menu_id, aria_landmark TYPE fpm_aria_landmark, instance_style TYPE fpm_instance_style, END OF ty_s_form
8 TY_S_GROUPS Private See coding 20090126 BEGIN OF ty_s_groups , title TYPE wdy_conf_transl_text, index TYPE wdy_conf_index, group_type TYPE fpmgb_group_type, element_id TYPE fpm_element_id, location TYPE fpm_location, ctxt_menu_id TYPE fpm_ctxt_menu_id, instance_style TYPE fpm_instance_style, path TYPE string, END OF ty_s_groups
9 TY_S_MELTING_GROUPS Private See coding 20090126 BEGIN OF ty_s_melting_groups , row TYPE fpmgb_row, column TYPE fpmgb_column, element_id TYPE fpm_element_id, ctxt_menu_id TYPE fpm_ctxt_menu_id, instance_style TYPE fpm_instance_style, melting_group_index TYPE i, group_index TYPE wdy_conf_index, group_location TYPE fpm_location, path TYPE string, END OF ty_s_melting_groups
10 TY_S_MGROUP_ELEMENTS Private See coding 20090126 BEGIN OF ty_s_mgroup_elements , name TYPE name_komp, display_type TYPE fpmgb_display_type, index TYPE wdy_conf_index, text TYPE wdy_conf_transl_text, visibility_label TYPE fpm_visibility, element_id TYPE fpm_element_id, special_properties TYPE string, width type fpmgb_ui_element_width, tag_active type fpmgb_tag_active, tooltip type wdy_conf_transl_text, explanation type wdy_conf_transl_text, ctxt_menu_id type fpm_ctxt_menu_id, instance_style TYPE fpm_instance_style, label_instance_style TYPE fpm_label_instance_style, mgrp_element_index TYPE i, group_index TYPE wdy_conf_index, row TYPE fpmgb_row, column TYPE fpmgb_column, path TYPE string, END OF ty_s_mgroup_elements
11 TY_S_MGROUP_ELEMENT_ACTION Private See coding 20090126 BEGIN OF ty_s_mgroup_element_action, event_id TYPE fpm_event_id, text TYPE string, index TYPE wdy_conf_index, path TYPE string, END OF ty_s_mgroup_element_action
12 TY_S_PARAMETER Private See coding 20090126 BEGIN OF ty_s_parameter , name TYPE fpmgb_parameter_name, value TYPE fpmgb_parameter_value, path TYPE string, END OF ty_s_parameter
13 TY_T_BR_ELEMENTS Private See coding 20090126 ty_t_br_elements TYPE STANDARD TABLE OF ty_s_br_elements
14 TY_T_BR_ELEMENTS_ACTION Private See coding 20090126 ty_t_br_elements_action TYPE STANDARD TABLE OF ty_s_br_element_action
15 TY_T_BUTTON_ROWS Private See coding 20090126 ty_t_button_rows TYPE STANDARD TABLE OF ty_s_button_rows
16 TY_T_DROP Public See coding 20120309 ty_t_drop TYPE STANDARD TABLE OF ty_s_drop
17 TY_T_ELEMENTS Private See coding 20090126 ty_t_elements TYPE STANDARD TABLE OF ty_s_elements
18 TY_T_ELEMENT_ACTION Private See coding 20090126 ty_t_element_action TYPE STANDARD TABLE OF ty_s_element_action
19 TY_T_FORM Private See coding 20090126 ty_t_form TYPE STANDARD TABLE OF ty_s_form
20 TY_T_GROUPS Private See coding 20090126 ty_t_groups TYPE STANDARD TABLE OF ty_s_groups
21 TY_T_MELTING_GROUPS Private See coding 20090126 ty_t_melting_groups TYPE STANDARD TABLE OF ty_s_melting_groups
22 TY_T_MGROUP_ELEMENTS Private See coding 20090126 ty_t_mgroup_elements TYPE STANDARD TABLE OF ty_s_mgroup_elements
23 TY_T_MGROUP_ELEMENT_ACTION Private See coding 20090126 ty_t_mgroup_element_action TYPE STANDARD TABLE OF ty_s_mgroup_element_action
24 TY_T_PARAMETER Private See coding 20090126 ty_t_parameter TYPE STANDARD TABLE OF ty_s_parameter
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 20090126
2 Importing IR_COMP_READER Call by reference Object reference (TYPE REF TO) IF_WD_CONFIG_COMP_READER Read Interface for the Component Configuration 20090126
3 Importing IV_CONFIGURATION_ID Call by reference Type reference (TYPE) WDY_CONFIG_ID Configuration Identification 20090126
4 Importing IV_CONFIG_TYPE Call by reference Type reference (TYPE) WDY_CONFIG_TYPE Type of Web Dynpro Configuration 20090126
# Exception Resumable Description Created on
1 CX_FPM_FLOORPLAN Floorplan exceptions 20090126

Method CREATE_FORM_NODE_ID Signature

Method CREATE_FORM_NODE_ID on class CL_FPM_FORM_CONFIG_READER has no parameter.
# Exception Resumable Description Created on
1 CX_FPM_FLOORPLAN Floorplan exceptions 20090126

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_FORM_CONFIG=>TY_T_BR_ELEMENTS 20090126
2 Importing IV_BR_ROW Call by reference Type reference (TYPE) FPMGB_ROW Row in form 20090126
# Exception Resumable Description Created on
1 CX_FPM_FLOORPLAN Floorplan exceptions 20090126

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_FORM_CONFIG=>TY_T_BR_ELEMENTS_ACTION 20090126
2 Importing IV_BR_ELEMENT_INDEX Call by reference Type reference (TYPE) WDY_CONF_INDEX 20090126
# Exception Resumable Description Created on
1 CX_FPM_FLOORPLAN Floorplan exceptions 20090126

Method GET_BUTTON_ROWS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_BUTTON_ROWS Call by reference Type reference (TYPE) IF_FPM_GUIBB_FORM_CONFIG=>TY_T_BUTTON_ROWS 20090126
2 Importing IV_GROUP_INDEX Call by reference Type reference (TYPE) I 20090126
3 Importing IV_GROUP_LOCATION Call by reference Type reference (TYPE) FPM_LOCATION 0 UIBB Location Index (Column) 20140701
# Exception Resumable Description Created on
1 CX_FPM_FLOORPLAN Configuration exceptions 20090128

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_DROP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ES_DROP Call by reference Type reference (TYPE) TY_S_DROP 20120309
# Exception Resumable Description Created on
1 CX_FPM_FLOORPLAN Floorplan exceptions 20120309

Method GET_ELEMENTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_ELEMENTS Call by reference Type reference (TYPE) IF_FPM_GUIBB_FORM_CONFIG=>TY_T_ELEMENTS 20090126
2 Importing IV_GROUP_INDEX Call by reference Type reference (TYPE) WDY_CONF_INDEX Row in form 20090126
3 Importing IV_GROUP_LOCATION Call by reference Type reference (TYPE) FPM_LOCATION 0 UIBB Location Index (Column) 20140701
# Exception Resumable Description Created on
1 CX_FPM_FLOORPLAN Floorplan exceptions 20090126

Method GET_ELEMENT_ACTIONS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_ELEMENT_ACTIONS Call by reference Type reference (TYPE) IF_FPM_GUIBB_FORM_CONFIG=>TY_T_ELEMENT_ACTION 20090128
2 Importing IV_ELEMENT_COLUMN Call by reference Type reference (TYPE) FPMGB_COLUMN Column for form 20090126
3 Importing IV_ELEMENT_ROW Call by reference Type reference (TYPE) FPMGB_ROW Row in form 20090126
# Exception Resumable Description Created on
1 CX_FPM_FLOORPLAN Floorplan exceptions 20090126

Method GET_FORM_ATTRIBUTES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting CHECK_MANDATORY Call by reference Type reference (TYPE) FPMGB_CHECK_MANDATORY Check Mandatory Fields on Screen 20110301
2 Exporting CTXT_MENU_ID Call by reference Type reference (TYPE) FPM_CTXT_MENU_ID Context Menu ID 20111222
3 Exporting EV_ARIA_LANDMARK Call by reference Type reference (TYPE) FPM_ARIA_LANDMARK Aria Landmark 20131029
4 Exporting EV_FEEDER Call by reference Type reference (TYPE) CHAR30 30 Characters 20090126
5 Exporting EV_INSTANCE_STYLE Call by reference Type reference (TYPE) FPM_INSTANCE_STYLE UI Element specific Style 20140701
6 Exporting EV_LEAD_SEL_EVENT_ID Call by reference Type reference (TYPE) CHAR30 30 Characters 20090126
7 Exporting EV_TITLE Call by reference Type reference (TYPE) WDY_CONF_TRANSL_TEXT Web Dynpro: Configuration: Translatable Text 20090126
8 Exporting GUIDELINE Call by reference Type reference (TYPE) FPM_GUIDELINE_VERSION UI Guideline Version 20110301
9 Exporting LAYOUT_TYPE Call by reference Type reference (TYPE) FPMGB_LAYOUT_TYPE Layout Type for Form UIBB 20110301
10 Exporting NO_ON_ENTER_AFTER_F4 Call by reference Type reference (TYPE) FPMGB_NO_ON_ENTER_AFTER_F4 No Automatic Event on After Closing of DDIC F4 Help Event 20110301

Method GET_FORM_ATTRIBUTES on class CL_FPM_FORM_CONFIG_READER has no exception.

Method GET_GROUPS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_GROUPS Call by reference Type reference (TYPE) IF_FPM_GUIBB_FORM_CONFIG=>TY_T_GROUPS 20090126
# Exception Resumable Description Created on
1 CX_FPM_FLOORPLAN Floorplan exceptions 20090128

Method GET_MELTING_GROUPS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_MELTING_GROUPS Call by reference Type reference (TYPE) IF_FPM_GUIBB_FORM_CONFIG=>TY_T_MELTING_GROUPS 20090126
2 Importing IV_GROUP_INDEX Call by reference Type reference (TYPE) I 20090126
3 Importing IV_GROUP_LOCATION Call by reference Type reference (TYPE) FPM_LOCATION 0 UIBB Location Index (Column) 20140701
# Exception Resumable Description Created on
1 CX_FPM_FLOORPLAN Configuration exceptions 20090128

Method GET_MGRP_ELEMENTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_MG_ELEMENTS Call by reference Type reference (TYPE) IF_FPM_GUIBB_FORM_CONFIG=>TY_T_MGROUP_ELEMENTS 20090127
2 Importing IV_MELTING_GROUP_COLUMN Call by reference Type reference (TYPE) FPMGB_COLUMN Column for form 20090127
3 Importing IV_MELTING_GROUP_ROW Call by reference Type reference (TYPE) FPMGB_ROW Row in form 20090127
# Exception Resumable Description Created on
1 CX_FPM_FLOORPLAN Floorplan exceptions 20090128

Method GET_MGRP_ELEMENT_ACTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_MG_ELEMENT_ACTIONS Call by reference Type reference (TYPE) IF_FPM_GUIBB_FORM_CONFIG=>TY_T_MGROUP_ELEMENT_ACTION 20090127
2 Importing IV_MG_ELEMENT_INDEX Call by reference Type reference (TYPE) WDY_CONF_INDEX 20090127
# Exception Resumable Description Created on
1 CX_FPM_FLOORPLAN Floorplan exceptions 20090128

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_FORM_CONFIG=>TY_T_PARAMETER 20090126
# Exception Resumable Description Created on
1 CX_FPM_FLOORPLAN Floorplan exceptions 20090126

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
History
Last changed by/on SAP  20141120 
SAP Release Created in 720