SAP ABAP Class CL_FPM_VISBIZ_UIBB_ASSIST (Assistance Class for FPM_VISBIZ_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_GUIBB_ASSIST GUIBB Assistence Base Class 20130305
2 Interface implementation (CLASS c. INTERFACES i_ref)  IF_VBI_PERSONALIZATION_SERVICE Personalization Service Interface 20130325
3 Interface implementation (CLASS c. INTERFACES i_ref)  IF_VBI_UI_CONTROL_ABSTRACTION UI Control Abstraction Interface 20130312
Properties
Class CL_FPM_VISBIZ_UIBB_ASSIST  
Short Description Assistance Class for FPM_VISBIZ_UIBB    
Super Class CL_FPM_GUIBB_ASSIST GUIBB Assistence Base Class 
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package APB_FPM_GUIBB   Generic UI building blocks 
Created 20130305   SAP 
Last change 20141120    
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
# Type group / Object type Type Type Description
1 ABAP Type group use (TYPE-POOLS tp)  Type group use (TYPE-POOLS tp)
2 IF_VBI_CONST Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
3 IF_VBI_SERVICE_PROVIDER Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
Interfaces
# Interface Abstract Final Description Created on
1 IF_VBI_PERSONALIZATION_SERVICE Personalization Service Interface 20130325
2 IF_VBI_UI_CONTROL_ABSTRACTION UI Control Abstraction Interface 20130312
Friends
Class CL_FPM_VISBIZ_UIBB_ASSIST has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 CV_VISBIZ_HTMLISLAND Instance attribute Private Type reference (TYPE) STRING 'VisBiz_HTMLIsland' 20130308
2 MC_VIEW Instance attribute Private See coding 20131021
3 MO_CONTEXT Instance attribute Private Object reference (TYPE REF TO) IF_WD_CONTEXT_NODE Web Dynpro: Interface for Context Nodes 20130308
4 MO_HTML_ISLAND Instance attribute Private Object reference (TYPE REF TO) CL_WD_HTML_ISLAND 20130308
5 MO_PERS_MANAGER Instance attribute Private Object reference (TYPE REF TO) IF_WD_PERSONALIZATION Web Dynpro Personalization Interface 20130308
6 MO_VBI_APPL Instance attribute Private Object reference (TYPE REF TO) CL_FPM_VBI_APPLICATION Class for 3D scenario Visual Business 20130412
7 MO_VBI_GEOMAP_APPL Instance attribute Private Object reference (TYPE REF TO) CL_FPM_VBI_GEOMAP_APPLICATION Visual Business Application Base Class 20130412
8 MS_CONFIG Instance attribute Private Type reference (TYPE) YS_VISBIZ 20130308
9 MS_FEEDER Instance attribute Private Type reference (TYPE) YS_FEEDER 20130305
10 MT_AREAS Instance attribute Private Type reference (TYPE) IF_VBI_SERVICE_PROVIDER=>AREAS_TAB 20130311
11 MT_LINKS Instance attribute Private Type reference (TYPE) IF_VBI_SERVICE_PROVIDER=>LINKS_TAB 20130311
12 MT_SPOTS Instance attribute Private Type reference (TYPE) IF_VBI_SERVICE_PROVIDER=>SPOTS_TAB 20130311
13 MV_CONTROL_ID Instance attribute Public Type reference (TYPE) STRING 20130308
14 MV_DATA_CHANGED Instance attribute Private Type reference (TYPE) ABAP_BOOL 20130314
15 MV_IS_GEOMAP_SCENARIO Instance attribute Private Type reference (TYPE) ABAP_BOOL 20130412
16 MV_IS_MAXIMIZED Instance attribute Private Type reference (TYPE) WDY_BOOLEAN UIBB is maximized in OVP 20131017
Methods
# Method Level Visibility Method type Description Created on
1 ADJUST_ACTION_CONTEXT Instance method Private Method 20131106
2 CONSTRUCTOR Instance method Public Constructor CONSTRUCTOR 20130308
3 DISPATCH_AFTER_FAILED_EVENT Instance method Public Method Processes the time point AFTER_FAILED_EVENT within feeder 20130311
4 DISPATCH_FLUSH Instance method Public Method Processes the time point FLUSH within feeder 20130311
5 DISPATCH_NEEDS_CONFIRMATION Instance method Public Method Processes the time point NEEDS_CONFIRMATION within feeder 20130311
6 DISPATCH_PBO Instance method Public Method Processes the time point PBO within feeder 20130311
7 DISPATCH_PROCESS_EVENT Instance method Public Method Processes the time point PROCESS_EVENT within feeder 20130311
8 DISPATCH_TBAR_ACTION Instance method Public Method 20131021
9 EXPANDS_WITH_AVAILABLE_SPACE Instance method Public Method 20140523
10 GET_FEEDER_MODEL Instance method Public Method Returns feeder model interface (wire model) 20130311
11 INITIALIZE_VBI Instance method Public Method Adds the Java script call for initial load of VisBiz Island 20130311
12 INIT_FEEDER Instance method Public Method Initializes the feeder class 20130308
13 INIT_RENDERER Instance method Private Method 20131021
14 INIT_VB_APPLICATION Instance method Private Method Instanciates VBI Application 20130311
15 IS_GEOMAP_SCENARIO Instance method Private Method 20130412
16 MAP_CONFIG Instance method Private Method Maps the Web Dynpro context to internal structure 20130308
17 ON_PERSONALIZATION_CALLBACK Instance method Private Event handling method Event Handler reacting on Personalization (message handling) 20130308
18 ON_VBI_CONTROL_EVENT Instance method Protected Event handling method Event Handler reacting on the VBI Control event 20130315
19 PROCESS_MESSAGES Instance method Private Method Processes the messages coming from feeder class 20130311
20 REGISTER_ONSUBMITEVENT Instance method Public Method Adds the Java script call for actions on the VisBiz Island 20130308
21 RENDER Instance method Private Method 20131021
22 RENDER_TOOLBAR Instance method Private Method 20131021
23 SAVE_PERSONALIZATION Instance method Public Method Saves the personalization data 20130328
24 SET_DEFAULT_VALUES Instance method Private Method Set default Values for Visual Business application 20131107
25 SET_HTML_ISLAND_OBJECT Instance method Public Method Stores the reference of the VisBiz HTML Island 20130308
26 VBI_SUBMIT Instance method Public Method Raises the VBI Submit event 20130314
27 WDDOINIT Instance method Public Method Initializes the VisBiz Application, Pers. Manager, Context.. 20130308
28 WDDOMODIFYVIEW Instance method Public Method Build-up of VisBiz HTML Island, registering on events, DTA 20130311
Events
Class CL_FPM_VISBIZ_UIBB_ASSIST has no event.
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 YS_BUTTON_ACTION Public See coding 20131017 BEGIN OF ys_button_action, event_id TYPE fpm_event_id, text TYPE fpm_text, index TYPE fpm_index, event_parameters TYPE string, element_id TYPE fpm_element_id, action_type TYPE fpm_action_type, has_separator TYPE fpm_add_separator, END OF ys_button_action
2 YS_BUTTON_ROW Public See coding 20131017 BEGIN OF ys_button_row, button_row_element TYPE yt_button_row_element, END OF ys_button_row
3 YS_BUTTON_ROW_ELEMENT Public See coding 20131017 BEGIN OF ys_button_row_element, display_type TYPE fpmgb_display_type, element_id TYPE fpm_element_id, index TYPE fpm_index, text TYPE fpm_text, tooltip TYPE fpm_tooltip, special_properties TYPE string, explanation_text TYPE fpm_explanation, button_action TYPE yt_button_action, END OF ys_button_row_element
4 YS_CONTEXT_NODE Private See coding 20131017 BEGIN OF ys_context_node, parent TYPE string, name TYPE string, multiple TYPE wdy_boolean, END OF ys_context_node
5 YS_FEEDER Private See coding 20130305 BEGIN OF ys_feeder, name TYPE seoclsname, feeder TYPE REF TO if_fpm_guibb_visbiz, is_extended TYPE boole_d, is_model TYPE boole_d, is_enhancement_access TYPE boole_d, END OF ys_feeder
6 YS_PARAMETER Public See coding 20131018 BEGIN OF ys_parameter, name TYPE fpmgb_parameter_name, value TYPE fpmgb_parameter_value, END OF ys_parameter
7 YS_SETTINGS Public See coding 20130808 BEGIN OF ys_settings, height TYPE fpmgb_ui_element_height, width TYPE fpmgb_ui_element_width, END OF ys_settings
8 YS_START_POSITION Public See coding 20130308 BEGIN OF ys_start_position, longitude TYPE vbi_obj_pos_longitude, latitude TYPE vbi_obj_pos_latitude, elevation TYPE vbi_obj_elevation_float, zoomlevel TYPE vbi_zoomlevel, pitch TYPE vbi_pitch_angle, rotation_angle TYPE vbi_rotation_angle, END OF ys_start_position
9 YS_TOOLBAR Private See coding 20131126 BEGIN OF ys_toolbar, visible TYPE wdui_visibility, visible_bc_items TYPE wdy_boolean, enabled TYPE wdy_boolean, text TYPE string, tooltip TYPE string, imagesrc TYPE string, toggle_state TYPE wdy_boolean, END OF ys_toolbar
10 YS_VISBIZ Public See coding 20130308 BEGIN OF ys_visbiz, application TYPE vbi_app_id, default_map_stack TYPE vbi_default_map_stack, feeder TYPE fpmgb_feeder_class, mime_rep_path TYPE vbi_mime_rep_path, personalization_enabled TYPE fpm_personalization_enabled, aria_landmark TYPE fpm_aria_landmark , has_max_min_button TYPE fpm_has_max_min_button, visbiz_classes TYPE ys_visbiz_classes, parameter TYPE yt_parameter, start_position TYPE ys_start_position, settings TYPE ys_settings, button_row TYPE ys_button_row, END OF ys_visbiz
11 YS_VISBIZ_CLASSES Public See coding 20130424 BEGIN OF ys_visbiz_classes, service_provider_class_name TYPE vbi_sprovider_clsname, adapter_class_name TYPE vbi_ui_adapter_clsname, appl_class_name TYPE vbi_application_classname, run_quiet TYPE vbi_run_quiet, END OF ys_visbiz_classes
12 YT_BUTTON_ACTION Public See coding 20131017 yt_button_action TYPE STANDARD TABLE OF ys_button_action WITH KEY element_id
13 YT_BUTTON_ROW_ELEMENT Public See coding 20131017 yt_button_row_element TYPE STANDARD TABLE OF ys_button_row_element WITH KEY element_id
14 YT_CONTEXT_NODE Private See coding 20131017 yt_context_node TYPE STANDARD TABLE OF ys_context_node WITH KEY name
15 YT_PARAMETER Public See coding 20131018 yt_parameter TYPE STANDARD TABLE OF ys_parameter WITH KEY name
Method Signatures

Method ADJUST_ACTION_CONTEXT Signature

Method ADJUST_ACTION_CONTEXT on class CL_FPM_VISBIZ_UIBB_ASSIST has no parameter.
Method ADJUST_ACTION_CONTEXT on class CL_FPM_VISBIZ_UIBB_ASSIST has no exception.

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_FPM_VISBIZ_UIBB_ASSIST has no parameter.
Method CONSTRUCTOR on class CL_FPM_VISBIZ_UIBB_ASSIST has no exception.

Method DISPATCH_AFTER_FAILED_EVENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_EVENT Call by reference Object reference (TYPE REF TO) CL_FPM_EVENT CL_FPM_EVENT 20130311
2 Importing IV_REVERT Call by reference Type reference (TYPE) BOOLE_D Data element for domain BOOLE: TRUE (='X') and FALSE (=' ') 20130311

Method DISPATCH_AFTER_FAILED_EVENT on class CL_FPM_VISBIZ_UIBB_ASSIST has no exception.

Method DISPATCH_FLUSH Signature

Method DISPATCH_FLUSH on class CL_FPM_VISBIZ_UIBB_ASSIST has no parameter.
Method DISPATCH_FLUSH on class CL_FPM_VISBIZ_UIBB_ASSIST has no exception.

Method DISPATCH_NEEDS_CONFIRMATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EO_CONF_REQUEST Call by reference Object reference (TYPE REF TO) CL_FPM_CONFIRMATION_REQUEST Requests an end-user confirmation (e.g. data loss warning) 20130311
2 Importing IO_EVENT Call by reference Object reference (TYPE REF TO) CL_FPM_EVENT CL_FPM_EVENT 20130311

Method DISPATCH_NEEDS_CONFIRMATION on class CL_FPM_VISBIZ_UIBB_ASSIST has no exception.

Method DISPATCH_PBO Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_EVENT Call by reference Object reference (TYPE REF TO) CL_FPM_EVENT CL_FPM_EVENT 20130311

Method DISPATCH_PBO on class CL_FPM_VISBIZ_UIBB_ASSIST has no exception.

Method DISPATCH_PROCESS_EVENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EV_RESULT Call by reference Type reference (TYPE) FPM_EVENT_RESULT Result of processing of a specific FPM event 20130311
2 Importing IO_EVENT Call by reference Object reference (TYPE REF TO) CL_FPM_EVENT CL_FPM_EVENT 20130311

Method DISPATCH_PROCESS_EVENT on class CL_FPM_VISBIZ_UIBB_ASSIST has no exception.

Method DISPATCH_TBAR_ACTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_EVENT Call by reference Object reference (TYPE REF TO) CL_WD_CUSTOM_EVENT Application-Defined Event 20131021
2 Importing IV_ACTION_TYPE Call by reference Type reference (TYPE) FPM_ACTION_TYPE IF_FPM_CONSTANTS=>GC_ACTION_TYPE-STANDARD Type of FPM Event Action 20131021

Method DISPATCH_TBAR_ACTION on class CL_FPM_VISBIZ_UIBB_ASSIST has no exception.

Method EXPANDS_WITH_AVAILABLE_SPACE Signature

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

Method EXPANDS_WITH_AVAILABLE_SPACE on class CL_FPM_VISBIZ_UIBB_ASSIST has no exception.

Method GET_FEEDER_MODEL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RO_FEEDER_MODEL Value transfer Object reference (TYPE REF TO) IF_FPM_FEEDER_MODEL Feeder Model Interface 20130311

Method GET_FEEDER_MODEL on class CL_FPM_VISBIZ_UIBB_ASSIST has no exception.

Method INITIALIZE_VBI Signature

Method INITIALIZE_VBI on class CL_FPM_VISBIZ_UIBB_ASSIST has no parameter.
Method INITIALIZE_VBI on class CL_FPM_VISBIZ_UIBB_ASSIST has no exception.

Method INIT_FEEDER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ES_MESSAGE Call by reference Type reference (TYPE) FPMGB_S_T100_MESSAGE FPMGB T100 messages 20130311
2 Exporting EV_ADDITIONAL_ERROR_INFO Call by reference Type reference (TYPE) DOKU_OBJ Documentation Object 20130311
3 Exporting EV_ERROR Call by reference Type reference (TYPE) BOOLEAN Boolean Variable (X=True, -=False, Space=Unknown) 20130311

Method INIT_FEEDER on class CL_FPM_VISBIZ_UIBB_ASSIST has no exception.

Method INIT_RENDERER Signature

Method INIT_RENDERER on class CL_FPM_VISBIZ_UIBB_ASSIST has no parameter.
Method INIT_RENDERER on class CL_FPM_VISBIZ_UIBB_ASSIST has no exception.

Method INIT_VB_APPLICATION Signature

Method INIT_VB_APPLICATION on class CL_FPM_VISBIZ_UIBB_ASSIST has no parameter.
Method INIT_VB_APPLICATION on class CL_FPM_VISBIZ_UIBB_ASSIST has no exception.

Method IS_GEOMAP_SCENARIO Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_IS_GEOMAP_SCENARIO Value transfer Type reference (TYPE) ABAP_BOOL 20130412

Method IS_GEOMAP_SCENARIO on class CL_FPM_VISBIZ_UIBB_ASSIST has no exception.

Method MAP_CONFIG Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_CONTEXT Call by reference Object reference (TYPE REF TO) IF_WD_CONTEXT_NODE Web Dynpro Context 20130308

Method MAP_CONFIG on class CL_FPM_VISBIZ_UIBB_ASSIST has no exception.

Method ON_PERSONALIZATION_CALLBACK Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing HAS_ERRORS Value transfer Attribute reference (LIKE) Replacement for Real Boolean Type: 'X' == True '' == False 20130308
2 Importing MESSAGES Value transfer Attribute reference (LIKE) WBO Remote API: Messages for Result of Action 20130308

Method ON_PERSONALIZATION_CALLBACK on class CL_FPM_VISBIZ_UIBB_ASSIST has no exception.

Method ON_VBI_CONTROL_EVENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing EVENT_ID Value transfer Attribute reference (LIKE) Event ID 20130315
2 Importing EXTERNAL_DATA Call by reference Attribute reference (LIKE) 20140808
3 Importing OBJECT_GUIDS Call by reference Attribute reference (LIKE) >INVALID< 20130413
4 Importing OBJECT_TYPE Value transfer Attribute reference (LIKE) Object Type 20130315
5 Importing POINTER_POS Value transfer Attribute reference (LIKE) WGS84 Geoposition of mouse pointer (CTMenu req. only) 20130315
6 Importing SOURCE_OBJECT_GUIDS Call by reference Attribute reference (LIKE) >INVALID< 20130413

Method ON_VBI_CONTROL_EVENT on class CL_FPM_VISBIZ_UIBB_ASSIST has no exception.

Method PROCESS_MESSAGES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_MESSAGES Call by reference Type reference (TYPE) FPMGB_T_MESSAGES FPMGB Messages (T100 & Plaintext) 20130311

Method PROCESS_MESSAGES on class CL_FPM_VISBIZ_UIBB_ASSIST has no exception.

Method REGISTER_ONSUBMITEVENT Signature

Method REGISTER_ONSUBMITEVENT on class CL_FPM_VISBIZ_UIBB_ASSIST has no parameter.
Method REGISTER_ONSUBMITEVENT on class CL_FPM_VISBIZ_UIBB_ASSIST has no exception.

Method RENDER Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_VIEW Call by reference Object reference (TYPE REF TO) IF_WD_VIEW Web Dynpro: API of a View 20131021
2 Importing IV_FIRST_TIME Call by reference Type reference (TYPE) WDY_BOOLEAN Replacement for Real Boolean Type: 'X' == True '' == False 20131021

Method RENDER on class CL_FPM_VISBIZ_UIBB_ASSIST has no exception.

Method RENDER_TOOLBAR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_VIEW Call by reference Object reference (TYPE REF TO) IF_WD_VIEW Web Dynpro: API of a View 20131021

Method RENDER_TOOLBAR on class CL_FPM_VISBIZ_UIBB_ASSIST has no exception.

Method SAVE_PERSONALIZATION Signature

Method SAVE_PERSONALIZATION on class CL_FPM_VISBIZ_UIBB_ASSIST has no parameter.
Method SAVE_PERSONALIZATION on class CL_FPM_VISBIZ_UIBB_ASSIST has no exception.

Method SET_DEFAULT_VALUES Signature

Method SET_DEFAULT_VALUES on class CL_FPM_VISBIZ_UIBB_ASSIST has no parameter.
Method SET_DEFAULT_VALUES on class CL_FPM_VISBIZ_UIBB_ASSIST has no exception.

Method SET_HTML_ISLAND_OBJECT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_HTML_ISLAND Call by reference Object reference (TYPE REF TO) CL_WD_HTML_ISLAND 20130308

Method SET_HTML_ISLAND_OBJECT on class CL_FPM_VISBIZ_UIBB_ASSIST has no exception.

Method VBI_SUBMIT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_CONTEXT_ELEMENT Call by reference Object reference (TYPE REF TO) IF_WD_CONTEXT_ELEMENT Web Dynpro: Interface for Node Element 20130314
2 Importing IO_EVENT Call by reference Object reference (TYPE REF TO) CL_WD_CUSTOM_EVENT Application-Defined Event 20130314
3 Importing IV_DATA Call by reference Type reference (TYPE) STRING 20130314
4 Importing IV_ID Call by reference Type reference (TYPE) STRING 20130314

Method VBI_SUBMIT on class CL_FPM_VISBIZ_UIBB_ASSIST has no exception.

Method WDDOINIT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_COMPONENT Call by reference Object reference (TYPE REF TO) IF_WD_COMPONENT Web Dynpro: Component 20130308
2 Importing IO_CONTEXT Call by reference Object reference (TYPE REF TO) IF_WD_CONTEXT_NODE Web Dynpro: Interface for Context Nodes 20130308

Method WDDOINIT on class CL_FPM_VISBIZ_UIBB_ASSIST has no exception.

Method WDDOMODIFYVIEW Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_VIEW Call by reference Object reference (TYPE REF TO) IF_WD_VIEW Web Dynpro: API of a View 20130311
2 Importing IV_FIRST_TIME Call by reference Type reference (TYPE) WDY_BOOLEAN Replacement for Real Boolean Type: 'X' == True '' == False 20130311

Method WDDOMODIFYVIEW on class CL_FPM_VISBIZ_UIBB_ASSIST has no exception.
History
Last changed by/on SAP  20141120 
SAP Release Created in 740