SAP ABAP Class CL_FPM_FORM_CONFIG_WRITER (Configuration Writer for FORM 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_WRITER Configuration Rerader for OIF 20090831
Properties
Class CL_FPM_FORM_CONFIG_WRITER  
Short Description Configuration Writer for FORM GUIBB    
Super Class CL_FPM_CONFIG_WRITER Configuration Rerader 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 20090831   SAP 
Last change 20141120    
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 CL_FPM_CONFIG_WRITER Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
2 CL_FPM_FORM_CONFIG_READER Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
3 CL_FPM_FORM_CONFIG_WRITER Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
4 CL_FPM_OIF_CONFIG_WRITER Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
5 IF_FPM_OIF Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
Interfaces
Class CL_FPM_FORM_CONFIG_WRITER has no interface implemented.
Friends
Class CL_FPM_FORM_CONFIG_WRITER has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 MV_NODE_ID Instance attribute Private Type reference (TYPE) STRING 20120308
2 MV_ROOT_PATH Instance attribute Private Type reference (TYPE) STRING 20120308
Methods
# Method Level Visibility Method type Description Created on
1 ADD_BUTTON_ROW Instance method Public Method Add a mainviews for a given variant 20090901
2 ADD_BUTTON_ROW_ELEMENT Instance method Public Method Add a mainviews for a given variant 20090901
3 ADD_BUTTON_ROW_ELEM_ACTION Instance method Public Method Add a mainviews for a given variant 20090901
4 ADD_CTXT_MENU Instance method Public Method Add a context menu 20111221
5 ADD_CTXT_MENU_ITEM Instance method Public Method 20111221
6 ADD_DROP Instance method Public Method 20120309
7 ADD_ELEMENT Instance method Public Method 20090831
8 ADD_ELEMENT_ACTION Instance method Public Method 20090831
9 ADD_GROUP Instance method Public Method 20090831
10 ADD_MELTING_GROUP Instance method Public Method Add a mainviews for a given variant 20090901
11 ADD_MELTING_GRP_ACTION Instance method Public Method Add a mainviews for a given variant 20090901
12 ADD_MELTING_GRP_ELEMENT Instance method Public Method Add a mainviews for a given variant 20090901
13 ADD_PARAMETER Instance method Public Method Add actions 20090831
14 ADD_QUICKVIEW Instance method Public Method 20120308
15 CHECK Instance method Public Method 20090831
16 CONSTRUCTOR Instance method Public Constructor CONSTRUCTOR 20090831
17 GET_GROUPS Instance method Public Method 20101122
18 SAVE Instance method Public Method 20090831
19 SET_ATTRIBUTES Instance method Public Method 20090831
20 SET_DROP Instance method Public Method Add support drop 20090901
Events
Class CL_FPM_FORM_CONFIG_WRITER has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 TY_S_ACTION Public See coding 20090831 begin of ty_s_action, id type fpm_action_id, event_id type fpm_event_id, action_type type fpm_action_type, end of ty_s_action
2 TY_S_BUTTON Public See coding 20090831 begin of ty_s_button, type_of_button type string, label type string, function type string, screen type fpm_floorplan_state, element_id type string, other_function_index type string, design type wdui_button_design, enabled type boole_d, explanation type string, on_action type string, text type string, tooltip type string, visibility type wdui_visibility, default_button type boole_d, hotkey type fpm_hotkey, action_type type fpm_action_type, event_id TYPE fpm_action_id, role type string, instance type string, end of ty_s_button
3 TY_S_CHOICE Public See coding 20090831 begin of ty_s_choice, type_of_button type string, label type string, enabled type boole_d, visibility type wdui_visibility, event_id type fpm_event_id, action_type type fpm_action_type, end of ty_s_choice
4 TY_S_GROUPS Public See coding 20090831 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, end of ty_s_groups
5 TY_S_SUBVIEW Public See coding 20090831 begin of ty_s_subview, id type fpm_subview_id, name type fpm_subview_name, index type fpm_index, layout_type type fpm_layout_type, hidden type fpm_hidden, end of ty_s_subview
6 TY_S_TOOLBAR Public See coding 20090831 begin of ty_s_toolbar, duplicate type fpm_duplicate_toolbar, is_configured type wdy_boolean, end of ty_s_toolbar
7 TY_S_UIBB_EXT Public See coding 20090831 begin of ty_s_uibb_ext, 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, location type fpm_location, index type fpm_index, fpm_primary_attribute type fpm_element_id, hidden type fpm_hidden, end of ty_s_uibb_ext
8 TY_S_UIBB_KEY Public See coding 20090831 begin of ty_s_uibb_key, component type string, interface_view type string, config_id type wdy_config_id, config_type type wdy_config_type, end of ty_s_uibb_key
9 TY_S_WIRE Public See coding 20090831 begin of ty_s_wire, component type fpm_s_wire-src_component, config_id type fpm_s_wire-config_id, config_type type fpm_s_wire-config_type, config_var type fpm_s_wire-config_var, src_component type fpm_s_wire-src_component, src_config_id type fpm_s_wire-src_config_id, src_config_type type fpm_s_wire-src_config_type, src_config_var type fpm_s_wire-src_config_var, port_type type fpm_s_wire-src_config_var, port_identifier type fpm_s_wire-port_identifier, connector type fpm_s_wire-connector, dependency_param type fpm_s_wire-dependency_param, end of ty_s_wire
10 TY_S_WIRE_MODEL Public See coding 20090831 begin of ty_s_wire_model, transaction type fpm_wire_model_transaction, end of ty_s_wire_model
11 TY_T_ACTION Public See coding 20090831 ty_t_action type sorted table of ty_s_action with unique key id
12 TY_T_BUTTONS Public See coding 20090831 ty_t_buttons type standard table of ty_s_button with default key
13 TY_T_CHOICE Public See coding 20090831 ty_t_choice type standard table of ty_s_choice
14 TY_T_GROUPS Public See coding 20090831 ty_t_groups type standard table of ty_s_groups
15 TY_T_SUBVIEW Public See coding 20090831 ty_t_subview type standard table of ty_s_subview
16 TY_T_UIBB_EXT Public See coding 20090831 ty_t_uibb_ext type standard table of ty_s_uibb_ext
17 TY_T_WIRES Public See coding 20090831 ty_t_wires type standard table of ty_s_wire
18 TY_T_WIRE_MODEL Public See coding 20090831 ty_t_wire_model type standard table of ty_s_wire_model
Method Signatures

Method ADD_BUTTON_ROW Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_BUTTON_ROWS Call by reference Type reference (TYPE) CL_FPM_CONFIG_WRITER=>TY_T_BUTTON_ROWS 20090901
2 Importing IV_GROUP_INDEX Call by reference Type reference (TYPE) I 20090901
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_WD_PERSONALIZATION Floorplan exceptions 20090907

Method ADD_BUTTON_ROW_ELEMENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_BUTTON_ROW_ELEMENTS Call by reference Type reference (TYPE) CL_FPM_CONFIG_WRITER=>TY_T_BR_ELEMENTS 20090901
2 Importing IV_BUTTON_ROW_ROW Call by reference Type reference (TYPE) I 20090901
3 Importing IV_GROUP_INDEX Call by reference Type reference (TYPE) I 20090901
4 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_WD_PERSONALIZATION Floorplan exceptions 20090907

Method ADD_BUTTON_ROW_ELEM_ACTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_BUTTON_ROW_ELEM_ACTIONS Call by reference Type reference (TYPE) CL_FPM_CONFIG_WRITER=>TY_T_BR_ELEMENT_ACTION 20090901
2 Importing IV_BUTTON_ROW_ELEM_INDEX Call by reference Type reference (TYPE) I 20090901
3 Importing IV_BUTTON_ROW_ROW Call by reference Type reference (TYPE) I 20090901
4 Importing IV_GROUP_INDEX Call by reference Type reference (TYPE) I 20090901
5 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_WD_PERSONALIZATION Floorplan exceptions 20090907

Method ADD_CTXT_MENU Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_CTXT_MENU Call by reference Type reference (TYPE) CL_FPM_CONFIG_WRITER=>TY_T_CTXT_MENU 20111221
# Exception Resumable Description Created on
1 CX_WD_PERSONALIZATION Personalization Error 20111221

Method ADD_CTXT_MENU_ITEM Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_CTXT_MENU_ITEMS Call by reference Type reference (TYPE) CL_FPM_CONFIG_WRITER=>TY_T_CTXT_MENU_ITEM 20111221
2 Importing IV_CTXT_MENU_ID Call by reference Type reference (TYPE) FPM_CTXT_MENU_ID Context Menu ID 20111221
# Exception Resumable Description Created on
1 CX_WD_PERSONALIZATION Personalization Error 20111221

Method ADD_DROP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_DROP Call by reference Type reference (TYPE) CL_FPM_FORM_CONFIG_READER=>TY_S_DROP 20120309

Method ADD_DROP on class CL_FPM_FORM_CONFIG_WRITER has no exception.

Method ADD_ELEMENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_ELEMENTS Call by reference Type reference (TYPE) CL_FPM_CONFIG_WRITER=>TY_T_ELEMENTS 20090831
2 Importing IV_GROUP_INDEX Call by reference Type reference (TYPE) I 20090831
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_WD_PERSONALIZATION Floorplan exceptions 20090907

Method ADD_ELEMENT_ACTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_ACTIONS Call by reference Type reference (TYPE) CL_FPM_CONFIG_WRITER=>TY_T_ELEMENT_ACTION 20090831
2 Importing IV_ELEMENT_COLUMN Call by reference Type reference (TYPE) I 20090831
3 Importing IV_ELEMENT_ROW Call by reference Type reference (TYPE) I 20090831
4 Importing IV_GROUP_INDEX Call by reference Type reference (TYPE) I 20090831
5 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_WD_PERSONALIZATION Floorplan exceptions 20090907

Method ADD_GROUP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_GROUPS Call by reference Type reference (TYPE) CL_FPM_FORM_CONFIG_WRITER=>TY_T_GROUPS 20090831
# Exception Resumable Description Created on
1 CX_WD_PERSONALIZATION Floorplan exceptions 20090907

Method ADD_MELTING_GROUP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_MELTING_GROUPS Call by reference Type reference (TYPE) CL_FPM_CONFIG_WRITER=>TY_T_MELTING_GROUPS 20090901
2 Importing IV_GROUP_INDEX Call by reference Type reference (TYPE) I 20090901
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_WD_PERSONALIZATION Floorplan exceptions 20090907

Method ADD_MELTING_GRP_ACTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_MELTING_GRP_ACTIONS Call by reference Type reference (TYPE) CL_FPM_CONFIG_WRITER=>TY_T_MGROUP_ELEMENT_ACTION 20090901
2 Importing IV_GROUP_INDEX Call by reference Type reference (TYPE) I 20090901
3 Importing IV_GROUP_LOCATION Call by reference Type reference (TYPE) FPM_LOCATION 0 UIBB Location Index (Column) 20140701
4 Importing IV_MELTING_GROUP_COLUMN Call by reference Type reference (TYPE) I 20090901
5 Importing IV_MELTING_GROUP_ROW Call by reference Type reference (TYPE) I 20090901
6 Importing IV_MELTING_GRP_ELEM_INDEX Call by reference Type reference (TYPE) I 20090901
# Exception Resumable Description Created on
1 CX_WD_PERSONALIZATION Floorplan exceptions 20090907

Method ADD_MELTING_GRP_ELEMENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_MELTING_GRP_ELEMENTS Call by reference Type reference (TYPE) CL_FPM_CONFIG_WRITER=>TY_T_MGROUP_ELEMENTS 20090901
2 Importing IV_GROUP_INDEX Call by reference Type reference (TYPE) I 20090901
3 Importing IV_GROUP_LOCATION Call by reference Type reference (TYPE) FPM_LOCATION 0 UIBB Location Index (Column) 20140701
4 Importing IV_MELTING_GROUP_COLUMN Call by reference Type reference (TYPE) I 20090901
5 Importing IV_MELTING_GROUP_ROW Call by reference Type reference (TYPE) I 20090901
# Exception Resumable Description Created on
1 CX_WD_PERSONALIZATION Floorplan exceptions 20090907

Method ADD_PARAMETER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_PARAMETER Call by reference Type reference (TYPE) CL_FPM_CONFIG_WRITER=>TY_T_PARAMETER 20090831
# Exception Resumable Description Created on
1 CX_WD_PERSONALIZATION Floorplan exceptions 20090907

Method ADD_QUICKVIEW Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_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 CHECK Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ET_MESSAGES Call by reference Type reference (TYPE) FPM_T_T100_MESSAGES Messages exported to be dispalyed in popup 20090831
2 Exporting EV_ERROR Call by reference Type reference (TYPE) BOOLE_D Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') 20090831

Method CHECK on class CL_FPM_FORM_CONFIG_WRITER has no exception.

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IR_APPL_WRITER Call by reference Object reference (TYPE REF TO) IF_WD_CONFIG_APPL_MODIFIER Write Interface for Application Configuration 20090831
2 Importing IR_COMP_READER Call by reference Object reference (TYPE REF TO) IF_WD_CONFIG_COMP_READER Read Interface for the Component Configuration 20090831
3 Importing IR_COMP_WRITER Call by reference Object reference (TYPE REF TO) IF_WD_CONFIG_COMP_MODIFIER Write Interface for the Component Configuration 20090831
4 Importing IR_CONFIG_TOOL_COMP Call by reference Object reference (TYPE REF TO) IF_WD_CONFIG_TOOL_COMP API Configuration Component 20090831
5 Importing IV_CONFIGURATION_ID Call by reference Type reference (TYPE) WDY_CONFIG_ID Configuration Identification 20090831
6 Importing IV_CONFIG_TYPE Call by reference Type reference (TYPE) WDY_CONFIG_TYPE Type of Web Dynpro Configuration 20090831
7 Importing IV_CREATE Call by reference Type reference (TYPE) BOOLE_D Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') 20090831
# Exception Resumable Description Created on
1 CX_FPM_FLOORPLAN Floorplan exceptions 20090831

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 20101122
# Exception Resumable Description Created on
1 CX_FPM_FLOORPLAN Floorplan exceptions 20101122

Method SAVE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning EV_ERROR Value transfer Type reference (TYPE) BOOLE_D Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') 20090831

Method SAVE on class CL_FPM_FORM_CONFIG_WRITER has no exception.

Method SET_ATTRIBUTES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ARIA_LANDMARK Call by reference Type reference (TYPE) FPM_ARIA_LANDMARK Aria Landmark 20131029
2 Importing IV_CHECK_MANDATORY Call by reference Type reference (TYPE) FPMGB_CHECK_MANDATORY Check mandatory Fields on Screen 20090831
3 Importing IV_CTXT_MENU_ID Call by reference Type reference (TYPE) FPM_CTXT_MENU_ID Context Menu ID 20111221
4 Importing IV_FEEDER Call by reference Type reference (TYPE) SEOCLSNAME Object Type Name 20090831
5 Importing IV_GUIDELINE Call by reference Type reference (TYPE) FPM_GUIDELINE_VERSION UI Guideline Version 20090831
6 Importing IV_INSTANCE_STYLE Call by reference Type reference (TYPE) FPM_INSTANCE_STYLE UI Element Style 20140711
7 Importing IV_LAYOUT_TYPE Call by reference Type reference (TYPE) FPMGB_LAYOUT_TYPE Layouttype for Form 20090831
8 Importing IV_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
9 Importing IV_TITLE Call by reference Type reference (TYPE) WDY_CONF_TRANSL_TEXT Web Dynpro: Configuration: Translatable Text 20090831
# Exception Resumable Description Created on
1 CX_WD_PERSONALIZATION Personalization Error 20090907

Method SET_DROP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ENABLED Call by reference Type reference (TYPE) BOOLE_D 20090901
2 Importing IV_GROUP_INDEX Call by reference Type reference (TYPE) I 20090901
3 Importing IV_NAME Call by reference Type reference (TYPE) STRING 20090901
4 Importing IV_SCOPE Call by reference Type reference (TYPE) STRING 20090901
5 Importing IV_TAGS Call by reference Type reference (TYPE) STRING 20090901
6 Importing IV_TYPE Call by reference Type reference (TYPE) STRING 20090901
# Exception Resumable Description Created on
1 CX_WD_PERSONALIZATION Floorplan exceptions 20090907
History
Last changed by/on SAP  20141120 
SAP Release Created in 730