SAP ABAP Class CL_FPM_HCT_UIBB_COLLCTN_ASSIST (Assistance class for all components that collect any UIBBs)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ BC-WD-CMP-FPM (Application Component) Floorplan Manager Web Dynpro ABAP
     ⤷ APB_FPM_HCT (Package) Harmonized Configuration Tool

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_FPM_HCT_UI_ASSIST	Assistance class for FPM configuration editor	20101103

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_FPM_HCT_COMPOSITE_ASSIST	Assistance class for composite uibb	20101105
2	Inheritance (c INHERITING FROM c_ref)	CL_FPM_HCT_CONTENT_AREA_ASSIST	Assistance class for Overview Page Floorplan	20101103
3	Inheritance (c INHERITING FROM c_ref)	CL_FPM_HCT_TABBED_UIBB_ASSIST	Assistance Class for FPM_HCT_TABBED_UIBB	20101104
4	Inheritance (c INHERITING FROM c_ref)	CL_FPM_HCT_UIBB_ASSIST	Assistance class for FPM_HCT_UIBB	20101103

Properties

Class	CL_FPM_HCT_UIBB_COLLCTN_ASSIST
Short Description	Assistance class for all components that collect any UIBBs
Super Class	CL_FPM_HCT_UI_ASSIST	Assistance class for FPM configuration editor
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	APB_FPM_HCT	Harmonized Configuration Tool
Created	20101103	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)

Interfaces

Class CL_FPM_HCT_UIBB_COLLCTN_ASSIST has no interface implemented.

Friends

Class CL_FPM_HCT_UIBB_COLLCTN_ASSIST has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CV_PREVIEW_INTERFACE	Constant	Private	☐	Type reference (TYPE)	STRING	'IF_FPM_CFG_UIBB_PREVIEW'		20101105
2	MO_REP_UIBB	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_FPM_HCT_REPOSITORY		Repository	20101130
3	MO_UIBB_USAGES	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_WD_COMPONENT_USAGE_GROUP		Web Dynpro: Group of Component Usages	20101105
4	MS_UIBB_CONF_COMP_USAGE	Instance attribute	Private	☐	See coding				20110309
5	MT_DISPLAYED_UIBB	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_NAVIGATION_STEP			20101105
6	MT_UIBB_PER_PREFIX	Instance attribute	Private	☐	Type reference (TYPE)	FPM_T_CFG_UIBB_PER_PREFIX		Contains count of uibbs per prefix	20101105
7	MT_UIBB_PREVIEW	Instance attribute	Public	☐	Type reference (TYPE)	FPM_T_CFG_UIBB_PREVIEW		Table for UIBB and corresponding preview uibb	20101105
8	MV_PREVIEW_POSSIBLE	Instance attribute	Private	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20101105

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_UIBB_TO_PREVIEW_TABLE	Instance method	Public	Method	Add UIBB to global previewtable	20101105
2	CONFIG_ID_EXISTS	Instance method	Private	Method		20110418
3	DELETE_UIBB_CONF_COMP_USAGE	Instance method	Public	Method	Delete configurable component usages for freestyle UIBB	20101105
4	DELETE_UIBB_FROM_PREVIEW	Instance method	Protected	Method		20101105
5	DELETE_UIBB_FROM_PREVIEW_TABLE	Instance method	Public	Method	Delete UIBB from global previewtable	20101105
6	GET_ALV_CONFIG_KEY	Instance method	Protected	Method	Get ALV config key from usage path	20101105
7	GET_CONF_COMP_USAGE_NODE	Instance method	Private	Method		20101105
8	GET_DROP_TRGT_FROM_LAYOUT_TYPE	Instance method	Protected	Method	Get drop targets for uibb container from layout type	20101206
9	GET_REP_UIBB_INSTANCE	Instance method	Public	Method		20101130
10	GET_UIBB_CONF_COMP_USAGE	Instance method	Public	Method	Get configurable components for freestyle UIBB	20101105
11	GET_UIBB_IMAGE	Instance method	Protected	Method	Get image for UIBB	20110518
12	GET_UIBB_TEXT	Instance method	Protected	Method	Get text for UIBB	20110518
13	INIT_UIBB_CONF_COMP_USAGE	Instance method	Public	Method	Init configurable component usages for freestyle UIBB	20110309
14	IS_GUIBB	Instance method	Protected	Method	Is the component a GUIBB	20101104
15	IS_SIMILAR_NODE_NAME	Instance method	Protected	Method	Node names are similar regarding their semantic	20101126
16	NAVIGATE	Instance method	Public	Method		20101105
17	ON_OVS_UIBB_CONF_COMP_USAGE	Instance method	Protected	Method		20101105
18	PREVIEW_POSSIBLE	Instance method	Public	Method	Is preview possible for entered UIBBs?	20101105
19	PREVIEW_POSSIBLE_FOR_UIBB	Instance method	Public	Method		20101105
20	RENDER_UIBB_CONF_COMP_USAGE	Instance method	Public	Method	Render configurable component usages for freestyle UIBB	20101105
21	SET_UIBB_CONF_COMP_USAGE	Instance method	Public	Method	Set configurable component usages for freestyle UIBB	20101105
22	SET_USAGES	Instance method	Public	Method		20101105

Events

Class CL_FPM_HCT_UIBB_COLLCTN_ASSIST has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_S_NAVIGATION_STEP	Public	See coding			20101105	begin of ty_s_navigation_step, source_plug_name type string, target_component_name type string, target_component_usage type string, target_view_name type string, target_embedding_position type string, end of ty_s_navigation_step
2	TY_T_NAVIGATION_STEP	Public	See coding			20101105	ty_t_navigation_step type standard table of ty_s_navigation_step

Method Signatures

Method ADD_UIBB_TO_PREVIEW_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_UIBB_TO_ADD	Call by reference	☐	Type reference (TYPE)	FPM_S_UIBB_KEY		Key of a UIBB to be embedded in an FPM based application	20101105
2	Returning	RV_CHANGE_PREVIEW	Value transfer	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20101105

Method ADD_UIBB_TO_PREVIEW_TABLE on class CL_FPM_HCT_UIBB_COLLCTN_ASSIST has no exception.

Method CONFIG_ID_EXISTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_CONFIG_ID	Call by reference	☐	Type reference (TYPE)	WDY_CONFIG_ID		Web Dynpro: Component Name	20110418
2	Returning	RV_EXISTS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20110418

Method CONFIG_ID_EXISTS on class CL_FPM_HCT_UIBB_COLLCTN_ASSIST has no exception.

Method DELETE_UIBB_CONF_COMP_USAGE Signature

Method DELETE_UIBB_CONF_COMP_USAGE on class CL_FPM_HCT_UIBB_COLLCTN_ASSIST has no parameter.
Method DELETE_UIBB_CONF_COMP_USAGE on class CL_FPM_HCT_UIBB_COLLCTN_ASSIST has no exception.

Method DELETE_UIBB_FROM_PREVIEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_UIBB_KEY	Call by reference	☐	Type reference (TYPE)	FPM_S_UIBB_KEY		Key of a UIBB to be embedded in an FPM based application	20101105

Method DELETE_UIBB_FROM_PREVIEW on class CL_FPM_HCT_UIBB_COLLCTN_ASSIST has no exception.

Method DELETE_UIBB_FROM_PREVIEW_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_UIBB_TO_DELETE	Call by reference	☐	Type reference (TYPE)	FPM_S_UIBB_KEY		Key of a UIBB to be embedded in an FPM based application	20101105

Method DELETE_UIBB_FROM_PREVIEW_TABLE on class CL_FPM_HCT_UIBB_COLLCTN_ASSIST has no exception.

Method GET_ALV_CONFIG_KEY 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	20101105
2	Returning	RS_CONFIG_KEY	Value transfer	☐	Type reference (TYPE)	WDY_CONFIG_KEY		Key Components of Configuration Tables	20101105

Method GET_ALV_CONFIG_KEY on class CL_FPM_HCT_UIBB_COLLCTN_ASSIST has no exception.

Method GET_CONF_COMP_USAGE_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_ND_CONF_COMP_USAGE	Value transfer	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE		Web Dynpro: Interface for Context Nodes	20101105

Method GET_CONF_COMP_USAGE_NODE on class CL_FPM_HCT_UIBB_COLLCTN_ASSIST has no exception.

Method GET_DROP_TRGT_FROM_LAYOUT_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_HAS_DROP_TRGT_BEGIN	Call by reference	☐	Type reference (TYPE)	WDY_BOOLEAN		Supplement for True Boolean Type: 'X' == True '' == False	20101206
2	Exporting	EV_HAS_DROP_TRGT_BOTTOM	Call by reference	☐	Type reference (TYPE)	WDY_BOOLEAN		Supplement for True Boolean Type: 'X' == True '' == False	20101206
3	Exporting	EV_HAS_DROP_TRGT_END	Call by reference	☐	Type reference (TYPE)	WDY_BOOLEAN		Supplement for True Boolean Type: 'X' == True '' == False	20101206
4	Exporting	EV_HAS_DROP_TRGT_MIDDLE	Call by reference	☐	Type reference (TYPE)	WDY_BOOLEAN		Supplement for True Boolean Type: 'X' == True '' == False	20101206
5	Exporting	EV_HAS_DROP_TRGT_TOP	Call by reference	☐	Type reference (TYPE)	WDY_BOOLEAN		Supplement for True Boolean Type: 'X' == True '' == False	20101206
6	Importing	IO_EL_UIBB	Call by reference	☑	Object reference (TYPE REF TO)	IF_WD_CONTEXT_ELEMENT		Web Dynpro: Interface for Node Element	20111020
7	Importing	IV_LAYOUT_TYPE	Call by reference	☐	Type reference (TYPE)	FPM_LAYOUT_TYPE		Layout Type	20101206
8	Importing	IV_LOCATION	Call by reference	☐	Type reference (TYPE)	FPM_LOCATION		UIBB Location Index (Column)	20101206

Method GET_DROP_TRGT_FROM_LAYOUT_TYPE on class CL_FPM_HCT_UIBB_COLLCTN_ASSIST has no exception.

Method GET_REP_UIBB_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_REPOSITORY_TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20101130
2	Returning	RO_REP_UIBB	Value transfer	☐	Object reference (TYPE REF TO)	IF_FPM_HCT_REPOSITORY		Repository	20101130

Method GET_REP_UIBB_INSTANCE on class CL_FPM_HCT_UIBB_COLLCTN_ASSIST has no exception.

Method GET_UIBB_CONF_COMP_USAGE Signature

Method GET_UIBB_CONF_COMP_USAGE on class CL_FPM_HCT_UIBB_COLLCTN_ASSIST has no parameter.
Method GET_UIBB_CONF_COMP_USAGE on class CL_FPM_HCT_UIBB_COLLCTN_ASSIST has no exception.

Method GET_UIBB_IMAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COMP_NAME	Call by reference	☐	Type reference (TYPE)	FPM_COMPONENT_NAME		Web Dynpro: Component Name	20110518
2	Returning	RV_IMAGE	Value transfer	☐	Type reference (TYPE)	STRING			20110518

Method GET_UIBB_IMAGE on class CL_FPM_HCT_UIBB_COLLCTN_ASSIST has no exception.

Method GET_UIBB_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COMP_NAME	Call by reference	☐	Type reference (TYPE)	FPM_COMPONENT_NAME		Web Dynpro: Component Name	20110518
2	Returning	RV_TEXT	Value transfer	☐	Type reference (TYPE)	STRING			20110518

Method GET_UIBB_TEXT on class CL_FPM_HCT_UIBB_COLLCTN_ASSIST has no exception.

Method INIT_UIBB_CONF_COMP_USAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CONTEXT_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE		Web Dynpro: Interface for Context Nodes	20110309

Method INIT_UIBB_CONF_COMP_USAGE on class CL_FPM_HCT_UIBB_COLLCTN_ASSIST has no exception.

Method IS_GUIBB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COMP_NAME	Call by reference	☐	Type reference (TYPE)	FPM_COMPONENT_NAME		Web Dynpro: Component Name	20101104
2	Returning	RV_IS_GUIBB	Value transfer	☐	Type reference (TYPE)	WDY_BOOLEAN		Supplement for True Boolean Type: 'X' == True '' == False	20101104

Method IS_GUIBB on class CL_FPM_HCT_UIBB_COLLCTN_ASSIST has no exception.

Method IS_SIMILAR_NODE_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_NODE_1	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE		Web Dynpro: Interface for Context Nodes	20101126
2	Importing	IO_NODE_2	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE		Web Dynpro: Interface for Context Nodes	20101126
3	Returning	RV_IS_SIMILAR	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20101126

Method IS_SIMILAR_NODE_NAME on class CL_FPM_HCT_UIBB_COLLCTN_ASSIST has no exception.

Method NAVIGATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_UIBBS	Call by reference	☐	Type reference (TYPE)	FPM_T_UIBB_KEY		Table type of UIBB keys	20101105
2	Importing	IO_VIEW_CONTROLLER_API	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_VIEW_CONTROLLER		Web Dynpro: View Controller	20101105
3	Importing	IV_PREFIX	Call by reference	☐	Type reference (TYPE)	STRING			20101105
4	Importing	IV_PREVIEWVIEW	Call by reference	☐	Type reference (TYPE)	STRING			20101105
5	Importing	IV_SOURCE_USAGE_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20101105
6	Importing	IV_SOURCE_WINDOW_NAME	Call by reference	☐	Type reference (TYPE)	STRING	'MAIN'		20101105
7	Importing	IV_TARGET_PLUG_NAME	Call by reference	☐	Type reference (TYPE)	STRING	'DEFAULT'		20101105

Method NAVIGATE on class CL_FPM_HCT_UIBB_COLLCTN_ASSIST has no exception.

Method ON_OVS_UIBB_CONF_COMP_USAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_OVS	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_OVS			20101105

Method ON_OVS_UIBB_CONF_COMP_USAGE on class CL_FPM_HCT_UIBB_COLLCTN_ASSIST has no exception.

Method PREVIEW_POSSIBLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_UIBBS	Call by reference	☑	Type reference (TYPE)	FPM_T_UIBB_KEY		Table type of UIBB keys	20101105
2	Returning	RV_PREVIEW_POSSIBLE	Value transfer	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20101105

Method PREVIEW_POSSIBLE on class CL_FPM_HCT_UIBB_COLLCTN_ASSIST has no exception.

Method PREVIEW_POSSIBLE_FOR_UIBB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_PREVIEW_POSSIBLE	Value transfer	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20101105
2	Exporting	EV_VCUIE_ID	Call by reference	☐	Type reference (TYPE)	STRING			20101105
3	Importing	IS_UIBB_TO_CHECK	Call by reference	☐	Type reference (TYPE)	FPM_S_UIBB_KEY		Key of a UIBB to be embedded in an FPM based application	20101105

Method PREVIEW_POSSIBLE_FOR_UIBB on class CL_FPM_HCT_UIBB_COLLCTN_ASSIST has no exception.

Method RENDER_UIBB_CONF_COMP_USAGE Signature

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

Method RENDER_UIBB_CONF_COMP_USAGE on class CL_FPM_HCT_UIBB_COLLCTN_ASSIST has no exception.

Method SET_UIBB_CONF_COMP_USAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_RESET_LOG	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20101105

Method SET_UIBB_CONF_COMP_USAGE on class CL_FPM_HCT_UIBB_COLLCTN_ASSIST has no exception.

Method SET_USAGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_EMPTY_USAGES	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_COMPONENT_USAGE_GROUP		Web Dynpro: Group of Component Usages	20101105
2	Importing	IO_UIBB_USAGES	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_COMPONENT_USAGE_GROUP		Web Dynpro: Group of Component Usages	20101105

Method SET_USAGES on class CL_FPM_HCT_UIBB_COLLCTN_ASSIST has no exception.

History

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