SAP ABAP Class CL_FPM_GAF_ASSIST (Assistance class for GAF)

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 - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_FPM_GAF_MAIN_ASSIST	Assistance class for all GAFs	20090724

Properties

Class	CL_FPM_GAF_ASSIST
Short Description	Assistance class for GAF
Super Class	CL_FPM_GAF_MAIN_ASSIST	Assistance class for all GAFs
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	APB_FPM_CORE	Floorplan Manager (Framework)
Created	20090724	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_GAF_ASSIST has no interface implemented.

Friends

Class CL_FPM_GAF_ASSIST has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_CONFSTEP_AT	Constant	Public	☐	Type reference (TYPE)	STRING	'CONFSTEP'	Literal for GAF Cont. El. Confste	20091203
2	GC_INIT_ND	Constant	Public	☐	Type reference (TYPE)	STRING	'INITIAL_SCREEN'	Literal for HGA Context Node Initial Screen	20091203
3	MO_CNR	Instance attribute	Public	☐	Object reference (TYPE REF TO)	CL_FPM_CNR_GAF		CL_FPM_CNR_GAF	20100908
4	MO_FLOORPLAN_BTN_STATE	Instance attribute	Public	☐	Object reference (TYPE REF TO)	CL_FPM_CONTEXT_MANAGER		FPM Context Manager	20100908
5	MT_HIDDEN_MAINSTEPS	Instance attribute	Public	☐	Type reference (TYPE)	IF_FPM_GAF=>TY_T_HIDDEN_MAINSTEP			20100908
6	MV_FINAL_ACTION_EXECUTED	Instance attribute	Public	☐	Type reference (TYPE)	WDY_BOOLEAN		Supplement for True Boolean Type: 'X' == True '' == False	20100908
7	MV_MAINSTEP_ACTIVE	Instance attribute	Public	☐	Type reference (TYPE)	WDY_BOOLEAN		Supplement for True Boolean Type: 'X' == True '' == False	20100908
8	MV_PAGE_NAME	Instance attribute	Public	☐	Type reference (TYPE)	STRING			20100908
9	MV_PAGE_TITLE	Instance attribute	Public	☐	Type reference (TYPE)	STRING			20100908
10	MV_TITLE	Instance attribute	Public	☐	Type reference (TYPE)	STRING			20100908

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_HIDDEN_MAINSTEPS	Instance method	Public	Method		20100908
2	CREATE_TOOLBAR_ELEMENTS	Instance method	Public	Method	Set up the toolbar with buttons and their configuration	20091204
3	GET_CURRENT_STATE	Instance method	Public	Method	Returns the current GAF state	20091201
4	GET_FIRST_STEP	Instance method	Public	Method		20091203
5	GET_NEXT_MAINSTEP	Instance method	Public	Method	Returns the next mainstep in case of next events	20091202
6	GET_NEXT_SUBSTEP	Instance method	Public	Method	Returns the next substep in case of next events	20091202
7	GET_PREVIOUS_MAINSTEP	Instance method	Public	Method	Returns the previous mainstep in case of next events	20091202
8	GET_PREVIOUS_SUBSTEP	Instance method	Public	Method	Returns the previous substep in case of next events	20091202
9	GET_TARGET_STATE	Instance method	Public	Method		20091203
10	GET_TARGET_UIBBS	Instance method	Public	Method		20091203
11	RENDER_HEADER	Instance method	Public	Method		20100908
12	RENDER_TOOLBAR	Instance method	Public	Method	Set up the toolbar with buttons and their configuration	20091204
13	RENDER_TOOLBAR_GL2	Instance method	Public	Method	Set up the toolbar with buttons and their configuration	20100817
14	SET_TARGET_STATE	Instance method	Public	Method		20091203

Events

Class CL_FPM_GAF_ASSIST has no event.

Types

Class CL_FPM_GAF_ASSIST has no local type.

Method Signatures

Method CHECK_HIDDEN_MAINSTEPS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_IS_HIDDEN	Call by reference	☐	Type reference (TYPE)	WDY_BOOLEAN		Supplement for True Boolean Type: 'X' == True '' == False	20100908
2	Importing	IV_MAINSTEP_ID	Call by reference	☐	Type reference (TYPE)	STRING			20100908

Method CHECK_HIDDEN_MAINSTEPS on class CL_FPM_GAF_ASSIST has no exception.

Method CREATE_TOOLBAR_ELEMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_FPM_HCT_TOOLBAR_ASSIST	Call by reference	☑	Object reference (TYPE REF TO)	CL_FPM_HCT_TOOLBAR_ASSIST		FPM_CFG_TOOLBAR	20101122
2	Importing	IO_FPM_ND_TOOLBAR	Call by reference	☑	Object reference (TYPE REF TO)	IF_FPM_NODE		Interface for FPM nodes	20091204
3	Importing	IO_VIEW	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_VIEW		Web Dynpro: API of a View	20091204
4	Importing	IV_COMPONENT_NAME	Call by reference	☑	Type reference (TYPE)	STRING			20091204
5	Importing	IV_MAINSTEP_ACTIVE	Call by reference	☑	Type reference (TYPE)	WDY_BOOLEAN		Supplement for True Boolean Type: 'X' == True '' == False	20091204
6	Importing	IV_NAVIGATION_STATE	Call by reference	☑	Type reference (TYPE)	FPM_FLOORPLAN_STATE		Floorplan State	20091204

Method CREATE_TOOLBAR_ELEMENTS on class CL_FPM_GAF_ASSIST has no exception.

Method GET_CURRENT_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ES_GAF_APP_STATE	Value transfer	☐	Type reference (TYPE)	FPM_S_GAF_INFO		info about a GAF floorplan	20091201
2	Importing	IR_FLOORPLAN_DATA	Call by reference	☐	Object reference (TYPE REF TO)	CL_FPM_CONTEXT_MANAGER		FPM Context Manager	20091201
3	Importing	IR_FLOORPLAN_STATE	Call by reference	☐	Object reference (TYPE REF TO)	CL_FPM_CONTEXT_MANAGER		FPM Context Manager	20091201

Method GET_CURRENT_STATE on class CL_FPM_GAF_ASSIST has no exception.

Method GET_FIRST_STEP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ES_GAF_APP_STATE	Value transfer	☐	Type reference (TYPE)	FPM_S_GAF_INFO		info about a GAF floorplan	20091203
2	Importing	IR_FLOORPLAN_DATA	Call by reference	☐	Object reference (TYPE REF TO)	CL_FPM_CONTEXT_MANAGER		FPM Context Manager	20091203

Method GET_FIRST_STEP on class CL_FPM_GAF_ASSIST has no exception.

Method GET_NEXT_MAINSTEP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ES_GAF_INFO	Value transfer	☐	Type reference (TYPE)	FPM_S_GAF_INFO		info about a GAF floorplan	20091202
2	Importing	IR_CONTEXT_MANAGER	Call by reference	☐	Object reference (TYPE REF TO)	CL_FPM_CONTEXT_MANAGER		FPM Context Manager	20091202

Method GET_NEXT_MAINSTEP on class CL_FPM_GAF_ASSIST has no exception.

Method GET_NEXT_SUBSTEP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ES_GAF_INFO	Value transfer	☐	Type reference (TYPE)	FPM_S_GAF_INFO		info about a GAF floorplan	20091202
2	Importing	IR_CONTEXT_MANAGER	Call by reference	☐	Object reference (TYPE REF TO)	CL_FPM_CONTEXT_MANAGER		FPM Context Manager	20091202

Method GET_NEXT_SUBSTEP on class CL_FPM_GAF_ASSIST has no exception.

Method GET_PREVIOUS_MAINSTEP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ES_GAF_INFO	Value transfer	☐	Type reference (TYPE)	FPM_S_GAF_INFO		info about a GAF floorplan	20091202
2	Importing	IR_CONTEXT_MANAGER	Call by reference	☐	Object reference (TYPE REF TO)	CL_FPM_CONTEXT_MANAGER		FPM Context Manager	20091202

Method GET_PREVIOUS_MAINSTEP on class CL_FPM_GAF_ASSIST has no exception.

Method GET_PREVIOUS_SUBSTEP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ES_GAF_INFO	Value transfer	☐	Type reference (TYPE)	FPM_S_GAF_INFO		info about a GAF floorplan	20091202
2	Importing	IR_CONTEXT_MANAGER	Call by reference	☐	Object reference (TYPE REF TO)	CL_FPM_CONTEXT_MANAGER		FPM Context Manager	20091202

Method GET_PREVIOUS_SUBSTEP on class CL_FPM_GAF_ASSIST has no exception.

Method GET_TARGET_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	ES_GAF_APP_STATE	Value transfer	☐	Type reference (TYPE)	FPM_S_GAF_INFO		info about a GAF floorplan	20091203
2	Importing	IR_FLOORPLAN_STATE	Call by reference	☐	Object reference (TYPE REF TO)	CL_FPM_CONTEXT_MANAGER		FPM Context Manager	20091203

Method GET_TARGET_STATE on class CL_FPM_GAF_ASSIST has no exception.

Method GET_TARGET_UIBBS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_UIBB	Call by reference	☐	Type reference (TYPE)	FPM_T_UIBB_KEY		Table type of UIBB keys	20091211
2	Exporting	EV_ROP_CHANGED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20091203
3	Exporting	EV_TOOLBAR_CHANGED	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20091203
4	Importing	IR_CONTEXT_MANAGER	Call by reference	☐	Object reference (TYPE REF TO)	CL_FPM_CONTEXT_MANAGER		FPM Context Manager	20091203
5	Importing	IR_GAF	Call by reference	☐	Object reference (TYPE REF TO)	CL_FPM_GAF		Communication Floorplan <-> AppCC	20091203
6	Importing	IR_TARGET_STATE	Call by reference	☐	Type reference (TYPE)	FPM_S_GAF_INFO		info about a GAF floorplan	20091203

Method GET_TARGET_UIBBS on class CL_FPM_GAF_ASSIST has no exception.

Method RENDER_HEADER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FIRST_TIME	Value transfer	☐	Type reference (TYPE)	WDY_BOOLEAN		Supplement for True Boolean Type: 'X' == True '' == False	20100908
2	Importing	IO_CMP_API	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_COMPONENT		Web Dynpro: Component	20110608
3	Importing	IO_VIEW	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_VIEW		Web Dynpro: API of a View	20100908
4	Importing	IV_STATE	Call by reference	☐	Type reference (TYPE)	FPM_FLOORPLAN_STATE		Floorplan State	20100908

Method RENDER_HEADER on class CL_FPM_GAF_ASSIST has no exception.

Method RENDER_TOOLBAR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CONTEXT	Call by reference	☑	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE		Web Dynpro Context	20091204
2	Importing	IO_FPM_ND_TOOLBAR	Call by reference	☑	Object reference (TYPE REF TO)	IF_FPM_NODE		Interface for FPM nodes	20091204
3	Importing	IO_VIEW	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_VIEW		Web Dynpro: API of a View	20091204
4	Importing	IV_COMPONENT_NAME	Call by reference	☑	Type reference (TYPE)	STRING			20091204
5	Importing	IV_MAINSTEP_ACTIVE	Call by reference	☑	Type reference (TYPE)	WDY_BOOLEAN		Supplement for True Boolean Type: 'X' == True '' == False	20091204
6	Importing	IV_NAVIGATION_STATE	Call by reference	☑	Type reference (TYPE)	FPM_FLOORPLAN_STATE		Floorplan State	20091204

Method RENDER_TOOLBAR on class CL_FPM_GAF_ASSIST has no exception.

Method RENDER_TOOLBAR_GL2 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CONTEXT	Call by reference	☑	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE		Web Dynpro Context	20100817
2	Importing	IO_FPM_HCT_TOOLBAR_ASSIST	Call by reference	☑	Object reference (TYPE REF TO)	CL_FPM_HCT_TOOLBAR_ASSIST		FPM_CFG_TOOLBAR	20101122
3	Importing	IO_FPM_ND_TOOLBAR	Call by reference	☑	Object reference (TYPE REF TO)	IF_FPM_NODE		Interface for FPM nodes	20100817
4	Importing	IO_VIEW	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_VIEW		Web Dynpro: API of a View	20100817
5	Importing	IV_COMPONENT_NAME	Call by reference	☑	Type reference (TYPE)	STRING			20100817
6	Importing	IV_MAINSTEP_ACTIVE	Call by reference	☑	Type reference (TYPE)	WDY_BOOLEAN		Supplement for True Boolean Type: 'X' == True '' == False	20100817
7	Importing	IV_NAVIGATION_STATE	Call by reference	☑	Type reference (TYPE)	FPM_FLOORPLAN_STATE		Floorplan State	20100817

Method RENDER_TOOLBAR_GL2 on class CL_FPM_GAF_ASSIST has no exception.

Method SET_TARGET_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_FLOORPLAN_TARGET_STATE	Call by reference	☐	Object reference (TYPE REF TO)	CL_FPM_CONTEXT_MANAGER		FPM Context Manager	20091203
2	Importing	IS_GAF_INFO	Call by reference	☐	Type reference (TYPE)	FPM_S_GAF_INFO		info about a GAF floorplan	20091203

Method SET_TARGET_STATE on class CL_FPM_GAF_ASSIST has no exception.

History

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