SAP ABAP Class CL_BS_FPM_TOOLBOX (Toolbox for FPM enabled applications)

Hierarchy

☛ SAP_BS_FND (Software Component) SAP Business Suite Foundation
   ⤷ CA-MDG-APP-BP (Application Component) MDG Business Partner (Central Part)
     ⤷ BS_COMMON_OBJECTS (Package) Common Tools and Interfaces

Properties

Class	CL_BS_FPM_TOOLBOX
Short Description	Toolbox for FPM enabled applications
Super Class
Instantiability of a Class	1	Protected
Final	☐

General Data

Message Class
Program status
Category	0
Package	BS_COMMON_OBJECTS	Common Tools and Interfaces
Created	20100902	SAP
Last change	20130531	SAP
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_FPM_OVP	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_BS_FPM_TOOLBOX has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_BS_FPM_TOOLBOX_FACTORY	☐	20100902	Toolbox-factory for FPM related tools

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_EVENT	Constant	Public	☐	See coding				20110107
2	GC_EVENT_PARAM	Constant	Public	☐	See coding				20110107
3	MO_FPM	Instance attribute	Public	☑	Object reference (TYPE REF TO)	IF_FPM		Interface for accessing FPM functionality	20100902
4	MT_UIBB_TRAYS	Instance attribute	Protected	☐	Type reference (TYPE)	TY_UIBB_TRAYS		List of UIBBs related to an OVP tray (AB)	20110317

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_SUB_UIBB	Instance method	Protected	Method	adds the given UIBB if not a "collection" UIBB	20110317
2	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20100902
3	CROSS_APPLICATION_NAVIGATION	Instance method	Public	Method	triggers a cross application navigation	20100909
4	GET_CURRENT_CONTENT_AREA_ID	Instance method	Public	Method	returns the ID of the current content area	20100903
5	GET_ELEMENT_ID_OF_UIBB	Instance method	Public	Method	determines the element id of the given UIBB	20100902
6	GET_EVENT_CONTEXT_DATA	Instance method	Public	Method	reads data from context element if attached to event	20100902
7	GET_EVENT_DATA	Instance method	Public	Method	reads the given event's data from several sources	20100902
8	GET_SUB_UIBBS	Instance method	Protected	Method	gets all sub-UIBBs of a given UIBB	20110317
9	GET_TARGET_CONTENT_AREA_ID	Instance method	Public	Method	returns the ID of the target content area	20100903
10	GET_TARGET_CONTENT_AREA_STATE	Instance method	Public	Method	returns the state of the target content area	20101216
11	GET_UIBB_OF_CONTENT_AREA	Instance method	Public	Method	returns the parameters of a UIBB for a given content area	20100903
12	SET_TITLE	Instance method	Public	Method	sets the title of the current content area	20110321
13	TRAY_OF_UIBB	Instance method	Public	Method	determines the tray in which the given UIBB is configured	20110317
14	UNFOLD_UIBB_HIERARCHY_OF_TRAYS	Instance method	Public	Method	determines all sub UIBBs of composite/tabbed UIBB trays	20110317

Events

Class CL_BS_FPM_TOOLBOX has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_UIBB	Public	See coding			20110317	BEGIN OF ty_uibb. INCLUDE TYPE fpm_s_uibb_instance_key AS instance_key. TYPES: interface_view TYPE fpm_window_name, END OF ty_uibb
2	TY_UIBBS	Public	See coding			20110317	ty_uibbs TYPE STANDARD TABLE OF ty_uibb
3	TY_UIBB_TRAY	Public	See coding			20110317	BEGIN OF ty_uibb_tray, content_area_id TYPE fpm_content_area_id, uibb TYPE ty_uibb, tray TYPE ty_uibb, END OF ty_uibb_tray
4	TY_UIBB_TRAYS	Public	See coding			20110317	ty_uibb_trays TYPE STANDARD TABLE OF ty_uibb_tray

Method Signatures

Method ADD_SUB_UIBB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_SUB_UIBBS	Call by reference	☐	Type reference (TYPE)	TY_UIBBS			20110317
2	Importing	IS_UIBB	Call by reference	☐	Type reference (TYPE)	TY_UIBB			20110317

Method ADD_SUB_UIBB on class CL_BS_FPM_TOOLBOX has no exception.

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_BS_FPM_TOOLBOX has no parameter.
Method CONSTRUCTOR on class CL_BS_FPM_TOOLBOX has no exception.

Method CROSS_APPLICATION_NAVIGATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	FPMGB_T_MESSAGES		FPMGB Messages (T100 & Plaintext)	20100909
2	Importing	IT_PARAMETERS	Call by reference	☑	Type reference (TYPE)	TIHTTPNVP		HTTP Framework (iHTTP) Table Name/Value Pairs	20100909
3	Importing	IV_APPLICATION_NAME	Call by reference	☐	Type reference (TYPE)	STRING		WD application's name	20100909
4	Importing	IV_IN_SAME_WINDOW	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	' '	indicator: 'X' = navigate within same browser window	20100909

Method CROSS_APPLICATION_NAVIGATION on class CL_BS_FPM_TOOLBOX has no exception.

Method GET_CURRENT_CONTENT_AREA_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_CONTENT_AREA_ID	Value transfer	☐	Type reference (TYPE)	FPM_CONTENT_AREA_ID		FPM: Content Area ID	20100903

Method GET_CURRENT_CONTENT_AREA_ID on class CL_BS_FPM_TOOLBOX has no exception.

Method GET_ELEMENT_ID_OF_UIBB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_INSTANCE_KEY	Call by reference	☐	Type reference (TYPE)	FPM_S_UIBB_INSTANCE_KEY		UIBB Instance Key	20100902
2	Returning	RV_ELEMENT_ID	Value transfer	☐	Type reference (TYPE)	FPM_ELEMENT_ID		FPM: Element ID	20100902

Method GET_ELEMENT_ID_OF_UIBB on class CL_BS_FPM_TOOLBOX has no exception.

Method GET_EVENT_CONTEXT_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_VALUE	Call by reference	☐	Type reference (TYPE)	DATA			20100902
2	Importing	IO_EVENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_FPM_EVENT		CL_FPM_EVENT	20100902
3	Importing	IV_NAME	Call by reference	☑	Type reference (TYPE)	STRING		name of the parameter that contains the data	20100902

Method GET_EVENT_CONTEXT_DATA on class CL_BS_FPM_TOOLBOX has no exception.

Method GET_EVENT_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_VALUE	Call by reference	☐	Type reference (TYPE)	DATA			20100902
2	Importing	IO_EVENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_FPM_EVENT		CL_FPM_EVENT	20100902
3	Importing	IV_NAME	Call by reference	☑	Type reference (TYPE)	STRING		name of the parameter that contains the data	20100902

Method GET_EVENT_DATA on class CL_BS_FPM_TOOLBOX has no exception.

Method GET_SUB_UIBBS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_SUB_UIBBS	Call by reference	☐	Type reference (TYPE)	TY_UIBBS			20110317
2	Importing	IS_UIBB	Call by reference	☐	Type reference (TYPE)	TY_UIBB			20110317

Method GET_SUB_UIBBS on class CL_BS_FPM_TOOLBOX has no exception.

Method GET_TARGET_CONTENT_AREA_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_CONTENT_AREA_ID	Value transfer	☐	Type reference (TYPE)	FPM_CONTENT_AREA_ID		FPM: Content Area ID	20100903

Method GET_TARGET_CONTENT_AREA_ID on class CL_BS_FPM_TOOLBOX has no exception.

Method GET_TARGET_CONTENT_AREA_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_CONTENT_AREA_STATE	Value transfer	☐	Type reference (TYPE)	FPM_FLOORPLAN_STATE			20101216

Method GET_TARGET_CONTENT_AREA_STATE on class CL_BS_FPM_TOOLBOX has no exception.

Method GET_UIBB_OF_CONTENT_AREA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_INSTANCE_KEY	Call by reference	☐	Type reference (TYPE)	FPM_S_UIBB_INSTANCE_KEY		UIBB Instance Key	20100903
2	Importing	IV_CONTENT_AREA_ID	Call by reference	☐	Type reference (TYPE)	FPM_CONTENT_AREA_ID		FPM: Content Area ID	20100903
3	Returning	RS_UIBB	Value transfer	☐	Type reference (TYPE)	IF_FPM_OVP=>TY_S_UIBB		data of the found uibb	20100903

Method GET_UIBB_OF_CONTENT_AREA on class CL_BS_FPM_TOOLBOX has no exception.

Method SET_TITLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FOR_TARGET_PAGE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Indicator: 'X' =sets title for target content area	20110524
2	Importing	IV_TITLE	Call by reference	☐	Type reference (TYPE)	FPM_CONTENT_AREA_TITLE		Content Area Title	20110321

Method SET_TITLE on class CL_BS_FPM_TOOLBOX has no exception.

Method TRAY_OF_UIBB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FOR_TARGET_PAGE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Indicator: 'X' = uses target page as a base	20110524
2	Importing	IV_UIBB_CONFIG_ID	Call by reference	☐	Type reference (TYPE)	WDY_CONFIG_ID		Configuration Identification	20110317
3	Returning	RS_TRAY	Value transfer	☐	Type reference (TYPE)	TY_UIBB			20110317

Method TRAY_OF_UIBB on class CL_BS_FPM_TOOLBOX has no exception.

Method UNFOLD_UIBB_HIERARCHY_OF_TRAYS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_OVP	Call by reference	☑	Object reference (TYPE REF TO)	IF_FPM_OVP		Interface for Communication FPM App CC	20110317

Method UNFOLD_UIBB_HIERARCHY_OF_TRAYS on class CL_BS_FPM_TOOLBOX has no exception.

History

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