SAP ABAP Class CL_FPM_CHIP_INTEGRATION (Side Panel and Tagging)

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)

Properties

Class	CL_FPM_CHIP_INTEGRATION
Short Description	Side Panel and Tagging
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	APB_FPM_CORE	Floorplan Manager (Framework)
Created	20090723	SAP
Last change	20131127	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	CL_WD_SIDE_PANEL_API	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_FPM_CHIP_INTEGRATION has no interface implemented.

Friends

Class CL_FPM_CHIP_INTEGRATION has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MO_CONTEXT_NODE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE		Web Dynpro: Interface for Context Nodes	20090805
2	MO_TAGGING_NODE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE		Web Dynpro: Interface for Context Nodes	20090723
3	MV_SP_INITILIZED	Instance attribute	Public	☑	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20120315
4	MV_SP_LINK_ACTIVE	Instance attribute	Public	☑	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20090723
5	MV_SP_LINK_TEXT	Instance attribute	Public	☑	Type reference (TYPE)	STRING			20090723
6	MV_SP_LINK_TOOLTIP	Instance attribute	Public	☑	Type reference (TYPE)	STRING			20090723
7	MV_SP_OPEN	Instance attribute	Public	☑	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20100121
8	MV_SP_STATE_CHECKED	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20100204
9	MV_SUPRESS_SP	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20130218
10	ST_TAG_ATTR_MAP	Static Attribute	Private	☐	See coding				20100708
11	SV_IDR_CONFIG_KEY	Static Attribute	Private	☐	Type reference (TYPE)	WDY_CONFIG_KEY			20100623
12	SV_SUPRESS_SP	Static Attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20130218

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_SIDE_PANEL_STATE	Instance method	Public	Method	Checks side panel state change	20100121
2	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20090723
3	CREATE_TAGGING_NODE	Instance method	Private	Method	Creates tagging node unless already done	20090805
4	DEFINE_SIDE_PANEL_LINK	Instance method	Public	Method	Defines the side panel link properties	20090723
5	EXIT_SIDE_PANEL	Instance method	Public	Method	Unregisters the side panel API	20130218
6	GET_IDR_CONFIG_KEY	Static method	Public	Method	Retrieves IDR configuration in an embedding scenario	20100623
7	GET_TAG_ATTRIBUTE_NAME	Static method	Private	Method	Assigns an attribute name to a tag	20100708
8	INIT_SIDE_PANEL	Instance method	Public	Method	Initializes the side panel API	20120315
9	REGISTER_TAG	Static method	Public	Method	Registers a tag for a node attribute via tagging service	20090727
10	SET_IDR_CONFIG_KEY	Static method	Public	Method	Sets IDR configuration in an embedding scenario	20100623
11	SET_SLEEP_MODE	Static method	Public	Method	Disables non-unique tagging	20120120
12	SET_TAG_VALUE	Instance method	Public	Method	Sets a value for a tag	20090724
13	SUPRESS_SIDE_PANEL	Instance method	Public	Method	Supress classical side panel (in floorplan CHIPs)	20130218
14	SUPRESS_SP_FOR_FLOORPLAN	Static method	Public	Method	Before WD component create: Supress SP for created floorplan	20130218

Events

Class CL_FPM_CHIP_INTEGRATION has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_S_TAG_ATTR_MAP	Private	See coding			20100708	begin of ty_S_TAG_ATTR_MAP, tag type wdy_tag_name, attr_name type string, end of ty_S_TAG_ATTR_MAP

Method Signatures

Method CHECK_SIDE_PANEL_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_CHANGED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20100121

Method CHECK_SIDE_PANEL_STATE on class CL_FPM_CHIP_INTEGRATION has no exception.

Method CONSTRUCTOR 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	20090727

Method CONSTRUCTOR on class CL_FPM_CHIP_INTEGRATION has no exception.

Method CREATE_TAGGING_NODE Signature

Method CREATE_TAGGING_NODE on class CL_FPM_CHIP_INTEGRATION has no parameter.
Method CREATE_TAGGING_NODE on class CL_FPM_CHIP_INTEGRATION has no exception.

Method DEFINE_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)	ABAP_BOOL	ABAP_TRUE		20090723
2	Importing	IV_TEXT	Call by reference	☑	Type reference (TYPE)	STRING			20090723
3	Importing	IV_TOOLTIP	Call by reference	☑	Type reference (TYPE)	STRING			20090723

Method DEFINE_SIDE_PANEL_LINK on class CL_FPM_CHIP_INTEGRATION has no exception.

Method EXIT_SIDE_PANEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_VIEW_CONTROLLER	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_VIEW_CONTROLLER		Web Dynpro: View Controller	20130218

Method EXIT_SIDE_PANEL on class CL_FPM_CHIP_INTEGRATION has no exception.

Method GET_IDR_CONFIG_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RS_CONFIG_KEY	Value transfer	☐	Type reference (TYPE)	WDY_CONFIG_KEY			20100623

Method GET_IDR_CONFIG_KEY on class CL_FPM_CHIP_INTEGRATION has no exception.

Method GET_TAG_ATTRIBUTE_NAME 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	20100708
2	Returning	RV_NAME	Value transfer	☐	Type reference (TYPE)	STRING			20100708

Method GET_TAG_ATTRIBUTE_NAME on class CL_FPM_CHIP_INTEGRATION has no exception.

Method INIT_SIDE_PANEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_VIEW_CONTROLLER	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_VIEW_CONTROLLER		Web Dynpro: View Controller	20120315
2	Importing	IV_PORTAL_EVENT_ACTION	Call by reference	☐	Type reference (TYPE)	STRING			20120315

Method INIT_SIDE_PANEL on class CL_FPM_CHIP_INTEGRATION has no exception.

Method REGISTER_TAG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE		Web Dynpro: Interface for Context Nodes	20090727
2	Importing	IV_ATTRIBUTE	Call by reference	☐	Type reference (TYPE)	STRING			20090727
3	Importing	IV_TAG_NAME	Call by reference	☐	Type reference (TYPE)	WDY_TAG_NAME			20090727

Method REGISTER_TAG on class CL_FPM_CHIP_INTEGRATION has no exception.

Method SET_IDR_CONFIG_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_CONFIG_KEY	Call by reference	☑	Type reference (TYPE)	WDY_CONFIG_KEY			20100623

Method SET_IDR_CONFIG_KEY on class CL_FPM_CHIP_INTEGRATION has no exception.

Method SET_SLEEP_MODE Signature

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

Method SET_SLEEP_MODE on class CL_FPM_CHIP_INTEGRATION 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			20090724
2	Importing	I_VALUE	Call by reference	☐	Type reference (TYPE)	ANY			20090724

Method SET_TAG_VALUE on class CL_FPM_CHIP_INTEGRATION has no exception.

Method SUPRESS_SIDE_PANEL Signature

Method SUPRESS_SIDE_PANEL on class CL_FPM_CHIP_INTEGRATION has no parameter.
Method SUPRESS_SIDE_PANEL on class CL_FPM_CHIP_INTEGRATION has no exception.

Method SUPRESS_SP_FOR_FLOORPLAN Signature

Method SUPRESS_SP_FOR_FLOORPLAN on class CL_FPM_CHIP_INTEGRATION has no parameter.
Method SUPRESS_SP_FOR_FLOORPLAN on class CL_FPM_CHIP_INTEGRATION has no exception.

History

Last changed by/on	SAP	20131127
SAP Release Created in	730