SAP ABAP Class CL_VBI_SCENE_MANAGER (Generic Scene Manager)

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_SCENE_MANAGER	Scene Manager Read Interface	20130326

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_VBI_GEOMAP_SCENE_MANAGER	GeoMap Scene Manager	20130326

Properties

Class	CL_VBI_SCENE_MANAGER
Short Description	Generic Scene Manager
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	20130326	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_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_SCENE_MANAGER			Scene Manager Read Interface	20130326

Friends

#	Friend	Modeled only	Created on	Description
1	IF_VBI_CONTROL_ADAPTER		20130326	Output Adapter Interface

Attributes

#	Attribute	Level	Visibility	Typing	Associated Type	Initial Value	Description	Created on
1	CO_DELTA_STATE_DELETED	Constant	Public	Type reference (TYPE)	CHAR1	'D'	Single-Character Flag	20130326
2	CO_DELTA_STATE_MODIFIED	Constant	Public	Type reference (TYPE)	CHAR1	'M'	Single-Character Flag	20130326
3	CO_DELTA_STATE_NEW	Constant	Public	Type reference (TYPE)	CHAR1	'N'	Single-Character Flag	20130326
4	CO_OBJ_KIND_AREA	Constant	Protected	Type reference (TYPE)	CHAR1	'A'	Object Kind Area	20130327
5	CO_OBJ_KIND_LINK	Constant	Protected	Type reference (TYPE)	CHAR1	'L'	Object Kind Link	20130327
6	CO_OBJ_KIND_SPOT	Constant	Protected	Type reference (TYPE)	CHAR1	'S'	Object Kind Spot	20130326
7	DELTA_ENTRIES_INDEX	Instance attribute	Protected	See coding				20130326
8	OBJECTS	Instance attribute	Protected	Type reference (TYPE)	OBJECT_TAB			20130326
9	SCENE_CHANGED	Instance attribute	Protected	Attribute reference (LIKE)				20130326

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_OBJECTS_TO_SCENE	Instance method	Public	Method	Add Objects to the current Scene	20130327
2	CHECK_ROLES_MATCH_FILTER	Instance method	Protected	Method	Compare two role tables for any match	20130327
3	CLEAR_SCENE	Instance method	Public	Method	Remove Objects from Scene by GUID or ROLE	20130327
4	COMMIT_CHANGES	Instance method	Public	Method	Commit_changes (reset delta and changed flag)	20130327
5	GET_NEW_OBJECT_GUID	Static method	Public	Method	Creates a new object GUID	20130326
6	GET_SELECTED_OBJECTS	Instance method	Public	Method		20130910
7	GET_SUB_OBJECT_FOR_MULTI	Instance method	Public	Method	Returns all objects covered by a multi object	20130410
8	IS_OBJECT_GROUPABLE	Instance method	Protected	Method		20130419
9	MERGE_CHANGED_OBJECTS_TO_SCENE	Instance method	Public	Method	Merges Object changes to the current Scene	20140507
10	REMOVE_OBJECT_FROM_SCENE	Instance method	Public	Method	Remove Objects from Scene by GUID or ROLE	20130327
11	SET_OBJECT_CHANGEABILITY	Instance method	Public	Method	Set Object Changeability	20131218
12	SET_OBJECT_PARAMETERS	Instance method	Public	Method	Set Object parameters, e.g. FLYTO, HIGHLIGHTED, ...	20130402
13	UPDATE_BY_FIELDLIST	Instance method	Protected	Method		20140425

Events

Class CL_VBI_SCENE_MANAGER has no event.

Types

#	Type	Visibility	Typing	Created on	Type Source
1	ENTRY_EXTENSION	Protected	See coding	20130326	`begin of ENTRY_EXTENSION, OBJ_KIND type CHAR1, GROUPABLE type ABAP_BOOL, VISIBLE type ABAP_BOOL, DELTA_STATE type CHAR1, MULTI_GUID type VBI_OBJECT_GUID, SUB_OBJECTS type hashed table of VBI_OBJECT_GUID with unique key TABLE_LINE, AT_CLIENT type ABAP_BOOL, end of ENTRY_EXTENSION`
2	OBJECT_ENTRY	Protected	See coding	20130326	`begin of OBJECT_ENTRY. include type IF_VBI_SERVICE_PROVIDER=>OBJECT_BASE as BASE. include type ENTRY_EXTENSION as INTERNAL. include type IF_VBI_SERVICE_PROVIDER=>SPOT_EXTENSION as SPOT_EXT. include type IF_VBI_SERVICE_PROVIDER=>LINK_EXTENSION as LINK_EXT. include type IF_VBI_SERVICE_PROVIDER=>AREA_EXTENSION as AREA_EXT. types: end of OBJECT_ENTRY`
3	OBJECT_TAB	Protected	See coding	20130326	`OBJECT_TAB type hashed table of OBJECT_ENTRY with unique key GUID`

Method Signatures

Method ADD_OBJECTS_TO_SCENE Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	IT_AREAS	Call by reference	Type reference (TYPE)	IF_VBI_SERVICE_PROVIDER=>AREAS_TAB	Table of Areas to add/update	20130327
2	Importing	IT_LINKS	Call by reference	Type reference (TYPE)	IF_VBI_SERVICE_PROVIDER=>LINKS_TAB	Table of Links to add/update	20130327
3	Importing	IT_SPOTS	Call by reference	Type reference (TYPE)	IF_VBI_SERVICE_PROVIDER=>SPOTS_TAB	Table of Spots to add/update	20130327

Method ADD_OBJECTS_TO_SCENE on class CL_VBI_SCENE_MANAGER has no exception.

Method CHECK_ROLES_MATCH_FILTER Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	IT_ROLES	Call by reference	Type reference (TYPE)	VBI_T_OBJECT_ROLES	Roles Table for Scene Objects	20130327
2	Importing	IT_ROLES_FILTER	Call by reference	Type reference (TYPE)	VBI_T_OBJECT_ROLES	Roles Table for Scene Objects	20130327
3	Returning	RV_MATCH_FOUND	Value transfer	Type reference (TYPE)	ABAP_BOOL		20130327

Method CHECK_ROLES_MATCH_FILTER on class CL_VBI_SCENE_MANAGER has no exception.

Method CLEAR_SCENE Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_OBJECT_ROLES_2_KEEP	Call by reference	Type reference (TYPE)	VBI_T_OBJECT_ROLES		Table of Object Roles to keep	20130327
2	Importing	IV_CLEAR_FIXED	Call by reference	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Clear also fixed objects	20130327
3	Importing	IV_FORCE_UPDATE	Call by reference	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20140526

Method CLEAR_SCENE on class CL_VBI_SCENE_MANAGER has no exception.

Method COMMIT_CHANGES Signature

Method COMMIT_CHANGES on class CL_VBI_SCENE_MANAGER has no parameter.
Method COMMIT_CHANGES on class CL_VBI_SCENE_MANAGER has no exception.

Method GET_NEW_OBJECT_GUID 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_OBJECT_GUID		Model Object GUID	20130326

Method GET_NEW_OBJECT_GUID on class CL_VBI_SCENE_MANAGER has no exception.

Method GET_SELECTED_OBJECTS Signature

Method GET_SELECTED_OBJECTS on class CL_VBI_SCENE_MANAGER has no parameter.
Method GET_SELECTED_OBJECTS on class CL_VBI_SCENE_MANAGER has no exception.

Method GET_SUB_OBJECT_FOR_MULTI Signature

Method GET_SUB_OBJECT_FOR_MULTI on class CL_VBI_SCENE_MANAGER has no parameter.
Method GET_SUB_OBJECT_FOR_MULTI on class CL_VBI_SCENE_MANAGER has no exception.

Method IS_OBJECT_GROUPABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_OBJECT_BASE_DATA	Call by reference		Type reference (TYPE)	IF_VBI_SERVICE_PROVIDER=>OBJECT_BASE			20130419
2	Returning	RV_RESULT	Value transfer		Type reference (TYPE)	ABAP_BOOL			20130419

Method IS_OBJECT_GROUPABLE on class CL_VBI_SCENE_MANAGER has no exception.

Method MERGE_CHANGED_OBJECTS_TO_SCENE Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Importing	IT_AREAS	Call by reference	Type reference (TYPE)	IF_VBI_SERVICE_PROVIDER=>CHANGED_AREAS_TAB	Table of changed Areas to add/update	20140507
2	Importing	IT_LINKS	Call by reference	Type reference (TYPE)	IF_VBI_SERVICE_PROVIDER=>CHANGED_LINKS_TAB	Table of changed Links to add/update	20140507
3	Importing	IT_SPOTS	Call by reference	Type reference (TYPE)	IF_VBI_SERVICE_PROVIDER=>CHANGED_SPOTS_TAB	Table of changed Spots to add/update	20140507

Method MERGE_CHANGED_OBJECTS_TO_SCENE on class CL_VBI_SCENE_MANAGER has no exception.

Method REMOVE_OBJECT_FROM_SCENE Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	ET_REMOVED_OBJECTS	Call by reference	Type reference (TYPE)	VBI_T_OBJECT_GUIDS	Table of Model Object GUIDs	20130327
2	Importing	IT_OBJECT_GUIDS	Call by reference	Type reference (TYPE)	VBI_T_OBJECT_GUIDS	Table of Model Object GUIDs	20130327
3	Importing	IT_OBJECT_ROLES	Call by reference	Type reference (TYPE)	VBI_T_OBJECT_ROLES	Roles Table for Scene Objects	20130327

Method REMOVE_OBJECT_FROM_SCENE on class CL_VBI_SCENE_MANAGER has no exception.

Method SET_OBJECT_CHANGEABILITY Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_OBJECT_GUIDS	Call by reference	Type reference (TYPE)	VBI_T_OBJECT_GUIDS		Table of Model Object GUIDs	20131218
2	Importing	IT_OBJECT_ROLES	Call by reference	Type reference (TYPE)	VBI_T_OBJECT_ROLES		Roles Table for Scene Objects	20131218
3	Importing	IV_CHANGEABLE	Call by reference	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Object changeable	20131218
4	Importing	IV_EXCLUSIVE	Call by reference	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	If TRUE, all not matching object get the opposite property	20131218

Method SET_OBJECT_CHANGEABILITY on class CL_VBI_SCENE_MANAGER has no exception.

Method SET_OBJECT_PARAMETERS Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_OBJECT_GUIDS	Call by reference	Type reference (TYPE)	VBI_T_OBJECT_GUIDS		Table of Model Object GUIDs	20130402
2	Importing	IT_OBJECT_ROLES	Call by reference	Type reference (TYPE)	VBI_T_OBJECT_ROLES		Roles Table for Scene Objects	20130402
3	Importing	IV_EXCLUSIVE	Call by reference	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	If TRUE, all not matching object get the opposite property	20130410
4	Importing	IV_FIXED	Call by reference	Type reference (TYPE)	ABAP_BOOL	ABAP_UNDEFINED	Object fixed?	20130410
5	Importing	IV_FLYTO	Call by reference	Type reference (TYPE)	ABAP_BOOL	ABAP_UNDEFINED	Object flyto?	20130402
6	Importing	IV_HIGHLIGHTED	Call by reference	Type reference (TYPE)	ABAP_BOOL	ABAP_UNDEFINED	Object highlighted?	20130402
7	Importing	IV_SELECTED	Call by reference	Type reference (TYPE)	ABAP_BOOL	ABAP_UNDEFINED	Object selected?	20130402
8	Importing	IV_SHOW_LABEL	Call by reference	Type reference (TYPE)	ABAP_BOOL	ABAP_UNDEFINED	Object label visible?	20140723
9	Importing	IV_VISIBLE	Call by reference	Type reference (TYPE)	ABAP_BOOL	ABAP_UNDEFINED	Object visible?	20130402

Method SET_OBJECT_PARAMETERS on class CL_VBI_SCENE_MANAGER has no exception.

Method UPDATE_BY_FIELDLIST Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Created on
1	Importing	IS_SOURCE	Call by reference	Type reference (TYPE)	ANY	20140425
2	Importing	IT_FIELDS	Call by reference	Type reference (TYPE)	IF_VBI_SERVICE_PROVIDER=>FIELD_NAME_TAB	20140425
3	Importing	IV_TARGET_REF	Call by reference	Object reference (TYPE REF TO)	OBJECT_ENTRY	20140428

Method UPDATE_BY_FIELDLIST on class CL_VBI_SCENE_MANAGER has no exception.

History

Last changed by/on	SAP	20141120
SAP Release Created in	100

Object Hierarchy

Using

Used by

Advertise Links