SAP ABAP Interface IF_VBI_SERVICE_PROVIDER (Scene Service Provider)
Hierarchy
☛
SAP_UI (Software Component) User Interface Technology
⤷
CA-UI2-VBZ (Application Component) Visual Business -> please use CA-GTF-VBZ
⤷
VBI_INTERFACES (Package) Visual Business Interfaces
⤷
⤷
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_VBI_SERVICE_PROVIDER | Generic Service Provider | 20121219 |
Properties
| Interface | IF_VBI_SERVICE_PROVIDER | |
| Short Description | Scene Service Provider |
General Data
| Package | VBI_INTERFACES | Visual Business Interfaces |
| Created | 20121004 | SAP |
| Last changed | 20141121 | |
| 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) |
Interfaces
Interface IF_VBI_SERVICE_PROVIDER has no interface.
Friends
Interface IF_VBI_SERVICE_PROVIDER has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CONTROL_ADAPTER | Instance attribute | Public | Object reference (TYPE REF TO) | IF_VBI_CONTROL_ADAPTER | 20130226 | |||
| 2 | SCENE_MANAGER | Instance attribute | Public | Object reference (TYPE REF TO) | IF_VBI_SCENE_MANAGER | Scene Manager Read Interface | 20130107 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Clear current scene | 20130410 | |
| 2 | Instance method | Public | Method | Handles Events on the Scene | 20130327 | |
| 3 | Instance method | Public | Method | Remove Objects from current scene | 20130410 | |
| 4 | Instance method | Public | Method | Reset map object selection | 20130410 | |
| 5 | Instance method | Public | Method | Apply display profile to filter visisble scene content | 20121004 | |
| 6 | Instance method | Public | Method | Update scene objects (object wise) | 20121004 | |
| 7 | Instance method | Public | Method | Update scene objects (field wise) | 20140428 |
Events
Interface IF_VBI_SERVICE_PROVIDER has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | AREAS_TAB | Public | See coding | Table of Areas | 20121004 | AREAS_TAB type standard table of AREA_ENTRY with non-unique default key
|
|
| 2 | AREA_ENTRY | Public | See coding | Area structure | 20121004 | begin of AREA_ENTRY.
include type OBJECT_BASE as BASE.
include type AREA_EXTENSION as EXT.
types: end of AREA_ENTRY
|
|
| 3 | AREA_EXTENSION | Public | See coding | Extension fields for Areas | 20130208 | begin of AREA_EXTENSION,
BORDER_POINTS type VBI_T_OBJ_GEOPOS,
end of AREA_EXTENSION
|
|
| 4 | CHANGED_AREAS_TAB | Public | See coding | Table of changed Areas | 20130408 | CHANGED_AREAS_TAB type standard table of CHANGED_AREA_ENTRY with non-unique default key
|
|
| 5 | CHANGED_AREA_ENTRY | Public | See coding | Area structure with changed fields addition | 20130408 | begin of CHANGED_AREA_ENTRY.
include type AREA_ENTRY.
types: CHANGED_FIELDS type FIELD_NAME_TAB,
end of CHANGED_AREA_ENTRY
|
|
| 6 | CHANGED_LINKS_TAB | Public | See coding | Table of changed Links | 20130408 | CHANGED_LINKS_TAB type standard table of CHANGED_LINK_ENTRY with non-unique default key
|
|
| 7 | CHANGED_LINK_ENTRY | Public | See coding | Link structure with changed fields addition | 20130408 | begin of CHANGED_LINK_ENTRY.
include type LINK_ENTRY.
types: CHANGED_FIELDS type FIELD_NAME_TAB,
end of CHANGED_LINK_ENTRY
|
|
| 8 | CHANGED_SPOTS_TAB | Public | See coding | Table of changed Spots | 20130408 | CHANGED_SPOTS_TAB type standard table of CHANGED_SPOT_ENTRY with non-unique default key
|
|
| 9 | CHANGED_SPOT_ENTRY | Public | See coding | Spot structure with changed fields addition | 20130408 | begin of CHANGED_SPOT_ENTRY.
include type SPOT_ENTRY.
types: CHANGED_FIELDS type FIELD_NAME_TAB,
end of CHANGED_SPOT_ENTRY
|
|
| 10 | DISPLAY_PROFILE_ENTRY | Public | See coding | Display Profile entry structure | 20130410 | begin of DISPLAY_PROFILE_ENTRY,
OBJECT_ROLE type VBI_OBJECT_ROLE,
DESCRIPTION type TEXT25,
VISIBLE type ABAP_BOOL,
end of DISPLAY_PROFILE_ENTRY
|
|
| 11 | DISPLAY_PROFILE_TAB | Public | See coding | Display Profile table | 20130410 | DISPLAY_PROFILE_TAB type standard table of DISPLAY_PROFILE_ENTRY with non-unique default key
|
|
| 12 | FIELD_NAME_TAB | Public | See coding | 20140425 | FIELD_NAME_TAB type standard table of NAME_KOMP with non-unique key TABLE_LINE
|
||
| 13 | LINKS_TAB | Public | See coding | Table of Links | 20121004 | LINKS_TAB type standard table of LINK_ENTRY with non-unique default key
|
|
| 14 | LINK_ENTRY | Public | See coding | Link structure | 20121004 | begin of LINK_ENTRY.
include type OBJECT_BASE as BASE.
include type LINK_EXTENSION as EXT.
types: end of LINK_ENTRY
|
|
| 15 | LINK_EXTENSION | Public | See coding | Extension fields for Links | 20130208 | begin of LINK_EXTENSION,
LINK_START type LINK_POINT,
LINK_DEST type LINK_POINT,
ROUTE_POINTS type VBI_T_OBJ_GEOPOS,
HEAD_STYLE type VBI_HEAD_STYLE,
LINE_WIDTH type FLOAT,
DOT_WIDTH type FLOAT,
DOT_COLOR type VBI_COLOR,
end of LINK_EXTENSION
|
|
| 16 | LINK_POINT | Public | See coding | Link point structure | 20121004 | begin of LINK_POINT,
REFERENCE_SPOT_GUID type VBI_OBJECT_GUID,
POSITION type VBI_S_OBJ_GEOPOS,
end of LINK_POINT
|
|
| 17 | OBJECT_BASE | Public | See coding | Structure of common fields and GUID key | 20130116 | begin of OBJECT_BASE,
GUID type VBI_OBJECT_GUID.
include type OBJECT_BASE_DATA as BASE_DATA.
types: end of OBJECT_BASE
|
|
| 18 | OBJECT_BASE_DATA | Public | See coding | Structure of common fields for all objects | 20130208 | begin of OBJECT_BASE_DATA,
ID type VBI_OBJECT_ID,
TYPE type VBI_OBJECT_TYPE,
ROLES type VBI_T_OBJECT_ROLES,
DESCRIPTION type VBI_T_OBJECT_DESCRIPTION,
FIXED type ABAP_BOOL,
SELECTED type ABAP_BOOL,
HIGHLIGHTED type ABAP_BOOL,
CHANGEABLE type ABAP_BOOL,
FLY_TO type ABAP_BOOL,
SHOW_LABEL type ABAP_BOOL,
FILL_COLOR type VBI_COLOR,
BORDER_COLOR type VBI_COLOR,
HOT_COLOR type VBI_DELTA_COLOR,
SELECT_COLOR type VBI_DELTA_COLOR,
SPECIFIC_PROPERTIES type ref to DATA,
end of OBJECT_BASE_DATA
|
|
| 19 | SPOTS_TAB | Public | See coding | Table of spots | 20121004 | SPOTS_TAB type standard table of SPOT_ENTRY with non-unique default key
|
|
| 20 | SPOT_ENTRY | Public | See coding | Spot structure | 20121004 | begin of SPOT_ENTRY.
include type OBJECT_BASE as BASE.
include type SPOT_EXTENSION as EXT.
types: end of SPOT_ENTRY
|
|
| 21 | SPOT_EXTENSION | Public | See coding | Extension fields for spots | 20130208 | begin of SPOT_EXTENSION,
POSITION type VBI_S_OBJ_GEOPOS,
end of SPOT_EXTENSION
|
Method Signatures
Method CLEAR_SCENE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_OBJECT_ROLES_2_KEEP | Call by reference | Type reference (TYPE) | VBI_T_OBJECT_ROLES | Roles Table for Scene Objects | 20130410 | |||
| 2 | IV_CLEAR_FIXED | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20130410 |
Method CLEAR_SCENE on Interface IF_VBI_SERVICE_PROVIDER has no exception.
Method HANDLE_SCENE_EVENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CV_EVENT_HANDLED | Call by reference | Type reference (TYPE) | ABAP_BOOL | Indicator: Event handled | 20130327 | |||
| 2 | IS_POINTER_POSITION | Call by reference | Type reference (TYPE) | VBI_S_OBJ_GEOPOS | Geoposition of the mouse pointer when event was fired | 20130327 | |||
| 3 | IT_DRAG_SOURCE_GUIDS | Call by reference | Type reference (TYPE) | VBI_T_OBJECT_GUIDS | Table of Object GUIDs, as drag source in a drop operation | 20130327 | |||
| 4 | IT_OBJECT_GUIDS | Call by reference | Type reference (TYPE) | VBI_T_OBJECT_GUIDS | Table of Object GUIDs, for which the event was fired | 20130327 | |||
| 5 | IV_EVENT_ID | Call by reference | Type reference (TYPE) | VBI_EVENT_ID | Visual Business EventID | 20130327 |
Method HANDLE_SCENE_EVENT on Interface IF_VBI_SERVICE_PROVIDER has no exception.
Method REMOVE_SCENE_OBJECTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_OBJECT_GUIDS | Call by reference | Type reference (TYPE) | VBI_T_OBJECT_GUIDS | Table of Model Object GUIDs | 20130410 | |||
| 2 | IT_OBJECT_ROLES | Call by reference | Type reference (TYPE) | VBI_T_OBJECT_ROLES | Roles Table for Scene Objects | 20130410 |
Method REMOVE_SCENE_OBJECTS on Interface IF_VBI_SERVICE_PROVIDER has no exception.
Method RESET_OBJECT_SELECTION Signature
Method RESET_OBJECT_SELECTION on Interface IF_VBI_SERVICE_PROVIDER has no parameter.
Method RESET_OBJECT_SELECTION on Interface IF_VBI_SERVICE_PROVIDER has no exception.
Method SET_DISPLAY_PROFILE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_DISPLAY_PROFILE | Call by reference | Type reference (TYPE) | DISPLAY_PROFILE_TAB | Display Profile table | 20130410 |
Method SET_DISPLAY_PROFILE on Interface IF_VBI_SERVICE_PROVIDER has no exception.
Method UPDATE_SCENE_OBJECTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_AREAS | Call by reference | Type reference (TYPE) | AREAS_TAB | Table of areas to add/update | 20121004 | |||
| 2 | IT_LINKS | Call by reference | Type reference (TYPE) | LINKS_TAB | Table of links to add/update | 20121004 | |||
| 3 | IT_SPOTS | Call by reference | Type reference (TYPE) | SPOTS_TAB | Table of Spots to add/update | 20121004 |
Method UPDATE_SCENE_OBJECTS on Interface IF_VBI_SERVICE_PROVIDER has no exception.
Method UPDATE_SCENE_OBJECTS2 Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_AREAS | Call by reference | Type reference (TYPE) | CHANGED_AREAS_TAB | Table of areas to add/update | 20140428 | |||
| 2 | IT_LINKS | Call by reference | Type reference (TYPE) | CHANGED_LINKS_TAB | Table of links to add/update | 20140428 | |||
| 3 | IT_SPOTS | Call by reference | Type reference (TYPE) | CHANGED_SPOTS_TAB | Table of Spots to add/update | 20140428 |
Method UPDATE_SCENE_OBJECTS2 on Interface IF_VBI_SERVICE_PROVIDER has no exception.
History
| Last changed by/on | SAP | 20141121 |
| SAP Release Created in | 100 |