SAP ABAP Interface IF_FPM_IDR (IF_FPM_IDR)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ BC-WD-CMP-FPM (Application Component) Floorplan Manager Web Dynpro ABAP
     ⤷ APB_FPM_CORE (Package) Floorplan Manager (Framework)

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_FPM_IDR	Implementation for API of IDR	20070425
2	Interface implementation (CLASS c. INTERFACES i_ref)	CL_FPM_TEST_DOUBLE	Test double for IF_FPM	20111004

Properties

Interface	IF_FPM_IDR
Short Description

General Data

Package	APB_FPM_CORE	Floorplan Manager (Framework)
Created	20070424	SAP
Last changed	20131127	SAP
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_FPM_IDR has no interface.

Friends

Interface IF_FPM_IDR has no friend.

Attributes

Interface IF_FPM_IDR has no attribute.

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_IMAGE_ITEM	Instance method	Public	Method		20071220
2	ADD_ITEM_GROUP_BY_REF	Instance method	Public	Method		20070511
3	ADD_ITEM_GROUP_BY_VAL	Instance method	Public	Method		20070511
4	ADD_NAVIGATION_ITEM	Instance method	Public	Method		20071218
5	CHANGE_IMAGE_ITEM	Instance method	Public	Method		20071220
6	CHANGE_ITEM_GROUP_BY_VAL	Instance method	Public	Method		20070515
7	CHANGE_NAVIGATION_ITEM	Instance method	Public	Method		20071219
8	CONTAINS_ITEM_GROUP	Instance method	Public	Method		20070511
9	GET_APPLICATION_TITLE	Instance method	Public	Method		20070425
10	GET_ITEM_GROUP	Instance method	Public	Method		20071210
11	GET_ITEM_GROUP_KEYS	Instance method	Public	Method		20071210
12	GET_TICKET	Instance method	Public	Method		20070424
13	INITIALIZE_ITEMS	Instance method	Public	Method		20070511
14	REMOVE_ITEM_GROUP	Instance method	Public	Method		20070511
15	SET_ACTION_LINK	Instance method	Public	Method	DO NOT USE !!! (deprecated, use SET_SIDE_PANEL_LINK)	20080202
16	SET_APPLICATION_TITLE	Instance method	Public	Method		20070424
17	SET_HEADER_VISIBILITY	Instance method	Public	Method		20070509
18	SET_ITEMS_VISIBILITY	Instance method	Public	Method		20070425
19	SET_SIDE_PANEL_LINK	Instance method	Public	Method	Defines the side panel link	20090311
20	SET_TAG_VALUE	Instance method	Public	Method	Sets a value for a tag	20090724
21	SET_TICKET	Instance method	Public	Method		20070424
22	SET_TICKET_VISIBILITY	Instance method	Public	Method		20070425

Events

Interface IF_FPM_IDR has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	S_ITEMS_REF	Public	See coding			20070508	BEGIN OF s_items_ref, label_name TYPE wdy_conf_transl_text, label_tooltip TYPE wdy_conf_transl_text, value_path TYPE string, "NODE.-1.NODE.-1.NODE.-1.ATTRIBUTE value_tooltip TYPE wdy_conf_transl_text, show_unit TYPE boole_d, END OF s_items_ref
2	S_ITEMS_VAL	Public	See coding			20070508	BEGIN OF s_items_val, label_name TYPE wdy_conf_transl_text, label_tooltip TYPE wdy_conf_transl_text, value TYPE wdy_conf_transl_text, value_tooltip TYPE wdy_conf_transl_text, END OF s_items_val
3	T_ITEMS_REF	Public	See coding			20070508	t_items_ref TYPE STANDARD TABLE OF s_items_ref WITH DEFAULT KEY
4	T_ITEMS_VAL	Public	See coding			20070508	t_items_val TYPE STANDARD TABLE OF s_items_val WITH DEFAULT KEY
5	T_ITEM_GROUP_KEYS	Public	See coding			20071210	t_item_group_keys TYPE STANDARD TABLE OF i WITH DEFAULT KEY

Method Signatures

Method ADD_IMAGE_ITEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_KEY	Call by reference	☐	Type reference (TYPE)	I			20071220
2	Importing	IV_EXPLANATION_TEXT	Call by reference	☐	Type reference (TYPE)	STRING		some explaining text for the icon	20080311
3	Importing	IV_EXPLANATION_TOOLTIP	Call by reference	☐	Type reference (TYPE)	STRING			20080311
4	Importing	IV_IMAGE_TOOLTIP	Call by reference	☐	Type reference (TYPE)	STRING			20071220
5	Importing	IV_IS_DECORATIVE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20130227
6	Importing	IV_LABEL_TEXT	Call by reference	☐	Type reference (TYPE)	STRING			20071220
7	Importing	IV_LABEL_TOOLTIP	Call by reference	☐	Type reference (TYPE)	STRING			20071220
8	Importing	IV_SOURCE	Call by reference	☐	Type reference (TYPE)	STRING			20071220

Method ADD_IMAGE_ITEM on Interface IF_FPM_IDR has no exception.

Method ADD_ITEM_GROUP_BY_REF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_KEY	Value transfer	☐	Type reference (TYPE)	I		GUID in 'CHAR' Format in Uppercase	20070515
2	Importing	IO_ROOT_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT		Web Dynpro Context	20070511
3	Importing	IT_ITEMS	Call by reference	☐	Type reference (TYPE)	T_ITEMS_REF			20070511

#	Exception	Resumable	Description	Created on
1	CX_FPM_IDR	☐	IDR exceptions	20070522

Method ADD_ITEM_GROUP_BY_VAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_KEY	Value transfer	☐	Type reference (TYPE)	I		GUID in 'CHAR' Format in Uppercase	20070515
2	Importing	IT_ITEMS	Call by reference	☐	Type reference (TYPE)	T_ITEMS_VAL			20070511

Method ADD_ITEM_GROUP_BY_VAL on Interface IF_FPM_IDR has no exception.

Method ADD_NAVIGATION_ITEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_KEY	Value transfer	☐	Type reference (TYPE)	I			20071218
2	Importing	IO_NAVIGATION	Call by reference	☐	Object reference (TYPE REF TO)	IF_FPM_NAVIGATION		List of Navigationtargets	20071218
3	Importing	IV_APPLICATION_ALIAS	Call by reference	☑	Type reference (TYPE)	STRING			20071218
4	Importing	IV_LABEL_TEXT	Call by reference	☐	Type reference (TYPE)	STRING			20071218
5	Importing	IV_LABEL_TOOLTIP	Call by reference	☐	Type reference (TYPE)	STRING			20071218
6	Importing	IV_LINK_TEXT	Call by reference	☑	Type reference (TYPE)	STRING			20071218
7	Importing	IV_LINK_TOOLTIP	Call by reference	☑	Type reference (TYPE)	STRING			20071218
8	Importing	IV_NAVIGATION_KEY	Call by reference	☑	Type reference (TYPE)	STRING			20071218

#	Exception	Resumable	Description	Created on
1	CX_FPM_IDR	☐	IDR exceptions	20071218

Method CHANGE_IMAGE_ITEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_EXPLANATION_TEXT	Call by reference	☑	Type reference (TYPE)	STRING			20080311
2	Importing	IV_EXPLANATION_TOOLTIP	Call by reference	☑	Type reference (TYPE)	STRING			20080311
3	Importing	IV_IMAGE_TOOLTIP	Call by reference	☑	Type reference (TYPE)	STRING			20071220
4	Importing	IV_ITEM_KEY	Call by reference	☐	Type reference (TYPE)	I			20071220
5	Importing	IV_LABEL_TEXT	Call by reference	☑	Type reference (TYPE)	STRING			20071220
6	Importing	IV_LABEL_TOOLTIP	Call by reference	☑	Type reference (TYPE)	STRING			20071220
7	Importing	IV_SOURCE	Call by reference	☑	Type reference (TYPE)	STRING			20071220

#	Exception	Resumable	Description	Created on
1	CX_FPM_IDR	☐	IDR exceptions	20071220

Method CHANGE_ITEM_GROUP_BY_VAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_ITEMS	Call by reference	☐	Type reference (TYPE)	T_ITEMS_VAL			20070515
2	Importing	IV_KEY	Call by reference	☐	Type reference (TYPE)	I			20070515

#	Exception	Resumable	Description	Created on
1	CX_FPM_IDR	☐	IDR exceptions	20070522

Method CHANGE_NAVIGATION_ITEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ITEM_KEY	Call by reference	☐	Type reference (TYPE)	I			20071219
2	Importing	IV_LABEL_TEXT	Call by reference	☑	Type reference (TYPE)	STRING			20071219
3	Importing	IV_LABEL_TOOLTIP	Call by reference	☑	Type reference (TYPE)	STRING			20071219
4	Importing	IV_LINK_TEXT	Call by reference	☑	Type reference (TYPE)	STRING			20071219
5	Importing	IV_LINK_TOOLTIP	Call by reference	☑	Type reference (TYPE)	STRING			20071219

#	Exception	Resumable	Description	Created on
1	CX_FPM_IDR	☐	IDR exceptions	20071219

Method CONTAINS_ITEM_GROUP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_EXISTS	Value transfer	☐	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20070515
2	Importing	IV_KEY	Call by reference	☐	Type reference (TYPE)	I		GUID in 'CHAR' Format in Uppercase	20070511

Method CONTAINS_ITEM_GROUP on Interface IF_FPM_IDR has no exception.

Method GET_APPLICATION_TITLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_TITLE	Call by reference	☐	Type reference (TYPE)	STRING			20070509
2	Exporting	EV_TITLE_TOOLTIP	Call by reference	☐	Type reference (TYPE)	STRING			20070509

Method GET_APPLICATION_TITLE on Interface IF_FPM_IDR has no exception.

Method GET_ITEM_GROUP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_CONTEXT	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT		Web Dynpro Context	20071210
2	Exporting	ET_ITEMS_REF	Call by reference	☐	Type reference (TYPE)	T_ITEMS_REF			20071210
3	Exporting	ET_ITEMS_VAL	Call by reference	☐	Type reference (TYPE)	T_ITEMS_VAL			20071210
4	Importing	IV_KEY	Call by reference	☐	Type reference (TYPE)	I			20071210

#	Exception	Resumable	Description	Created on
1	CX_FPM_IDR	☐	IDR exceptions	20071211

Method GET_ITEM_GROUP_KEYS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RT_KEYS	Value transfer	☐	Type reference (TYPE)	T_ITEM_GROUP_KEYS			20071210

Method GET_ITEM_GROUP_KEYS on Interface IF_FPM_IDR has no exception.

Method GET_TICKET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_BOTTOM	Call by reference	☐	Type reference (TYPE)	STRING			20070424
2	Exporting	EV_BOTTOM_TOOLTIP	Call by reference	☐	Type reference (TYPE)	STRING			20070424
3	Exporting	EV_TOP	Call by reference	☐	Type reference (TYPE)	STRING			20070424
4	Exporting	EV_TOP_TOOLTIP	Call by reference	☐	Type reference (TYPE)	STRING			20070424

#	Exception	Resumable	Description	Created on
1	CX_FPM_IDR	☐	IDR exceptions	20070612

Method INITIALIZE_ITEMS Signature

Method INITIALIZE_ITEMS on Interface IF_FPM_IDR has no parameter.
Method INITIALIZE_ITEMS on Interface IF_FPM_IDR has no exception.

Method REMOVE_ITEM_GROUP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_KEY	Call by reference	☐	Type reference (TYPE)	I		GUID in 'CHAR' Format in Uppercase	20070511

#	Exception	Resumable	Description	Created on
1	CX_FPM_IDR	☐	IDR exceptions	20070522

Method SET_ACTION_LINK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ENABLED	Call by reference	☐	Type reference (TYPE)	WDY_BOOLEAN		Supplement for True Boolean Type: 'X' == True '' == False	20080202
2	Importing	IV_FPM_EVENT_ID	Call by reference	☐	Type reference (TYPE)	FPM_EVENT_ID		ID of the FPM Event	20080202
3	Importing	IV_TEXT	Call by reference	☐	Type reference (TYPE)	STRING			20080202
4	Importing	IV_TOOLTIP	Call by reference	☐	Type reference (TYPE)	STRING			20080202
5	Importing	IV_VISIBLE	Call by reference	☐	Type reference (TYPE)	WDUI_VISIBILITY		Web Dynpro: Visibility	20080202

Method SET_ACTION_LINK on Interface IF_FPM_IDR has no exception.

Method SET_APPLICATION_TITLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TITLE	Call by reference	☐	Type reference (TYPE)	STRING			20070424
2	Importing	IV_TITLE_TOOLTIP	Call by reference	☑	Type reference (TYPE)	STRING			20070509

Method SET_APPLICATION_TITLE on Interface IF_FPM_IDR has no exception.

Method SET_HEADER_VISIBILITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_VISIBLE	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20070509

Method SET_HEADER_VISIBILITY on Interface IF_FPM_IDR has no exception.

Method SET_ITEMS_VISIBILITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_VISIBLE	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Boolean Variable (X=True, -=False, Space=Unknown)	20070425

Method SET_ITEMS_VISIBILITY on Interface IF_FPM_IDR has no exception.

Method SET_SIDE_PANEL_LINK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ACTIVE	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Web Dynpro: Visibility	20090311
2	Importing	IV_TEXT	Call by reference	☑	Type reference (TYPE)	STRING			20090311
3	Importing	IV_TOOLTIP	Call by reference	☑	Type reference (TYPE)	STRING			20090311

Method SET_SIDE_PANEL_LINK on Interface IF_FPM_IDR has no exception.

Method SET_TAG_VALUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TAG	Call by reference	☐	Type reference (TYPE)	WDY_TAG_NAME		Tag name	20090724
2	Importing	I_VALUE	Call by reference	☐	Type reference (TYPE)	ANY		Value	20090724

Method SET_TAG_VALUE on Interface IF_FPM_IDR has no exception.

Method SET_TICKET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_BOTTOM	Call by reference	☐	Type reference (TYPE)	STRING			20070424
2	Importing	IV_BOTTOM_TOOLTIP	Call by reference	☑	Type reference (TYPE)	STRING			20070424
3	Importing	IV_TOP	Call by reference	☐	Type reference (TYPE)	STRING			20070424
4	Importing	IV_TOP_TOOLTIP	Call by reference	☑	Type reference (TYPE)	STRING			20070424

#	Exception	Resumable	Description	Created on
1	CX_FPM_IDR	☐	IDR exceptions	20070612

Method SET_TICKET_VISIBILITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_VISIBLE	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Boolean Variable (X=True, -=False, Space=Unknown)	20070425

#	Exception	Resumable	Description	Created on
1	CX_FPM_IDR	☐	IDR exceptions	20070612

History

Last changed by/on	SAP	20131127
SAP Release Created in