SAP ABAP Interface IF_VBI_CONTROL_ADAPTER (Output Adapter Interface)
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_CONTROL_ADAPTER | Generic Adapter class | 20130226 |
Properties
| Interface | IF_VBI_CONTROL_ADAPTER | |
| Short Description | Output Adapter Interface |
General Data
| Package | VBI_INTERFACES | Visual Business Interfaces |
| Created | 20130226 | SAP |
| Last changed | 20141120 | |
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | IF_VBI_CONST | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
| 2 | IF_VBI_CONTROL_ADAPTER | 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 IF_VBI_CONTROL_ADAPTER has no interface.
Friends
Interface IF_VBI_CONTROL_ADAPTER has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ANIMATION_DURATION | Instance attribute | Public | Type reference (TYPE) | VBI_ANIMATION_DURATION | Visual Business Animation Duration | 20140224 | ||
| 2 | ANIMATION_MODE | Instance attribute | Public | Type reference (TYPE) | VBI_ANIMATION_MODE | Visual Business Animation Mode | 20140224 | ||
| 3 | LAST_OPENED_DETAIL_WINDOW | Instance attribute | Public | Type reference (TYPE) | GTYPE_DETAIL_WINDOW_REF | 20130226 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Checks for changed data | 20140303 | |
| 2 | Instance method | Public | Method | Trigger Control for interactive object creation | 20140515 | |
| 3 | Instance method | Public | Method | Discards the Data XML for the pending Control update | 20130226 | |
| 4 | Instance method | Public | Method | Push Context Menu to frontend | 20130226 | |
| 5 | Instance method | Public | Method | Push Detail Data to frontend | 20130226 | |
| 6 | Instance method | Public | Method | Sends the Update to the Control | 20130226 | |
| 7 | Instance method | Public | Method | Sets the duration for FlyTo animations | 20140224 | |
| 8 | Instance method | Public | Method | Sets the animation mode for FlyTo animations | 20140224 | |
| 9 | Instance method | Public | Method | Set Context of last frontend event | 20130226 | |
| 10 | Instance method | Public | Method | Sets the scene position for the next display | 20130412 | |
| 11 | Instance method | Public | Method | Show legend | 20130226 | |
| 12 | Instance method | Public | Method | Update scene content | 20130226 | |
| 13 | Instance method | Public | Method | Updates/Changes the Scene Lights | 20140514 |
Events
| # | Event | Type | Visibility | Description | Created on |
|---|---|---|---|---|---|
| 1 | CONTROL_EVENT | Instance Event (0) |
Public (2) |
Event raised by frontend control | 20130408 |
| 2 | DATA_CHANGED | Instance Event (0) |
Public (2) |
Data changes submitted by frontend control | 20130408 |
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | GTYPE_DETAIL_WINDOW_REF | Public | See coding | 20130226 | BEGIN OF GTYPE_DETAIL_WINDOW_REF,
OBJECT_TYPE TYPE STRING,
OBJECT_INST TYPE STRING,
DETAIL_WINDOW_DESCR TYPE REF TO IF_VBI_OBJECT_DETAILS,
END OF GTYPE_DETAIL_WINDOW_REF
|
||
| 2 | GTYPE_LIGHTS | Public | See coding | 20140514 | GTYPE_LIGHTS type sorted table of GTYPE_LIGHT_ENTRY with unique key ID
|
||
| 3 | GTYPE_LIGHT_ENTRY | Public | See coding | 20140514 | begin of GTYPE_LIGHT_ENTRY,
ID type INT1,
POSITION type VBI_S_OBJ_GEOPOS,
AMBIENT type STRING,
DIFFUSE type STRING,
INTENSITY type FLOAT,
end of GTYPE_LIGHT_ENTRY
|
||
| 4 | GTYPE_NAME_VALUE_PAIR | Public | See coding | 20130226 | BEGIN OF GTYPE_NAME_VALUE_PAIR,
NAME TYPE STRING,
VALUE TYPE STRING,
END OF GTYPE_NAME_VALUE_PAIR
|
||
| 5 | GTYPE_NAME_VALUE_TAB | Public | See coding | 20130226 | GTYPE_NAME_VALUE_TAB TYPE STANDARD TABLE OF GTYPE_NAME_VALUE_PAIR WITH NON-UNIQUE DEFAULT KEY
|
||
| 6 | GTYPE_REQUEST_CONTEXT | Public | See coding | 20130226 | BEGIN OF GTYPE_REQUEST_CONTEXT,
OBJECT_TYPE TYPE VBI_OBJECT_TYPE,
OBJECT_INST TYPE STRING,
PARAMS TYPE GTYPE_NAME_VALUE_TAB,
PROPERTIES TYPE GTYPE_NAME_VALUE_TAB,
CTMENU_EXT TYPE REF TO CL_CTMENU,
END OF GTYPE_REQUEST_CONTEXT
|
Method Signatures
Method CHECK_DATA_CHANGED Signature
Method CHECK_DATA_CHANGED on Interface IF_VBI_CONTROL_ADAPTER has no parameter.
Method CHECK_DATA_CHANGED on Interface IF_VBI_CONTROL_ADAPTER has no exception.
Method CREATE_INTERACTIVE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_AREA | Call by reference | Type reference (TYPE) | IF_VBI_SERVICE_PROVIDER=>AREA_ENTRY | 20140515 | ||||
| 2 | IS_LINK | Call by reference | Type reference (TYPE) | IF_VBI_SERVICE_PROVIDER=>LINK_ENTRY | 20140515 | ||||
| 3 | IS_SPOT | Call by reference | Type reference (TYPE) | IF_VBI_SERVICE_PROVIDER=>SPOT_ENTRY | 20140515 |
Method CREATE_INTERACTIVE on Interface IF_VBI_CONTROL_ADAPTER has no exception.
Method DISCARD_PENDING_UPDATE Signature
Method DISCARD_PENDING_UPDATE on Interface IF_VBI_CONTROL_ADAPTER has no parameter.
Method DISCARD_PENDING_UPDATE on Interface IF_VBI_CONTROL_ADAPTER has no exception.
Method PUSH_CONTEXT_MENU Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_CTMENU | Call by reference | Object reference (TYPE REF TO) | CL_CTMENU | Context Menu | 20130226 |
Method PUSH_CONTEXT_MENU on Interface IF_VBI_CONTROL_ADAPTER has no exception.
Method PUSH_DETAILS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_POSITION | Call by reference | Type reference (TYPE) | VBI_S_OBJ_GEOPOS | Position of Window | 20140110 | |||
| 2 | IV_DETAILS | Call by reference | Object reference (TYPE REF TO) | IF_VBI_OBJECT_DETAILS | Objects Details Interface | 20130226 | |||
| 3 | IV_OBJECT_GUID | Call by reference | Type reference (TYPE) | VBI_OBJECT_GUID | Model Object GUID of the object the window should belong to | 20130709 |
Method PUSH_DETAILS on Interface IF_VBI_CONTROL_ADAPTER has no exception.
Method SEND_CONTROL_UPDATE Signature
Method SEND_CONTROL_UPDATE on Interface IF_VBI_CONTROL_ADAPTER has no parameter.
Method SEND_CONTROL_UPDATE on Interface IF_VBI_CONTROL_ADAPTER has no exception.
Method SET_ANIMATION_DURATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_DURATION | Call by reference | Type reference (TYPE) | VBI_ANIMATION_DURATION | 20140224 |
Method SET_ANIMATION_DURATION on Interface IF_VBI_CONTROL_ADAPTER has no exception.
Method SET_ANIMATION_MODE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_ANIMATION_MODE | Call by reference | Type reference (TYPE) | VBI_ANIMATION_MODE | Visual Business Animation Mode | 20140224 |
Method SET_ANIMATION_MODE on Interface IF_VBI_CONTROL_ADAPTER has no exception.
Method SET_EVENT_CONTEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_CONTEXT | Call by reference | Type reference (TYPE) | GTYPE_REQUEST_CONTEXT | 20130226 |
Method SET_EVENT_CONTEXT on Interface IF_VBI_CONTROL_ADAPTER has no exception.
Method SET_SCENE_POSITION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IS_CENTER_POSITION | Call by reference | Type reference (TYPE) | VBI_S_OBJ_GEOPOS | Center Position | 20130412 | |||
| 2 | IV_PITCH | Call by reference | Type reference (TYPE) | VBI_PITCH_ANGLE | Pitch angle | 20130619 | |||
| 3 | IV_ROTATION | Call by reference | Type reference (TYPE) | VBI_ROTATION_ANGLE | Rotation angle | 20130619 | |||
| 4 | IV_ZOOMLEVEL | Call by reference | Type reference (TYPE) | VBI_ZOOMLEVEL | Zoom Level | 20130412 |
Method SET_SCENE_POSITION on Interface IF_VBI_CONTROL_ADAPTER has no exception.
Method SHOW_LEGEND Signature
Method SHOW_LEGEND on Interface IF_VBI_CONTROL_ADAPTER has no parameter.
Method SHOW_LEGEND on Interface IF_VBI_CONTROL_ADAPTER has no exception.
Method UPDATE_SCENE Signature
Method UPDATE_SCENE on Interface IF_VBI_CONTROL_ADAPTER has no parameter.
Method UPDATE_SCENE on Interface IF_VBI_CONTROL_ADAPTER has no exception.
Method UPDATE_SCENE_LIGHTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_LIGHTS | Call by reference | Type reference (TYPE) | GTYPE_LIGHTS | 20140514 |
Method UPDATE_SCENE_LIGHTS on Interface IF_VBI_CONTROL_ADAPTER has no exception.
Event Signatures
Event CONTROL_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 | 20130408 | ||
| 2 | OBJECT_GUIDS | Exporting | Value transfer | Object reference (TYPE REF TO) | VBI_T_OBJECT_GUIDS | GUIDs of Objects the event is raised for | 20130408 | ||
| 3 | OBJECT_TYPE | Exporting | Value transfer | Type reference (TYPE) | VBI_OBJECT_TYPE | Frontend Object Type | 20130408 | ||
| 4 | POINTER_POS | Exporting | Value transfer | Type reference (TYPE) | VBI_S_OBJ_GEOPOS | Current WGS84 Geoposition of mouse pointer | 20130408 | ||
| 5 | PROPERTIES | Exporting | Value transfer | Object reference (TYPE REF TO) | IF_VBI_CONTROL_ADAPTER=>GTYPE_NAME_VALUE_TAB | Additional properties | 20130408 | ||
| 6 | SOURCE_OBJECT_GUIDS | Exporting | Value transfer | Object reference (TYPE REF TO) | VBI_T_OBJECT_GUIDS | GUIDs of Source Objects in Drag Drop operation | 20130408 |
Event DATA_CHANGED Signature
| # | Parameter | Type | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CHANGED_AREAS | Exporting | Value transfer | Object reference (TYPE REF TO) | IF_VBI_SERVICE_PROVIDER=>CHANGED_AREAS_TAB | 20130408 | |||
| 2 | CHANGED_LINKS | Exporting | Value transfer | Object reference (TYPE REF TO) | IF_VBI_SERVICE_PROVIDER=>CHANGED_LINKS_TAB | 20130408 | |||
| 3 | CHANGED_SPOTS | Exporting | Value transfer | Object reference (TYPE REF TO) | IF_VBI_SERVICE_PROVIDER=>CHANGED_SPOTS_TAB | 20130408 |
History
| Last changed by/on | SAP | 20141120 |
| SAP Release Created in | 100 |