SAP ABAP Class CL_FPM_QV_ASSIST (Assistance Class for FPM Quickviews)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ BC-WD-CMP-FPM (Application Component) Floorplan Manager Web Dynpro ABAP
     ⤷ APB_FPM_GUIBB (Package) Generic UI building blocks

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_WD_COMPONENT_ASSISTANCE	Basis for a Web Dynpro assistance class	20120613

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_FPM_QV_DATASET_ASSIST	Assistance Class for FPM_QUICKVIEW_DATASET	20120614
2	Inheritance (c INHERITING FROM c_ref)	CL_FPM_QV_IMAGE_ASSIST	Assistance Class for FPM_QUICKVIEW_IMAGE	20140109
3	Inheritance (c INHERITING FROM c_ref)	CL_FPM_QV_THING_ASSIST	Assistance Class for FPM_QUICKVIEW_THING	20120621

Properties

Class	CL_FPM_QV_ASSIST
Short Description	Assistance Class for FPM Quickviews
Super Class	CL_WD_COMPONENT_ASSISTANCE	Basis for a Web Dynpro assistance class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	APB_FPM_GUIBB	Generic UI building blocks
Created	20120613	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	CL_FPM_EVENT	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	IF_FPM_GUIBB_QV_DATASET	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_FPM_QV_ASSIST has no interface implemented.

Friends

Class CL_FPM_QV_ASSIST has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MO_COMPONENT	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_WD_COMPONENT		Web Dynpro: Component	20120613
2	MO_CONTEXT	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE		Web Dynpro: Interface for Context Nodes	20120613
3	MO_FPM	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_FPM		This is an internal class and must not be accessed!!!!!!!!!!	20120613
4	MO_RENDER	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	IF_FPM_GUIBB_RENDER		GUIBB Rendering	20120613
5	MR_QUICKVIEW_KEY	Instance attribute	Private	☐	Object reference (TYPE REF TO)	DATA		Quickview key reference	20140109
6	MS_UIBB_KEY	Instance attribute	Protected	☐	Type reference (TYPE)	CL_FPM_EVENT=>TY_S_UIBB_KEY		UIBB Key	20120613
7	MT_SELECTED_FIELD	Instance attribute	Protected	☐	Type reference (TYPE)	FPMGB_T_SELECTED_FIELDS		Used fields	20120613
8	MV_IS_ACCESSIBLE	Instance attribute	Protected	☐	Type reference (TYPE)	ABAP_BOOL			20131023
9	MV_IS_MULTI_INSTANTIABLE	Instance attribute	Public	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Indicator: Feeder is multi-instantiable	20120614

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_OWN_EVENT	Instance method	Protected	Method	Check whether event was raised by own UI	20120613
2	DETERMINE_ELEMENT_INDEX	Instance method	Protected	Method	Determine the index of a context element in the values node	20120613
3	FPM_INITIALIZE	Instance method	Public	Method	FPM Initialize	20120613
4	GET_ACC_MODE_INFOS	Instance method	Protected	Method	Get information for accessibility mode	20131106
5	GET_DYNAMIC_DATA_ELEMENT	Instance method	Protected	Method	Get context element for dynamic data	20130201
6	GET_DYNAMIC_DATA_NODE	Instance method	Protected	Method	Get context node for dynamic data	20120613
7	GET_EVENT_CONTEXT_ELEMENT	Instance method	Protected	Method	Get the context element from a WD event	20120613
8	GET_FIELD_VALUE_REF	Instance method	Protected	Method	Get data reference for the field value in the values node	20120613
9	GET_QUICKVIEW_KEY	Instance method	Protected	Method	Get Quickview key	20140109
10	GET_UNADAPTED_CONFIG_KEY	Instance method	Protected	Method	Get unadapted configuration key	20120613
11	GET_VALUES_ELEMENT	Instance method	Protected	Method	Get context element at a particular index of the values node	20120613
12	GET_VALUES_NODE	Instance method	Protected	Method	Get context node for dynamic values	20120613
13	INITIALIZE	Instance method	Public	Method	Initialize Quickview and set WD instances	20120613
14	PROCESS_MESSAGES	Instance method	Protected	Method	Process messages	20120613
15	RENDER	Instance method	Public	Method	Render Quickview	20120613
16	REPLACE_ROOT_CONT_IN_ACC_MODE	Instance method	Protected	Method	Replace root container for aria landmark in accessib. mode	20131106
17	SET_ADDITIONAL_EVENT_PARAMS	Instance method	Protected	Method	Set additional event parameters	20120613
18	SET_FIELD_NAME_ON_EVENT	Instance method	Protected	Method	Set field name on event	20120613
19	SET_FIELD_VALUE_ON_EVENT	Instance method	Protected	Method	Set field value on event	20120613
20	SET_QUICKVIEW_KEY	Instance method	Public	Method	Set Quickview key	20140109
21	SET_ROW_INDEX_ON_EVENT	Instance method	Protected	Method	Set row index of relevant data record on event	20120613

Events

Class CL_FPM_QV_ASSIST has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	YS_FEEDER	Private	See coding			20120613	BEGIN OF ys_feeder, name TYPE seoclsname, feeder TYPE REF TO if_fpm_guibb_qv_dataset, END OF ys_feeder

Method Signatures

Method CHECK_OWN_EVENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_EVENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_FPM_EVENT		FPM Event	20120613
2	Returning	RV_OWN_EVENT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Indicator: Event raised by own component	20120613

Method CHECK_OWN_EVENT on class CL_FPM_QV_ASSIST has no exception.

Method DETERMINE_ELEMENT_INDEX 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	20120613
2	Returning	RV_INDEX	Value transfer	☐	Type reference (TYPE)	I		Index of a context element in the value node	20120613

Method DETERMINE_ELEMENT_INDEX on class CL_FPM_QV_ASSIST has no exception.

Method FPM_INITIALIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_FPM	Call by reference	☐	Object reference (TYPE REF TO)	IF_FPM		Interface for accessing FPM functionality	20120613

Method FPM_INITIALIZE on class CL_FPM_QV_ASSIST has no exception.

Method GET_ACC_MODE_INFOS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_ACC_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	FPM_ACCESSIBILITY_DESCR		Accessibility Description	20131106
2	Exporting	EV_ARIA_LANDMARK	Call by reference	☐	Type reference (TYPE)	FPM_ARIA_LANDMARK		Aria Landmark	20131106
3	Importing	IO_CONTEXT_NODE	Call by reference	☑	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE		Web Dynpro: Interface for Context Nodes	20131106

Method GET_ACC_MODE_INFOS on class CL_FPM_QV_ASSIST has no exception.

Method GET_DYNAMIC_DATA_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_ELEMENT	Value transfer	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_ELEMENT		Web Dynpro: Interface for Node Element	20130201

Method GET_DYNAMIC_DATA_ELEMENT on class CL_FPM_QV_ASSIST has no exception.

Method GET_DYNAMIC_DATA_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_DYNAMIC_DATA_NODE	Value transfer	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE		Dynamically created context node for form data	20120613

Method GET_DYNAMIC_DATA_NODE on class CL_FPM_QV_ASSIST has no exception.

Method GET_EVENT_CONTEXT_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_WD_EVENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_WD_CUSTOM_EVENT		Application-Defined Event	20120613
2	Returning	RO_ELEMENT	Value transfer	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_ELEMENT		Web Dynpro: Interface for Node Element	20120613

Method GET_EVENT_CONTEXT_ELEMENT on class CL_FPM_QV_ASSIST has no exception.

Method GET_FIELD_VALUE_REF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FIELD_NAME	Call by reference	☐	Type reference (TYPE)	STRING		Field name	20120613
2	Importing	IV_INDEX	Call by reference	☑	Type reference (TYPE)	I		Row index	20120613
3	Returning	RR_DATA	Value transfer	☐	Object reference (TYPE REF TO)	DATA		Data reference of the field value	20120613

Method GET_FIELD_VALUE_REF on class CL_FPM_QV_ASSIST has no exception.

Method GET_QUICKVIEW_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ER_KEY	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Quickview key reference	20140109
2	Exporting	EV_KEY	Call by reference	☐	Type reference (TYPE)	STRING		Serialized Quickview key	20140109

Method GET_QUICKVIEW_KEY on class CL_FPM_QV_ASSIST has no exception.

Method GET_UNADAPTED_CONFIG_KEY 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)	CL_FPM_EVENT=>TY_S_UIBB_KEY		Adapted UIBB key	20120613
2	Returning	RS_UIBB_KEY	Value transfer	☐	Type reference (TYPE)	CL_FPM_EVENT=>TY_S_UIBB_KEY		Unadapted UIBB key	20120613

Method GET_UNADAPTED_CONFIG_KEY on class CL_FPM_QV_ASSIST has no exception.

Method GET_VALUES_ELEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_INDEX	Call by reference	☑	Type reference (TYPE)	I		Row index	20120613
2	Returning	RO_ELEMENT	Value transfer	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_ELEMENT		Web Dynpro: Interface for Node Element	20120613

Method GET_VALUES_ELEMENT on class CL_FPM_QV_ASSIST has no exception.

Method GET_VALUES_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_VALUES_NODE	Value transfer	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE		Dynamically created context node for values	20120613

Method GET_VALUES_NODE on class CL_FPM_QV_ASSIST has no exception.

Method INITIALIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_COMPONENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_COMPONENT		Web Dynpro: Component	20120613
2	Importing	IO_CONTEXT	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE		Web Dynpro: Interface for Context Nodes	20120613
3	Importing	IV_INTERFACE_VIEW	Call by reference	☐	Type reference (TYPE)	FPM_VIEW_NAME		Web Dynpro: Name of a Web Dynpro View	20120613

Method INITIALIZE on class CL_FPM_QV_ASSIST has no exception.

Method PROCESS_MESSAGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_MESSAGES	Call by reference	☐	Type reference (TYPE)	FPMGB_T_MESSAGES		FPMGB Messages (T100 & Plaintext)	20120613

Method PROCESS_MESSAGES on class CL_FPM_QV_ASSIST has no exception.

Method RENDER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_VIEW	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_VIEW		Web Dynpro: API of a View	20120613
2	Importing	IV_ENFORCE_RENDERING	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Indicator: Enforce rendering	20120613

Method RENDER on class CL_FPM_QV_ASSIST has no exception.

Method REPLACE_ROOT_CONT_IN_ACC_MODE 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	20131106
2	Importing	IO_VIEW	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_VIEW		Web Dynpro: API of a View	20131106
3	Importing	IV_REBUILD_VIEW	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Indicator: View is rebuilt	20140624

Method REPLACE_ROOT_CONT_IN_ACC_MODE on class CL_FPM_QV_ASSIST has no exception.

Method SET_ADDITIONAL_EVENT_PARAMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_FPM_EVENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_FPM_EVENT		CL_FPM_EVENT	20120613
2	Importing	IO_WD_EVENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_WD_CUSTOM_EVENT		Application-Defined Event	20120613

Method SET_ADDITIONAL_EVENT_PARAMS on class CL_FPM_QV_ASSIST has no exception.

Method SET_FIELD_NAME_ON_EVENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_FPM_EVENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_FPM_EVENT		CL_FPM_EVENT	20120613
2	Importing	IO_WD_EVENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_WD_CUSTOM_EVENT		Application-Defined Event	20120613

Method SET_FIELD_NAME_ON_EVENT on class CL_FPM_QV_ASSIST has no exception.

Method SET_FIELD_VALUE_ON_EVENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_FPM_EVENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_FPM_EVENT		CL_FPM_EVENT	20120613
2	Importing	IO_WD_EVENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_WD_CUSTOM_EVENT		Application-Defined Event	20120613

Method SET_FIELD_VALUE_ON_EVENT on class CL_FPM_QV_ASSIST has no exception.

Method SET_QUICKVIEW_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_KEY	Call by reference	☐	Object reference (TYPE REF TO)	DATA		Quickview key reference	20140109

Method SET_QUICKVIEW_KEY on class CL_FPM_QV_ASSIST has no exception.

Method SET_ROW_INDEX_ON_EVENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_FPM_EVENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_FPM_EVENT		CL_FPM_EVENT	20120613
2	Importing	IO_WD_EVENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_WD_CUSTOM_EVENT		Application-Defined Event	20120613

Method SET_ROW_INDEX_ON_EVENT on class CL_FPM_QV_ASSIST has no exception.

History

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