SAP ABAP Class CL_GUI_TOOLBAR (Toolbar Control)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-FES-CTL (Application Component) SAP GUI for Windows Controls
     ⤷ SAPTOOLBAR (Package) SAP Toolbar Control

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_GUI_CONTROL	Proxy Class for Control in GUI	00000000

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	/TDAG/CPCL_GUI_TOOLBAR	CP: Kapselung der GUI-Toolbar	20050902
2	Inheritance (c INHERITING FROM c_ref)	CL_DBA_GUI_SYSTEMS_TB	DBA Cockpit: System Landscape Toolbar	20050622
3	Inheritance (c INHERITING FROM c_ref)	CL_GUI_RU_ALV_TOOLBAR	ALV UI Component Toolbar	20090118
4	Inheritance (c INHERITING FROM c_ref)	CL_ISHMED_DWS_TOOLBAR	i.s.h.med DWS: Toolbar Control	20041201
5	Inheritance (c INHERITING FROM c_ref)	CL_ISHMED_PMD_TB_STANDARD	PMD: Standard Buttons (Toolbar)	20040722
6	Inheritance (c INHERITING FROM c_ref)	CL_MP_WIZARD_TOOLBAR	MP Wizard Toolbar	20020827
7	Inheritance (c INHERITING FROM c_ref)	CL_OIJ_BPB_ITM_TB	Berth Planning Board main toolbar	20050222

Properties

Class	CL_GUI_TOOLBAR
Short Description	Toolbar Control
Super Class	CL_GUI_CONTROL	Proxy Class for Control in GUI
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SAPTOOLBAR	SAP Toolbar Control
Created	19981125	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☐
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CNTB	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	CNTL	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_GUI_TOOLBAR has no interface implemented.

Friends

Class CL_GUI_TOOLBAR has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	M_CHECKED	Instance attribute	Private	☐	Type reference (TYPE)	I	1	Button state	19990316
2	M_ENABLED	Instance attribute	Private	☐	Type reference (TYPE)	I	1	Button state	19990316
3	M_FCODE	Instance attribute	Private	☐	Type reference (TYPE)	UI_FUNC		Function Code	19981125
4	M_ID_DROPDOWN_CLICKED	Constant	Public	☐	Type reference (TYPE)	I	2	Event ID	19990112
5	M_ID_DROPMENU_CLICKED	Instance attribute	Public	☐	Type reference (TYPE)	I	3	Event ID	19990113
6	M_ID_FUNCTION_SELECTED	Constant	Public	☐	Type reference (TYPE)	I	1	Event ID	19990113
7	M_MODE_HORIZONTAL	Constant	Public	☐	Type reference (TYPE)	I	0	Horizontal Display	19991105
8	M_MODE_VERTICAL	Constant	Public	☐	Type reference (TYPE)	I	1	Horizontal Display	19991105
9	M_POSX	Instance attribute	Private	☐	Type reference (TYPE)	I		Coordinate X	19981125
10	M_POSY	Instance attribute	Private	☐	Type reference (TYPE)	I		Coordinate Y	19981125
11	M_RESULT	Instance attribute	Public	☐	Type reference (TYPE)	I		Return Value	19990113
12	M_SEPARATOR_ID	Instance attribute	Private	☐	Type reference (TYPE)	CNTB_UNIQUE_ID	0	Separator ID	19991014
13	M_TABLE_BUTTON	Instance attribute	Public	☑	Type reference (TYPE)	TTB_BUTTON		Assignment of Pushbuttons	19991014
14	M_TABLE_CTXMENU	Instance attribute	Public	☑	Type reference (TYPE)	TTB_BTNMNU		Assignment of Static Context Menu	19991014
15	M_VERSION	Instance attribute	Public	☐	Type reference (TYPE)	I	0	Version number	19991105
16	M_VISIBLE	Instance attribute	Private	☐	Type reference (TYPE)	I	1	Visibility	20000706
17	M_WRAPABLE	Instance attribute	Private	☐	Type reference (TYPE)	I	1	Style	19990923

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_BUTTON	Instance method	Public	Method	Adds a New Pushbutton	19981125
2	ADD_BUTTON_GROUP	Instance method	Public	Method	Adds a List of Pushbuttons	19981125
3	ASSIGN_STATIC_CTXMENU_TABLE	Instance method	Public	Method	Sets the Static Context Menus for Several Pushbuttons	19991014
4	CHECK_UNIQUE_FCODE	Instance method	Private	Method	Checks if an F Code is Already Available in m_table_button	19991014
5	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	19981125
6	DELETE_ALL_BUTTONS	Instance method	Public	Method	Deletes all Pushbuttons	19981125
7	DELETE_BUTTON	Instance method	Public	Method	Deletes a Pushbutton	19990119
8	FILL_BUTTONS_DATA_TABLE	Static method	Public	Method	Fills the Table for Creating Several Pushbuttons	19981125
9	ON_CTXMENU_CHANGED	Instance method	Private	Event handling method	Event Handler for Context Menu	19991015
10	SET_BUTTON_INFO	Instance method	Public	Method	Sets the Information for Changing Icon, Text or Tooltip	19990702
11	SET_BUTTON_STATE	Instance method	Public	Method	Sets the State of a Single Pushbutton	19990119
12	SET_BUTTON_VISIBLE	Instance method	Public	Method	Sets the State of a Single Pushbutton	20000706
13	SET_STATIC_CTXMENU	Instance method	Public	Method	Sets the Static Context Menu for a Pushbutton	19991014
14	SET_WEBGUI_MENU_LOCAL_RELOAD	Instance method	Public	Method	WEBGUI: Dynamic Menu Loaded Locally	20010517
15	TRACK_CONTEXT_MENU	Instance method	Public	Method	Displays a Context Menu	19990114
16	UPDATE_TABLE_BUTTON	Instance method	Private	Method	Updates the Configuration Table of the Pushbuttons	19991014
17	UPDATE_TABLE_CTXMENU	Instance method	Private	Method	Updates the Table of the Static Context Menu	19991014

Events

#	Event	Type	Visibility	Description	Created on
1	DROPDOWN_CLICKED	Instance Event (0)	Public (2)	if a Dropdown or Menu Pushbutton is Clicked	19990113
2	FUNCTION_SELECTED	Instance Event (0)	Public (2)	if a Pushbutton or a Menu Entry is Selected	19990113

Types

Class CL_GUI_TOOLBAR has no local type.

Method Signatures

Method ADD_BUTTON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	BUTN_TYPE	Call by reference	☐	Type reference (TYPE)	TB_BTYPE		button types defined in CNTB	19990108
2	Importing	FCODE	Call by reference	☐	Type reference (TYPE)	UI_FUNC		fcode associated to a button	19981125
3	Importing	ICON	Call by reference	☐	Type reference (TYPE)	C		icon name defined like '@0a@'	19981125
4	Importing	IS_CHECKED	Call by reference	☑	Type reference (TYPE)	C		button pressed	19990112
5	Importing	IS_DISABLED	Call by reference	☑	Type reference (TYPE)	C		state of button	19990112
6	Importing	QUICKINFO	Call by reference	☑	Type reference (TYPE)	ICONQUICK		text describing the purpose of a button	19990108
7	Importing	TEXT	Call by reference	☑	Type reference (TYPE)	TEXT40		text shown in the right of the image	19981125

#	Exception	Resumable	Description	Created on
1	CNTB_BTYPE_ERROR	☐	Flasche Button Typ	19990217
2	CNTB_ERROR_FCODE	☐	FCode ist nicht eindeutig	19991014
3	CNTL_ERROR	☐	Fehler in CFW Aufruf	19981125

Method ADD_BUTTON_GROUP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DATA_TABLE	Call by reference	☐	Type reference (TYPE)	TTB_BUTTON		buttons data table	19981125

#	Exception	Resumable	Description	Created on
1	CNTB_ERROR_FCODE	☐	Falsche FCode	19991014
2	DP_ERROR	☐	Fehler in DP Aufruf	19981125

Method ASSIGN_STATIC_CTXMENU_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	TABLE_CTXMENU	Call by reference	☐	Type reference (TYPE)	TTB_BTNMNU		statische Kontextmenü	19991014

#	Exception	Resumable	Description	Created on
1	CNTB_ERROR_PARAMETER	☐	Falsche FCode	19991014
2	CNTL_ERROR	☐	Fehler in CFW Aufruf	19991014
3	DP_ERROR	☐	Fehler in DP Aufruf	19991014

Method CHECK_UNIQUE_FCODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FCODE	Call by reference	☐	Type reference (TYPE)	UI_FUNC		FCode	19991014

#	Exception	Resumable	Description	Created on
1	CNTB_ERROR_FCODE_NONUNIQUE	☐	wenn die zu prüfende FCode in m_button vorhanden ist	19991014

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DISPLAY_MODE	Value transfer	☐	Type reference (TYPE)	I	M_MODE_HORIZONTAL	Anzeigenmodus	19991105
2	Importing	LIFETIME	Value transfer	☑	Type reference (TYPE)	I		Lifetime	19990125
3	Importing	NAME	Value transfer	☑	Type reference (TYPE)	STRING		Name	20000114
4	Importing	PARENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Name des Containers	19981214
5	Importing	SHELLSTYLE	Value transfer	☑	Type reference (TYPE)	I		Shell Style	19981214

#	Exception	Resumable	Description	Created on
1	CNTB_WRONG_VERSION	☐	Falsche SAPCALEN.OCX Version	19991105
2	CNTL_ERROR	☐	Fehler in CFW Aufruf	19981125
3	CNTL_INSTALL_ERROR	☐	control installation error	19981125

Method DELETE_ALL_BUTTONS Signature

Method DELETE_ALL_BUTTONS on class CL_GUI_TOOLBAR has no parameter.

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	general control error	19981125

Method DELETE_BUTTON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FCODE	Call by reference	☐	Type reference (TYPE)	UI_FUNC		FCode associated to the button	19990119

#	Exception	Resumable	Description	Created on
1	CNTB_ERROR_FCODE	☐	Falsche FCode	19991014
2	CNTL_ERROR	☐	error in call method	19990119

Method FILL_BUTTONS_DATA_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	BUTN_TYPE	Call by reference	☐	Type reference (TYPE)	TB_BTYPE		Style	19990113
2	Importing	CHECKED	Call by reference	☑	Type reference (TYPE)	C		button pressed	19990113
3	Changing	DATA_TABLE	Call by reference	☐	Type reference (TYPE)	TTB_BUTTON		button data table	19981125
4	Importing	DISABLED	Call by reference	☑	Type reference (TYPE)	C		State	19990113
5	Importing	FCODE	Call by reference	☐	Type reference (TYPE)	UI_FUNC		FCode	19981125
6	Importing	ICON	Call by reference	☐	Type reference (TYPE)	C		Icon	19981125
7	Importing	QUICKINFO	Call by reference	☑	Type reference (TYPE)	ICONQUICK		Tip	19990113
8	Importing	TEXT	Call by reference	☑	Type reference (TYPE)	TEXT40		Text	19981125

#	Exception	Resumable	Description	Created on
1	CNTB_BTYPE_ERROR	☐	wrong button error	19990217

Method ON_CTXMENU_CHANGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	SENDER	Call by reference	☐	Type reference (TYPE)				19991022

Method ON_CTXMENU_CHANGED on class CL_GUI_TOOLBAR has no exception.

Method SET_BUTTON_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FCODE	Call by reference	☐	Type reference (TYPE)	UI_FUNC		fcode associated to a button	19990702
2	Importing	ICON	Call by reference	☑	Type reference (TYPE)	ICONNAME		icon name defined like '@0a@'	19990702
3	Importing	QUICKINFO	Call by reference	☑	Type reference (TYPE)	ICONQUICK		text describing the purpose of a button	19990702
4	Importing	TEXT	Call by reference	☑	Type reference (TYPE)	TEXT40		text shown in the right of the image	19990702

#	Exception	Resumable	Description	Created on
1	CNTB_ERROR_FCODE	☐	Fasche FCode	19991014
2	CNTL_ERROR	☐	general control error	19990702

Method SET_BUTTON_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CHECKED	Value transfer	☑	Type reference (TYPE)	C	' '	pressed or released	19990119
2	Importing	ENABLED	Value transfer	☑	Type reference (TYPE)	C	'X'	enabled or diabled	19990119
3	Importing	FCODE	Call by reference	☐	Type reference (TYPE)	UI_FUNC		FCode associated to the button	19990119

#	Exception	Resumable	Description	Created on
1	CNTB_ERROR_FCODE	☐	FCode ist nicht vordefiniert	19991014
2	CNTL_ERROR	☐	Fehler in CFW Aufruf	19990119

Method SET_BUTTON_VISIBLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FCODE	Call by reference	☐	Type reference (TYPE)	UI_FUNC		FCode	20000706
2	Importing	VISIBLE	Value transfer	☐	Type reference (TYPE)	C	'X'	ein/ausblenden	20000706

#	Exception	Resumable	Description	Created on
1	CNTB_ERROR_FCODE	☐	FCode ist nicht vordefiniert	20000706
2	CNTL_ERROR	☐	Fehler in CFW Aufruf	20000706

Method SET_STATIC_CTXMENU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CTXMENU	Call by reference	☐	Object reference (TYPE REF TO)	CL_CTMENU		statische Kontextmenü	19991014
2	Importing	FCODE	Call by reference	☐	Type reference (TYPE)	UI_FUNC		FCode	19991014

#	Exception	Resumable	Description	Created on
1	CNTB_ERROR_PARAMETER	☐	Falsche FCode	20000809
2	CNTL_ERROR	☐	Fehler in CFW Aufruf	19991014
3	CTMENU_ERROR	☐	Fehler in CTMENU Objekt	19991014

Method SET_WEBGUI_MENU_LOCAL_RELOAD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LOCAL_RELOAD	Value transfer	☐	Type reference (TYPE)	AS4FLAG	'x'	'X': lokales Laden	20010517

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	Fehler in CFW Aufruf	20010517

Method TRACK_CONTEXT_MENU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONTEXT_MENU	Call by reference	☐	Object reference (TYPE REF TO)	CL_CTMENU		comtext menu	19990114
2	Importing	POSX	Call by reference	☐	Type reference (TYPE)	I		X coordinate	19990114
3	Importing	POSY	Call by reference	☐	Type reference (TYPE)	I		Y coordinate	19990114

#	Exception	Resumable	Description	Created on
1	CTMENU_ERROR	☐	error during processing context menu	19990114

Method UPDATE_TABLE_BUTTON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	BUTN_TYPE	Call by reference	☑	Type reference (TYPE)	TB_BTYPE		Button Typ	19991014
2	Importing	CHECKED	Call by reference	☑	Type reference (TYPE)	C		Ist die Drucktaste gedrückt?	19991014
3	Importing	DISABLED	Call by reference	☑	Type reference (TYPE)	C		Ist die Drucktaste aktiv?	19991014
4	Importing	FCODE	Call by reference	☐	Type reference (TYPE)	UI_FUNC		FCode	19991014
5	Importing	ICON	Call by reference	☑	Type reference (TYPE)	ICONNAME		Icon Name der Drucktaste	19991014
6	Importing	QUICKINFO	Call by reference	☑	Type reference (TYPE)	ICONQUICK		Tooltip	19991014
7	Importing	TEXT	Call by reference	☑	Type reference (TYPE)	TEXT40		Button Text	19991014
8	Importing	TO_DELETE	Call by reference	☐	Type reference (TYPE)	C	' '	Flag für das Löschen	19991014

Method UPDATE_TABLE_BUTTON on class CL_GUI_TOOLBAR has no exception.

Method UPDATE_TABLE_CTXMENU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CTXMENU	Call by reference	☑	Object reference (TYPE REF TO)	CL_CTMENU		Statische Kontextmenü einer Drucktaste	19991014
2	Importing	FCODE	Call by reference	☐	Type reference (TYPE)	UI_FUNC		FCode einer Drucktaste	19991014
3	Importing	TO_DELETE	Call by reference	☐	Type reference (TYPE)	C	' '	Flag für das Löschen	19991014

Method UPDATE_TABLE_CTXMENU on class CL_GUI_TOOLBAR has no exception.

Event Signatures

Event DROPDOWN_CLICKED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	FCODE	Exporting	Value transfer	☐	Type reference (TYPE)	UI_FUNC		FCode	19990113
2	POSX	Exporting	Value transfer	☐	Type reference (TYPE)	I		X coordinate	19990113
3	POSY	Exporting	Value transfer	☐	Type reference (TYPE)	I		Y coordinate	19990113

Event FUNCTION_SELECTED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	FCODE	Exporting	Value transfer	☐	Type reference (TYPE)	UI_FUNC		FCode	19990113

History

Last changed by/on	SAP	20130531
SAP Release Created in