SAP ABAP Class CL_FPM_HCT_TOOLBAR_ASSIST ( FPM_CFG_TOOLBAR)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ BC-WD-CMP-FPM (Application Component) Floorplan Manager Web Dynpro ABAP
     ⤷ APB_FPM_HCT (Package) Harmonized Configuration Tool

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_FPM_HCT_UI_ASSIST	Assistance class for FPM configuration editor	20090604

Properties

Class	CL_FPM_HCT_TOOLBAR_ASSIST
Short Description	FPM_CFG_TOOLBAR
Super Class	CL_FPM_HCT_UI_ASSIST	Assistance class for FPM configuration editor
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	APB_FPM_HCT	Harmonized Configuration Tool
Created	20090603	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☐
Unicode checks active	☑

Forward declarations

Class CL_FPM_HCT_TOOLBAR_ASSIST has no forward declaration.

Interfaces

Class CL_FPM_HCT_TOOLBAR_ASSIST has no interface implemented.

Friends

Class CL_FPM_HCT_TOOLBAR_ASSIST has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CS_ACTION	Constant	Public	☐	See coding				20100519
2	MO_HOOK_NODE	Instance attribute	Public	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE		Storing of generic context data	20090603
3	MO_REP_TOOLBAR	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_FPM_HCT_REPOSITORY		Repository	20100527
4	MT_ORDERED_UI_ELEMENTS	Instance attribute	Private	☐	Type reference (TYPE)	TY_T_SEQUENCE			20101227
5	MV_CONTROLLER_NAME	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20100813
6	MV_COUNTER	Instance attribute	Public	☐	Type reference (TYPE)	I			20090603
7	MV_DELETE_BUTTON	Instance attribute	Public	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20090603
8	MV_MAPPING_SET	Instance attribute	Private	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20100813

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADAPT_ELEMENT_INDEX	Instance method	Public	Method	Adapt sequence index of toolbar elements	20101227
2	ADD_BC_GAF_MAIN	Instance method	Public	Method	Adding a button-choice to the main screen of a GAF	20100528
3	ADD_BC_INIT	Instance method	Public	Method	Adding a button-choice to the initial screen	20100528
4	ADD_BC_OIF_MAIN	Instance method	Public	Method	Adding a button-choice to the main screen of an OIF	20100528
5	ADD_BTN_GAF_MAIN	Instance method	Public	Method	Adding a button to the main screen of a GAF	20100528
6	ADD_BTN_INIT	Instance method	Public	Method	Adding a button to the initial screen	20100528
7	ADD_BTN_OIF_MAIN	Instance method	Public	Method	Adding a button to the main screen of an OIF	20100528
8	ADD_ELEMENT_INDEX	Instance method	Protected	Method		20101227
9	ADD_LINK_GAF_MAIN	Instance method	Public	Method	Adding a menu or separator to the main screen of a GAF	20100528
10	ADD_LINK_INIT	Instance method	Public	Method	Adding a separator to the initial screen	20100528
11	ADD_LINK_OIF_MAIN	Instance method	Public	Method	Adding a menu or separator to the main screen of an OIF	20100528
12	CHANGE_ELEMENT_INDEX	Instance method	Protected	Method	Shift an element within other functions	20101227
13	CHECK_HOTKEY	Instance method	Public	Method	Check whether hotkey is valid and can be used	20100610
14	DROP	Instance method	Private	Method	Drop element	20110225
15	GET_REP_TOOLBAR_INSTANCE	Instance method	Public	Method		20100527
16	HANDLE_ACTION_ID	Instance method	Private	Method		20100526
17	SET_DEFAULT_ITEM_VALUE_SET	Instance method	Private	Method	Set value set of selected action item	20120515
18	SORT_OTHER_FUNCTIONS	Instance method	Private	Method		20101229
19	UPDATE_ITEMS	Instance method	Private	Method		20120522
20	UPDATE_PARAMETERS	Instance method	Private	Method		20120201

Events

Class CL_FPM_HCT_TOOLBAR_ASSIST has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_S_SEQUENCE	Protected	See coding			20101227	BEGIN OF ty_s_sequence, table_index TYPE i, lo_element TYPE REF TO if_wd_context_element, node_index TYPE i, END OF ty_s_sequence
2	TY_T_SEQUENCE	Protected	See coding			20101227	ty_t_sequence TYPE TABLE OF ty_s_sequence WITH KEY table_index

Method Signatures

Method ADAPT_ELEMENT_INDEX Signature

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

Method ADAPT_ELEMENT_INDEX on class CL_FPM_HCT_TOOLBAR_ASSIST has no exception.

Method ADD_BC_GAF_MAIN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_ADDED_ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_ELEMENT		Web Dynpro: Interface for Node Element	20100528
2	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	STRING			20100528
3	Importing	IV_MAINSTEP_ID	Call by reference	☑	Type reference (TYPE)	STRING			20100528
4	Importing	IV_SHOW_SUBSTEP_VARIANT	Call by reference	☑	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20110228
5	Importing	IV_SUBSTEP_ID	Call by reference	☑	Type reference (TYPE)	STRING			20100528
6	Importing	IV_SUBVARIANT_ID	Call by reference	☑	Type reference (TYPE)	STRING			20100528

Method ADD_BC_GAF_MAIN on class CL_FPM_HCT_TOOLBAR_ASSIST has no exception.

Method ADD_BC_INIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_ADDED_ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_ELEMENT		Web Dynpro: Interface for Node Element	20100528
2	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	STRING			20100528

Method ADD_BC_INIT on class CL_FPM_HCT_TOOLBAR_ASSIST has no exception.

Method ADD_BC_OIF_MAIN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_ADDED_ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_ELEMENT		Web Dynpro: Interface for Node Element	20100528
2	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	STRING			20100528

Method ADD_BC_OIF_MAIN on class CL_FPM_HCT_TOOLBAR_ASSIST has no exception.

Method ADD_BTN_GAF_MAIN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_ADDED_ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_ELEMENT		Web Dynpro: Interface for Node Element	20100528
2	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	STRING			20100528
3	Importing	IV_MAINSTEP_ID	Call by reference	☑	Type reference (TYPE)	STRING			20100528
4	Importing	IV_SHOW_SUBSTEP_VARIANT	Call by reference	☑	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20110228
5	Importing	IV_SUBSTEP_ID	Call by reference	☑	Type reference (TYPE)	STRING			20100528
6	Importing	IV_SUBVARIANT_ID	Call by reference	☑	Type reference (TYPE)	STRING			20100528

Method ADD_BTN_GAF_MAIN on class CL_FPM_HCT_TOOLBAR_ASSIST has no exception.

Method ADD_BTN_INIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_ADDED_ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_ELEMENT		Web Dynpro: Interface for Node Element	20100528
2	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	STRING			20100528

Method ADD_BTN_INIT on class CL_FPM_HCT_TOOLBAR_ASSIST has no exception.

Method ADD_BTN_OIF_MAIN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_ADDED_ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_ELEMENT		Web Dynpro: Interface for Node Element	20100528
2	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	STRING			20100528

Method ADD_BTN_OIF_MAIN on class CL_FPM_HCT_TOOLBAR_ASSIST has no exception.

Method ADD_ELEMENT_INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_ELEMENT		Web Dynpro: Interface for Node Element	20101227
2	Importing	IV_INDEX_NEW	Call by reference	☑	Type reference (TYPE)	I			20101227

Method ADD_ELEMENT_INDEX on class CL_FPM_HCT_TOOLBAR_ASSIST has no exception.

Method ADD_LINK_GAF_MAIN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_ADDED_ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_ELEMENT		Web Dynpro: Interface for Node Element	20100528
2	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	STRING			20100528
3	Importing	IV_MAINSTEP_ID	Call by reference	☑	Type reference (TYPE)	STRING			20100528
4	Importing	IV_SHOW_SUBSTEP_VARIANT	Call by reference	☑	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20110228
5	Importing	IV_SUBSTEP_ID	Call by reference	☑	Type reference (TYPE)	STRING			20100528
6	Importing	IV_SUBVARIANT_ID	Call by reference	☑	Type reference (TYPE)	STRING			20100528

Method ADD_LINK_GAF_MAIN on class CL_FPM_HCT_TOOLBAR_ASSIST has no exception.

Method ADD_LINK_INIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_ADDED_ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_ELEMENT		Web Dynpro: Interface for Node Element	20100528
2	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	STRING			20100528

Method ADD_LINK_INIT on class CL_FPM_HCT_TOOLBAR_ASSIST has no exception.

Method ADD_LINK_OIF_MAIN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_ADDED_ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_ELEMENT		Web Dynpro: Interface for Node Element	20100528
2	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	STRING			20100528

Method ADD_LINK_OIF_MAIN on class CL_FPM_HCT_TOOLBAR_ASSIST has no exception.

Method CHANGE_ELEMENT_INDEX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_ELEMENT		Web Dynpro: Interface for Node Element	20101227
2	Importing	IV_INDEX_NEW	Call by reference	☐	Type reference (TYPE)	I			20101227

Method CHANGE_ELEMENT_INDEX on class CL_FPM_HCT_TOOLBAR_ASSIST has no exception.

Method CHECK_HOTKEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_INVALID	Call by reference	☐	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20100610
2	Importing	IO_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE		Web Dynpro: Interface for Context Nodes	20100610
3	Importing	IV_HOTKEY	Call by reference	☐	Type reference (TYPE)	FPM_HOTKEY		UI-Element Hotkey	20100610

Method CHECK_HOTKEY on class CL_FPM_HCT_TOOLBAR_ASSIST has no exception.

Method DROP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EO_ADDED_ELEMENT	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_ELEMENT		Web Dynpro: Interface for Node Element	20110225
2	Exporting	ET_ADDED_ELEMENT	Call by reference	☐	Type reference (TYPE)	WDR_CONTEXT_ELEMENT_SET		Web Dynpro: Number of Context Node Elements	20110225
3	Importing	IO_CONTEXT_REPOSITORY	Call by reference	☑	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE		Web Dynpro: Interface for Context Nodes	20110225
4	Importing	IO_DROP_INFO	Call by reference	☐	Object reference (TYPE REF TO)	CL_WD_CUSTOM_EVENT		Application-Defined Event	20110225
5	Importing	IO_ROW_ELEMENT	Call by reference	☑	Object reference (TYPE REF TO)	IF_WD_CONTEXT_ELEMENT		Web Dynpro: Interface for Node Element	20110324
6	Importing	IV_DRAG_SOURCE	Call by reference	☑	Type reference (TYPE)	STRING			20110225
7	Importing	IV_MAINSTEP	Call by reference	☑	Type reference (TYPE)	STRING			20110225
8	Importing	IV_SCHEMA	Call by reference	☐	Type reference (TYPE)	TY_SCHEMA	CS_SCHEMA-OBJECTS		20110225
9	Importing	IV_SHOW_SUBSTEP_VARIANT	Call by reference	☑	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20110301
10	Importing	IV_SUBSTEP	Call by reference	☑	Type reference (TYPE)	STRING			20110225
11	Importing	IV_SUBVARIANT_ID	Call by reference	☑	Type reference (TYPE)	STRING			20110228

Method DROP on class CL_FPM_HCT_TOOLBAR_ASSIST has no exception.

Method GET_REP_TOOLBAR_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_REPOSITORY_TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20100527
2	Returning	RO_REP_TOOLBAR	Value transfer	☐	Object reference (TYPE REF TO)	IF_FPM_HCT_REPOSITORY		Repository	20100527

Method GET_REP_TOOLBAR_INSTANCE on class CL_FPM_HCT_TOOLBAR_ASSIST has no exception.

Method HANDLE_ACTION_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_NEW_ACTION_ID	Call by reference	☐	Type reference (TYPE)	FPM_ACTION_ID		ID of the FPM Event	20100526
2	Importing	IO_ND_ACTION	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE		Web Dynpro: Interface for Context Nodes	20100526
3	Importing	IV_ACTION_ID	Call by reference	☑	Type reference (TYPE)	FPM_ACTION_ID		ID of the FPM Event	20100526
4	Importing	IV_ACTION_TYPE	Call by reference	☑	Type reference (TYPE)	FPM_ACTION_TYPE		FPM: Defines the FPM Event Action Type	20100526
5	Importing	IV_EVENT_ID	Call by reference	☐	Type reference (TYPE)	FPM_EVENT_ID		ID of the FPM Event	20100526

Method HANDLE_ACTION_ID on class CL_FPM_HCT_TOOLBAR_ASSIST has no exception.

Method SET_DEFAULT_ITEM_VALUE_SET 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	20120515
2	Importing	IT_ELEMENTS	Call by reference	☑	Type reference (TYPE)	WDR_CONTEXT_ELEMENT_SET		Web Dynpro: Number of Context Node Elements	20120515

Method SET_DEFAULT_ITEM_VALUE_SET on class CL_FPM_HCT_TOOLBAR_ASSIST has no exception.

Method SORT_OTHER_FUNCTIONS Signature

Method SORT_OTHER_FUNCTIONS on class CL_FPM_HCT_TOOLBAR_ASSIST has no parameter.
Method SORT_OTHER_FUNCTIONS on class CL_FPM_HCT_TOOLBAR_ASSIST has no exception.

Method UPDATE_ITEMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_IS_CHANGED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20120522
2	Importing	IO_ND_ACTION	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE		Web Dynpro: Interface for Context Nodes	20120522
3	Importing	IO_ND_GLOBAL	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE		Web Dynpro: Interface for Context Nodes	20120522
4	Importing	IO_ND_LOCAL	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE		Web Dynpro: Interface for Context Nodes	20120522

Method UPDATE_ITEMS on class CL_FPM_HCT_TOOLBAR_ASSIST has no exception.

Method UPDATE_PARAMETERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_IS_CHANGED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20120618
2	Importing	IO_EL_ACTION	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_ELEMENT		Web Dynpro: Interface for Node Element	20120201

Method UPDATE_PARAMETERS on class CL_FPM_HCT_TOOLBAR_ASSIST has no exception.

History

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