SAP ABAP Class CL_VBI_APPLICATION (Visual Business Application Base Class)
Hierarchy
SAP_UI (Software Component) User Interface Technology
   CA-UI2-VBZ (Application Component) Visual Business -> please use CA-GTF-VBZ
     VBI_CORE_IMPL (Package) Visual Business Core Object Implementations
Meta Relationship - Using
# Relationship type Using Short Description Created on
1 Interface implementation (CLASS c. INTERFACES i_ref)  IF_VBI_CTMENU_EXT_PROVIDER Context Menu Extension Provider Interface 20130408
Meta Relationship - Used By
# Relationship type Used by Short Description Created on
1 Inheritance (c INHERITING FROM c_ref)  CL_FPM_VBI_APPLICATION Class for 3D scenario Visual Business 20130412
2 Inheritance (c INHERITING FROM c_ref)  CL_VBI_GEOMAP_APPLICATION GeoMap Applcation Class 20130107
Properties
Class CL_VBI_APPLICATION  
Short Description Visual Business Application Base Class    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package VBI_CORE_IMPL   Visual Business Core Object Implementations 
Created 20130107   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_CONTROL_ADAPTER Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
4 IF_VBI_SERVICE_PROVIDER Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
5 IF_VBI_UI_CONTROL_ABSTRACTION Forward declaration interface (INTERFACE i DEFINITION DEF...  Forward declaration interface (INTERFACE i DEFINITION DEF...
Interfaces
# Interface Abstract Final Description Created on
1 IF_VBI_CTMENU_EXT_PROVIDER Context Menu Extension Provider Interface 20130408
Friends
Class CL_VBI_APPLICATION has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 APP_DESCR_XML Instance attribute Protected Type reference (TYPE) XSTRING 20130107
2 CAMERA_PROPERTIES Instance attribute Protected Object reference (TYPE REF TO) IF_VBI_CONTROL_ADAPTER=>GTYPE_NAME_VALUE_TAB Camera Properties received with the event 20130930
3 COLLADA_VOS Instance attribute Protected Type reference (TYPE) GTYPE_COLLADA_VO_TAB Used Collada VOs 20130628
4 CO_CONTROL_GUID Constant Public Type reference (TYPE) STRING IF_VBI_UI_CONTROL_ABSTRACTION=>CO_CONTROL_GUID Control GUID 20130319
5 CO_DEFAULT_CURSOR_COPY Constant Public Type reference (TYPE) STRING 'RM_CUR_VISBIZ_COPY' BuildIn Cursor for Drop effect Copy 20130107
6 CO_DEFAULT_CURSOR_MOVE Constant Public Type reference (TYPE) STRING 'RM_CUR_VISBIZ_MOVE' BuildIn Cursor for Drop effect Move 20130107
7 CO_DEFAULT_CURSOR_NONE Constant Public Type reference (TYPE) STRING 'RM_CUR_VISBIZ_NONE' BuildIn Cursor for Drop effect None 20130107
8 CO_FCODE_DELETE_PERS Constant Public Type reference (TYPE) SYUCOMM 'VBI_PERS_DELETE_PERS' 20130319
9 CO_FCODE_STORE_SCENE_POS Constant Public Type reference (TYPE) SYUCOMM 'VBI_PERS_STORE_SCENE_POS' 20130319
10 CO_GEN_FCODE_PATTERN Constant Public Type reference (TYPE) SYUCOMM 'VBI_*' Function code pattern for generic functions 20130319
11 CO_PROJECT_FORMAT_JSON Constant Public Type reference (TYPE) STRING 'JSON' 20130710
12 CO_PROJECT_FORMAT_XML Constant Public Type reference (TYPE) STRING 'XML' 20130710
13 P13N_SERVICE Instance attribute Protected Object reference (TYPE REF TO) IF_VBI_PERSONALIZATION_SERVICE Personalization Service Interface 20130319
14 PERSONALIZATION_ALLOWED Instance attribute Protected Type reference (TYPE) ABAP_BOOL 20130321
15 SCENE_CHANGED Instance attribute Protected Type reference (TYPE) ABAP_BOOL Scene dirty state 20130107
16 SERVICE_PROVIDER Instance attribute Public Object reference (TYPE REF TO) IF_VBI_SERVICE_PROVIDER Scene Service Provider 20130107
17 UI_CONTROL Instance attribute Protected Object reference (TYPE REF TO) IF_VBI_UI_CONTROL_ABSTRACTION UI Control Abstraction Interface 20130107
Methods
# Method Level Visibility Method type Description Created on
1 ATTACH_PERSONALIZATION_SERVICE Instance method Public Method Sets an external p13n service 20130319
2 ATTACH_UI_CONTROL Instance method Public Method Set the UI control for visualization 20130107
3 CHECK_COLLADA_RESOURCES Instance method Private Method 20130628
4 CONSTRUCTOR Instance method Public Constructor CONSTRUCTOR 20130107
5 GET_CAMERA_PROPERTIES Instance method Public Method Returns the current camera props if available 20130930
6 GET_CONTEXT_MENU Instance method Protected Method Returns a Context Menu Descriptor 20130117
7 GET_DETAILS Instance method Protected Method Fills the Detail Descriptor 20130116
8 GET_INITIAL_APPL_DESCR Instance method Public Method Returns the initial ZIP archive for the control initializati 20130726
9 GET_INITIAL_ZIP_ARCHIVE Instance method Public Method Returns the initial ZIP archive for the control initializati 20130107
10 GET_P13N_CONTEXT_ID Instance method Protected Method Returns a Context ID under which personalization is stored 20130321
11 GET_P13N_SERVICE Instance method Protected Method 20130319
12 HANDLE_DATA_CHANGES Instance method Protected Method Handler for Data changes 20140425
13 HANDLE_DRAG_DROP Instance method Protected Method Handler for Drap'n Drop operations 20130408
14 HANDLE_EVENT Instance method Protected Method Generic application event dispatching 20130116
15 HANDLE_EXTERNAL_DROP Instance method Protected Method Handler for Drap'n Drop operations 20140714
16 HANDLE_FCODE Instance method Protected Method Handler for Application specific FCodes 20130117
17 HANDLE_GENERIC_FCODES Instance method Protected Method 20130319
18 INITIALIZE Instance method Public Method Initializes the application instance 20130107
19 ON_CONTROL_EVENT Instance method Protected Event handling method Event Handler for control adapter event 20130408
20 ON_DATA_CHANGED Instance method Protected Event handling method Event Handler for control adapter event 20130408
21 TRIGGER_SAVE Instance method Public Method 20140303
Events
# Event Type Visibility Description Created on
1 APPLICATION_EVENT Instance Event
(0)
Public
(2)
Application Event 20130226
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 GTYPE_COLLADA_VO_ENTRY Public See coding 20130628 begin of GTYPE_COLLADA_VO_ENTRY, ID type STRING, RESOURCE_NAME type STRING, end of GTYPE_COLLADA_VO_ENTRY
2 GTYPE_COLLADA_VO_TAB Public See coding 20130628 GTYPE_COLLADA_VO_TAB type standard table of GTYPE_COLLADA_VO_ENTRY with non-unique default key
3 GTYPE_CONFIG Protected See coding 20140514 begin of GTYPE_CONFIG, TRACE type ABAP_BOOL, LANGUAGE type LAISO, DROP_EFFECTS type GTYPE_DROP_EFFECTS, LIGHTS type IF_VBI_CONTROL_ADAPTER=>GTYPE_LIGHTS, end of GTYPE_CONFIG
4 GTYPE_DROP_EFFECTS Public See coding 20130107 begin of GTYPE_DROP_EFFECTS, NONE type STRING, COPY type STRING, MOVE type STRING, end of GTYPE_DROP_EFFECTS
5 GTYPE_RESOURCE_ENTRY Public See coding 20130107 begin of GTYPE_RESOURCE_ENTRY, NAME type STRING, CONTENT type XSTRING, end of GTYPE_RESOURCE_ENTRY
6 GTYPE_RESOURCE_TAB Public See coding 20130107 GTYPE_RESOURCE_TAB type standard table of GTYPE_RESOURCE_ENTRY with non-unique default key
7 GTYPE_SCENE_POSITION Public See coding 20130107 begin of GTYPE_SCENE_POSITION, CENTER type VBI_S_OBJ_GEOPOS, ZOOM type VBI_ZOOMLEVEL, SCENE_PITCH type VBI_PITCH_ANGLE, SCENE_ROTATION type VBI_ROTATION_ANGLE, end of GTYPE_SCENE_POSITION
Method Signatures

Method ATTACH_PERSONALIZATION_SERVICE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_SERVICE Call by reference Object reference (TYPE REF TO) IF_VBI_PERSONALIZATION_SERVICE Personalization Service Interface 20130319

Method ATTACH_PERSONALIZATION_SERVICE on class CL_VBI_APPLICATION has no exception.

Method ATTACH_UI_CONTROL Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_UI_CONTROL Call by reference Object reference (TYPE REF TO) IF_VBI_UI_CONTROL_ABSTRACTION UI Control Abstraction Interface 20130107

Method ATTACH_UI_CONTROL on class CL_VBI_APPLICATION has no exception.

Method CHECK_COLLADA_RESOURCES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_RESOURCES Call by reference Type reference (TYPE) GTYPE_RESOURCE_TAB 20130628
2 Returning RV_RESULT Value transfer Type reference (TYPE) ABAP_BOOL 20130628

Method CHECK_COLLADA_RESOURCES on class CL_VBI_APPLICATION has no exception.

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_CONTROL_ADAPTER Call by reference Type reference (TYPE) SEOCLSNAME 'CL_VBI_CONTROL_ADAPTER' Name of Output Adapter Impl class 20130226
2 Importing IV_SCENE_MANAGER Call by reference Type reference (TYPE) SEOCLSNAME 'CL_VBI_SCENE_MANAGER' Name of Scene Manager Impl class 20130327
3 Importing IV_SERVICE_PROVIDER_IMPL_CLASS Call by reference Type reference (TYPE) SEOCLSNAME 'CL_VBI_SERVICE_PROVIDER' Name of Service Provider Impl class 20130107

Method CONSTRUCTOR on class CL_VBI_APPLICATION has no exception.

Method GET_CAMERA_PROPERTIES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RS_RESULT Value transfer Type reference (TYPE) IF_VBI_CONTROL_ADAPTER=>GTYPE_NAME_VALUE_TAB 20130930

Method GET_CAMERA_PROPERTIES on class CL_VBI_APPLICATION has no exception.

Method GET_CONTEXT_MENU Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_POINTER_POS Call by reference Type reference (TYPE) VBI_S_OBJ_GEOPOS WGS84 Goeposition 20130117
2 Importing IV_OBJECT_GUID Call by reference Type reference (TYPE) VBI_OBJECT_GUID Model Object GUID 20130117
3 Importing IV_OBJECT_TYPE Call by reference Type reference (TYPE) STRING 20130117
4 Returning RV_RESULT Value transfer Object reference (TYPE REF TO) CL_CTMENU Context Menu 20130117

Method GET_CONTEXT_MENU on class CL_VBI_APPLICATION has no exception.

Method GET_DETAILS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_OBJECT_GUID Call by reference Type reference (TYPE) VBI_OBJECT_GUID Model Object GUID 20130116
2 Importing IV_OBJECT_TYPE Call by reference Type reference (TYPE) VBI_OBJECT_TYPE Object Type 20130117
3 Returning RV_RESULT Value transfer Object reference (TYPE REF TO) CL_VBI_OBJECT_DETAILS_DESCR 20130116

Method GET_DETAILS on class CL_VBI_APPLICATION has no exception.

Method GET_INITIAL_APPL_DESCR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_ADDITIONAL_RESOURCES Call by reference Type reference (TYPE) GTYPE_RESOURCE_TAB Additional Resources to be added to ZIP archive 20130726
2 Importing IV_MIME_REP_PATH Call by reference Type reference (TYPE) STRING '/sap/public/bc/vbi/Traditional/' MIME Repository path to resources 20130726
3 Importing IV_PROJECT_FORMAT Call by reference Type reference (TYPE) STRING CO_PROJECT_FORMAT_XML Desired format of the project file 20130726
4 Returning RV_RESULT Value transfer Type reference (TYPE) STRING BASE64 encoded ZIP archive 20130726

Method GET_INITIAL_APPL_DESCR on class CL_VBI_APPLICATION has no exception.

Method GET_INITIAL_ZIP_ARCHIVE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_ADDITIONAL_RESOURCES Call by reference Type reference (TYPE) GTYPE_RESOURCE_TAB Additional Resources to be added to ZIP archive 20130107
2 Importing IV_MIME_REP_PATH Call by reference Type reference (TYPE) STRING '/sap/public/bc/vbi/Traditional/' MIME Repository path to resources 20130107
3 Importing IV_PROJECT_FORMAT Call by reference Type reference (TYPE) STRING CO_PROJECT_FORMAT_XML Desired format of the project file 20130710
4 Returning RV_RESULT Value transfer Type reference (TYPE) STRING BASE64 encoded ZIP archive 20130107

Method GET_INITIAL_ZIP_ARCHIVE on class CL_VBI_APPLICATION has no exception.

Method GET_P13N_CONTEXT_ID Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_RESULT Value transfer Type reference (TYPE) VBI_CONFIG_ID Configuration Identifier 20130321

Method GET_P13N_CONTEXT_ID on class CL_VBI_APPLICATION has no exception.

Method GET_P13N_SERVICE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Returning RV_RESULT Value transfer Object reference (TYPE REF TO) IF_VBI_PERSONALIZATION_SERVICE Personalization Service Interface 20130319

Method GET_P13N_SERVICE on class CL_VBI_APPLICATION has no exception.

Method HANDLE_DATA_CHANGES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_AREAS Call by reference Type reference (TYPE) IF_VBI_SERVICE_PROVIDER=>CHANGED_AREAS_TAB 20140425
2 Importing IT_LINKS Call by reference Type reference (TYPE) IF_VBI_SERVICE_PROVIDER=>CHANGED_LINKS_TAB 20140425
3 Importing IT_SPOTS Call by reference Type reference (TYPE) IF_VBI_SERVICE_PROVIDER=>CHANGED_SPOTS_TAB 20140425

Method HANDLE_DATA_CHANGES on class CL_VBI_APPLICATION has no exception.

Method HANDLE_DRAG_DROP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CV_EVENT_HANDLED Call by reference Type reference (TYPE) ABAP_BOOL 20130408
2 Importing IT_DRAG_SOURCE_GUIDS Call by reference Type reference (TYPE) VBI_T_OBJECT_GUIDS GUIDs of Drag Source Objects 20130408
3 Importing IT_DROP_TARGET_GUIDS Call by reference Type reference (TYPE) VBI_T_OBJECT_GUIDS GUIDs of Drop target Objects 20130408
4 Importing IV_TARGET_OBJECT_TYPE Call by reference Type reference (TYPE) STRING 20130408

Method HANDLE_DRAG_DROP on class CL_VBI_APPLICATION has no exception.

Method HANDLE_EVENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CV_EVENT_HANDLED Call by reference Type reference (TYPE) ABAP_BOOL 20130116
2 Importing IS_POINTER_POS Call by reference Type reference (TYPE) VBI_S_OBJ_GEOPOS WGS84 Goeposition 20130116
3 Importing IT_OBJECT_GUIDS Call by reference Type reference (TYPE) VBI_T_OBJECT_GUIDS Target Object GUIDs 20130408
4 Importing IT_SOURCE_OBJECT_GUIDS Call by reference Type reference (TYPE) VBI_T_OBJECT_GUIDS Source Object GUIDs (DnD only) 20130408
5 Importing IV_EVENT_ID Call by reference Type reference (TYPE) IF_VBI_CONST=>GTY_EVENT_ID 20130116
6 Importing IV_EXTERNAL_DATA Call by reference Type reference (TYPE) STRING Dropped external data 20140714
7 Importing IV_OBJECT_TYPE Call by reference Type reference (TYPE) STRING 20130117

Method HANDLE_EVENT on class CL_VBI_APPLICATION has no exception.

Method HANDLE_EXTERNAL_DROP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CV_EVENT_HANDLED Call by reference Type reference (TYPE) ABAP_BOOL 20140714
2 Importing IT_DROP_TARGET_GUIDS Call by reference Type reference (TYPE) VBI_T_OBJECT_GUIDS GUIDs of Drop target Objects 20140714
3 Importing IV_EXTERNAL_DATA Call by reference Type reference (TYPE) STRING Dropped external data 20140714
4 Importing IV_TARGET_OBJECT_TYPE Call by reference Type reference (TYPE) STRING 20140714

Method HANDLE_EXTERNAL_DROP on class CL_VBI_APPLICATION has no exception.

Method HANDLE_FCODE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing CV_EVENT_HANDLED Call by reference Type reference (TYPE) ABAP_BOOL 20130117
2 Importing IT_OBJECT_GUIDS Call by reference Type reference (TYPE) VBI_T_OBJECT_GUIDS Model Object GUIDs 20130408
3 Importing IV_FCODE Call by reference Type reference (TYPE) IF_VBI_CONST=>GTY_EVENT_ID Function code that PAI triggered 20130117
4 Importing IV_OBJECT_TYPE Call by reference Type reference (TYPE) STRING 20130117

Method HANDLE_FCODE on class CL_VBI_APPLICATION has no exception.

Method HANDLE_GENERIC_FCODES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_PROPERTIES Call by reference Type reference (TYPE) IF_VBI_CONTROL_ADAPTER=>GTYPE_NAME_VALUE_TAB 20130319
2 Importing IV_FCODE Call by reference Type reference (TYPE) IF_VBI_CONST=>GTY_EVENT_ID Function code that PAI triggered 20130319

Method HANDLE_GENERIC_FCODES on class CL_VBI_APPLICATION has no exception.

Method INITIALIZE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_DROP_EFFECTS Call by reference Type reference (TYPE) GTYPE_DROP_EFFECTS Drop Effect Cursor names 20130107
2 Importing IS_START_POSITION Call by reference Type reference (TYPE) GTYPE_SCENE_POSITION Start Position of the scene 20130107
3 Importing IT_COLLADA_VOS Call by reference Type reference (TYPE) GTYPE_COLLADA_VO_TAB Table of required Collada VOs 20130628
4 Importing IT_LIGHTS Call by reference Type reference (TYPE) IF_VBI_CONTROL_ADAPTER=>GTYPE_LIGHTS Optional: Lights for the Scene 20140514
5 Importing IV_APPLICATION_ID Call by reference Type reference (TYPE) VBI_APP_ID Visual Business Application Identifier 20130107
6 Importing IV_PERSONALIZATION_ALLOWED Call by reference Type reference (TYPE) ABAP_BOOL ABAP_TRUE 20130321

Method INITIALIZE on class CL_VBI_APPLICATION has no exception.

Method ON_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) 20130408
2 Importing OBJECT_GUIDS Value transfer Attribute reference (LIKE) >INVALID< 20130408
3 Importing OBJECT_TYPE Value transfer Attribute reference (LIKE) 20130408
4 Importing POINTER_POS Value transfer Attribute reference (LIKE) 20130408
5 Importing PROPERTIES Value transfer Attribute reference (LIKE) 20130408
6 Importing SOURCE_OBJECT_GUIDS Value transfer Attribute reference (LIKE) >INVALID< 20130408

Method ON_CONTROL_EVENT on class CL_VBI_APPLICATION has no exception.

Method ON_DATA_CHANGED Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CHANGED_AREAS Value transfer Attribute reference (LIKE) 20130408
2 Importing CHANGED_LINKS Value transfer Attribute reference (LIKE) 20130408
3 Importing CHANGED_SPOTS Value transfer Attribute reference (LIKE) 20130408

Method ON_DATA_CHANGED on class CL_VBI_APPLICATION has no exception.

Method TRIGGER_SAVE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_SAVE_HANDLER Call by reference Object reference (TYPE REF TO) IF_VBI_SAVE_HANDLER Handler Interface for Async Save process 20140303

Method TRIGGER_SAVE on class CL_VBI_APPLICATION has no exception.
Event Signatures

Event APPLICATION_EVENT Signature
# Parameter Type Pass Value Optional Typing Method Associated Type Default value Description Created on
1 EVENT_ID Exporting Value transfer Type reference (TYPE) IF_VBI_CONST=>GTY_EVENT_ID Event ID 20130226
2 EXTERNAL_DATA Exporting Value transfer Type reference (TYPE) STRING Dropped external data 20140714
3 OBJECT_GUIDS Exporting Value transfer Object reference (TYPE REF TO) VBI_T_OBJECT_GUIDS Target Object GUIDs 20130408
4 OBJECT_TYPE Exporting Value transfer Type reference (TYPE) VBI_OBJECT_TYPE Object Type 20130226
5 POINTER_POS Exporting Value transfer Type reference (TYPE) VBI_S_OBJ_GEOPOS WGS84 Geoposition of mouse pointer (CTMenu req. only) 20130226
6 SOURCE_OBJECT_GUIDS Exporting Value transfer Object reference (TYPE REF TO) VBI_T_OBJECT_GUIDS Source Object GUIDs (only DnD) 20130408
History
Last changed by/on SAP  20141120 
SAP Release Created in 100