SAP ABAP Class CL_ADT_GUI_EVENT_DISPATCHER (Event dispatcher for abap in eclipse)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DWB-AIE (Application Component) Installation and Infrastructure for ABAP Tools in Eclipse
     ⤷ SADT_GUI_INTEGRATION (Package) Integration of Eclipse with native GUI

Properties

Class	CL_ADT_GUI_EVENT_DISPATCHER
Short Description	Event dispatcher for abap in eclipse
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SADT_GUI_INTEGRATION	Integration of Eclipse with native GUI
Created	20090422	SAP
Last change	20130531	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)

Interfaces

Class CL_ADT_GUI_EVENT_DISPATCHER has no interface implemented.

Friends

Class CL_ADT_GUI_EVENT_DISPATCHER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CLIENT_COMMUNICATION	Static Attribute	Private	☐	Object reference (TYPE REF TO)	LIF_CLIENT_COMMUNICATION			20110822
2	C_ADT_DISABLED	Constant	Private	☐	Type reference (TYPE)	C	ABAP_FALSE		20090626
3	C_ADT_ECLIPSE_PROJECT	Constant	Private	☐	Type reference (TYPE)	SADT_PROP_STRING	'ECLIPSE_PROJECT'	Eclipse project	20100316
4	C_ADT_ENABLED	Constant	Private	☐	Type reference (TYPE)	C	ABAP_TRUE		20090626
5	C_ADT_GUI_EVENT_PROP_TRANS	Constant	Public	☐	Type reference (TYPE)	STRING	'SADT_GUI_EVENT_PROP_TRANS'		20110805
6	C_COMMAND_ID	Constant	Public	☐	Type reference (TYPE)	SADT_PROP_STRING	'COMMAND_ID'	Event properties: command name	20090511
7	C_COMMAND_WB_FINISHED	Constant	Private	☐	Type reference (TYPE)	STRING	'WB_FINISHED'		20120130
8	C_COMMAND_WB_NAVIGATE	Constant	Private	☐	Type reference (TYPE)	STRING	'WB_NAVIGATE'		20100507
9	C_COMMAND_WB_REFRESH	Constant	Private	☐	Type reference (TYPE)	STRING	'WB_EXPLORER_REFRESH'		20100518
10	C_COMMAND_WB_REQUEST_FINISHED	Constant	Private	☐	Type reference (TYPE)	STRING	'WB_REQUEST_FINISHED'		20100521
11	C_EDITOR_GUID_ID	Constant	Public	☐	Type reference (TYPE)	SADT_PROP_STRING	'EDITOR_GUID'		20100723
12	C_EDITOR_GUID_PARAMETER	Constant	Public	☐	See coding		'SADT_EDITOR_GUID'		20100723
13	C_EXTERNAL_EVENT	Constant	Public	☐	Type reference (TYPE)	STRING	'EXTERNAL_EVENT'		20121126
14	C_GUI_TYPE_HTML	Constant	Public	☐	Type reference (TYPE)	I	3		20110822
15	C_GUI_TYPE_JAVA	Constant	Public	☐	Type reference (TYPE)	I	2		20110822
16	C_GUI_TYPE_NONE	Constant	Public	☐	Type reference (TYPE)	I	0		20110822
17	C_GUI_TYPE_WIN	Constant	Public	☐	Type reference (TYPE)	I	1		20110822
18	C_MEM_ID_SADT_START	Constant	Private	☐	See coding		'SADT_JAVA_GUI_START'		20090422
19	C_OBJECT_CATEGORY	Constant	Public	☐	Type reference (TYPE)	SADT_PROP_STRING	'OBJECT_CATEGORY'		20100519
20	C_OBJECT_DISPLAY_NAME	Constant	Public	☐	Type reference (TYPE)	SADT_PROP_STRING	'OBJECT_DISPLAY_NAME'		20100510
21	C_OBJECT_NAME	Constant	Public	☐	Type reference (TYPE)	SADT_PROP_STRING	'OBJECT_NAME'	Object name	20090512
22	C_OBJECT_TYPE	Constant	Public	☐	Type reference (TYPE)	SADT_PROP_STRING	'OBJECT_TYPE'	Object type	20090512
23	C_OPERATION	Constant	Private	☐	Type reference (TYPE)	STRING	'OPERATION'	Workbench operation	20090609
24	C_PACKAGE	Constant	Public	☐	Type reference (TYPE)	SADT_PROP_STRING	'PACKAGE'		20100519
25	C_PACKAGE_URL	Constant	Public	☐	Type reference (TYPE)	SADT_PROP_STRING	'PACKAGE_URL'		20110823
26	C_RESOURCE_URL	Constant	Public	☐	Type reference (TYPE)	SADT_PROP_STRING	'RESOURCE_URL'	Resource url	20090512
27	C_TEST_EVENT	Constant	Public	☐	Type reference (TYPE)	STRING	'TEST_EVENT'		20101108
28	C_TEST_VALUE	Constant	Public	☐	Type reference (TYPE)	SADT_PROP_STRING	'TEST_VALUE'		20101108
29	C_WB_ACTION	Constant	Public	☐	Type reference (TYPE)	SADT_PROP_STRING	'WB_ACTION'		20100510
30	IGNORE_GUI_CHECK	Static Attribute	Protected	☐	Type reference (TYPE)	BOOLEAN	SPACE		20100723
31	S_GUI_TYPE	Static Attribute	Private	☐	Type reference (TYPE)	I	C_GUI_TYPE_NONE		20110822

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_DEFAULT_EVENT_PROPERTIES	Static method	Private	Method		20121127
2	ADD_EVENT_PROPERTIES_FROM_TAB	Static method	Private	Method		20121126
3	CLASS_CONSTRUCTOR	Static method	Public	Constructor		20110822
4	DISABLE_ADT_ENVIRONMENT	Static method	Public	Method		20090626
5	ENABLE_ADT_ENVIRONMENT	Static method	Public	Method		20090626
6	FINISHED_ADT_WB_REQUEST	Static method	Public	Method		20100521
7	GET_ADT_ENVIRONMENT_FLAG	Static method	Private	Method	Gets the global flag for the ADT environment	20090513
8	GET_CLIENT_COMMUNICATION	Static method	Private	Method		20110615
9	GET_ECLIPSE_PROJECT	Static method	Public	Method	Gets the eclipse project	20100316
10	GET_GUI_TYPE	Static method	Public	Method		20110822
11	GET_GUI_TYPE_INT	Static method	Private	Method		20110822
12	IS_ADT_ENVIRONMENT	Static method	Public	Method	Checks if the gui is running in eclipse	20090422
13	IS_ADT_TOOL_AVAILABLE	Static method	Public	Method	Checks if an ADT implementation of a workbench tool exists	20090511
14	IS_SUPPORTED_OPERATION	Static method	Private	Method		20100726
15	OPEN_ADT_EDITOR	Static method	Public	Method	Open an eclipse editor	20090512
16	REFRESH_ADT_TREE	Static method	Public	Method	Sent if the repository tree structure changes	20100518
17	SEND_EVENT_FROM_PROPERTIES_TAB	Static method	Private	Method		20121126
18	SEND_EVENT_TO_GUI	Static method	Private	Method		20090422
19	SEND_EXTERNAL_EVENT	Static method	Public	Method		20121126
20	SEND_TEST_EVENT	Static method	Public	Method		20101108
21	SET_ADT_ENVIRONMENT	Static method	Private	Method		20090626
22	SET_ECLIPSE_PROJECT	Static method	Public	Method	Sets the eclipse project	20100316
23	UPDATE_ADT_EDITOR_TITLE	Static method	Public	Method		20100507
24	WB_FINISHED	Static method	Public	Method		20120130
25	WB_OBJECT_DELETED	Static method	Public	Event handling method		20100719

Events

Class CL_ADT_GUI_EVENT_DISPATCHER has no event.

Types

Class CL_ADT_GUI_EVENT_DISPATCHER has no local type.

Method Signatures

Method ADD_DEFAULT_EVENT_PROPERTIES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_EVENT_PROPERTIES	Call by reference	☐	Object reference (TYPE REF TO)	LCL_EVENT_PROPS			20121127

Method ADD_DEFAULT_EVENT_PROPERTIES on class CL_ADT_GUI_EVENT_DISPATCHER has no exception.

Method ADD_EVENT_PROPERTIES_FROM_TAB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EVENT_PROPERTIES	Call by reference	☐	Type reference (TYPE)	SADT_EVENT_PROP_TABLE			20121126
2	Changing	PROPS	Call by reference	☐	Object reference (TYPE REF TO)	LCL_EVENT_PROPS			20121126

Method ADD_EVENT_PROPERTIES_FROM_TAB on class CL_ADT_GUI_EVENT_DISPATCHER has no exception.

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_ADT_GUI_EVENT_DISPATCHER has no parameter.
Method CLASS_CONSTRUCTOR on class CL_ADT_GUI_EVENT_DISPATCHER has no exception.

Method DISABLE_ADT_ENVIRONMENT Signature

Method DISABLE_ADT_ENVIRONMENT on class CL_ADT_GUI_EVENT_DISPATCHER has no parameter.
Method DISABLE_ADT_ENVIRONMENT on class CL_ADT_GUI_EVENT_DISPATCHER has no exception.

Method ENABLE_ADT_ENVIRONMENT Signature

Method ENABLE_ADT_ENVIRONMENT on class CL_ADT_GUI_EVENT_DISPATCHER has no parameter.
Method ENABLE_ADT_ENVIRONMENT on class CL_ADT_GUI_EVENT_DISPATCHER has no exception.

Method FINISHED_ADT_WB_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	WB_REQUEST	Call by reference	☐	Object reference (TYPE REF TO)	CL_WB_REQUEST			20100521

#	Exception	Resumable	Description	Created on
1	CX_ADT_GUI_EVENT_ERROR	☐		20100521

Method GET_ADT_ENVIRONMENT_FLAG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20090513

Method GET_ADT_ENVIRONMENT_FLAG on class CL_ADT_GUI_EVENT_DISPATCHER has no exception.

Method GET_CLIENT_COMMUNICATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Object reference (TYPE REF TO)	LIF_CLIENT_COMMUNICATION			20110615

Method GET_CLIENT_COMMUNICATION on class CL_ADT_GUI_EVENT_DISPATCHER has no exception.

Method GET_ECLIPSE_PROJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	SADT_PROP_STRING		Generic property key/value type bla	20100316

Method GET_ECLIPSE_PROJECT on class CL_ADT_GUI_EVENT_DISPATCHER has no exception.

Method GET_GUI_TYPE Signature

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

Method GET_GUI_TYPE on class CL_ADT_GUI_EVENT_DISPATCHER has no exception.

Method GET_GUI_TYPE_INT Signature

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

Method GET_GUI_TYPE_INT on class CL_ADT_GUI_EVENT_DISPATCHER has no exception.

Method IS_ADT_ENVIRONMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20090422

Method IS_ADT_ENVIRONMENT on class CL_ADT_GUI_EVENT_DISPATCHER has no exception.

Method IS_ADT_TOOL_AVAILABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ADT_TOOL_AVAILABLE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Boolean Variable (X=True, -=False, Space=Unknown)	20090619
2	Importing	OPERATION	Call by reference	☐	Type reference (TYPE)	SEU_ACTION	'DISPEDIT'	WB Request: Operation in the Development Environment	20090609
3	Importing	WB_OBJECT_NAME	Call by reference	☐	Type reference (TYPE)	SEU_OBJKEY		WB Request: Key for Object in Development Environment	20090619
4	Importing	WB_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	SEU_OBJTYP		Workbench type	20090527
5	Changing	WB_REQUEST	Call by reference	☑	Object reference (TYPE REF TO)	CL_WB_REQUEST			20091028
6	Importing	WB_REQUEST_TRACE	Call by reference	☑	Type reference (TYPE)	WB_REQUEST_LIST			20100720

Method IS_ADT_TOOL_AVAILABLE on class CL_ADT_GUI_EVENT_DISPATCHER has no exception.

Method IS_SUPPORTED_OPERATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	OPERATION	Call by reference	☐	Type reference (TYPE)	SEU_ACTION			20100726
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	BOOLEAN			20100726

Method IS_SUPPORTED_OPERATION on class CL_ADT_GUI_EVENT_DISPATCHER has no exception.

Method OPEN_ADT_EDITOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	OBJECT_NAME	Call by reference	☐	Type reference (TYPE)	SEU_OBJKEY		Name of the object	20090512
2	Importing	OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	SEU_OBJTYP		Type of the object	20090512
3	Importing	OPERATION	Call by reference	☐	Type reference (TYPE)	SEU_ACTION	'WB_DISPLAY'		20100510
4	Importing	WB_REQUEST	Call by reference	☑	Object reference (TYPE REF TO)	CL_WB_REQUEST			20091028

#	Exception	Resumable	Description	Created on
1	CX_ADT_GUI_EVENT_ERROR	☐	Error when sending an event via the gui	20090527

Method REFRESH_ADT_TREE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	OBJECT_NAME	Call by reference	☐	Type reference (TYPE)	SEU_OBJKEY	SPACE		20100519
2	Importing	OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	SEU_OBJTYP	SPACE	WB Request: Type of Object of Development Environment	20100519
3	Importing	PACKAGE	Call by reference	☐	Type reference (TYPE)	TADIR-DEVCLASS	SPACE		20100519

#	Exception	Resumable	Description	Created on
1	CX_ADT_GUI_EVENT_ERROR	☐		20100518

Method SEND_EVENT_FROM_PROPERTIES_TAB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EVENT_PROPERTIES	Call by reference	☐	Type reference (TYPE)	SADT_EVENT_PROP_TABLE			20121126
2	Changing	PROPS	Call by reference	☐	Object reference (TYPE REF TO)	LCL_EVENT_PROPS			20121126

#	Exception	Resumable	Description	Created on
1	CX_ADT_GUI_EVENT_ERROR	☐		20121126

Method SEND_EVENT_TO_GUI Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EVENT_PROPERTIES	Call by reference	☐	Object reference (TYPE REF TO)	LCL_EVENT_PROPS			20090422

#	Exception	Resumable	Description	Created on
1	CX_ADT_GUI_EVENT_ERROR	☐		20090525

Method SEND_EXTERNAL_EVENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	APPLICATION	Call by reference	☐	Type reference (TYPE)	CL_ADT_GUI_EVNT_DISPATCHER_API=>TY_APPLICATION			20121127
2	Importing	EVENT_PROPERTIES	Call by reference	☐	Type reference (TYPE)	SADT_EVENT_PROP_TABLE			20121126

#	Exception	Resumable	Description	Created on
1	CX_ADT_GUI_EVENT_ERROR	☐		20121126

Method SEND_TEST_EVENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EVENT_PROPERTIES	Call by reference	☑	Type reference (TYPE)	SADT_EVENT_PROP_TABLE			20101108
2	Importing	VALUE	Call by reference	☑	Type reference (TYPE)	STRING			20101108

#	Exception	Resumable	Description	Created on
1	CX_ADT_GUI_EVENT_ERROR	☐		20101108

Method SET_ADT_ENVIRONMENT Signature

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

Method SET_ADT_ENVIRONMENT on class CL_ADT_GUI_EVENT_DISPATCHER has no exception.

Method SET_ECLIPSE_PROJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ECLIPSE_PROJECT	Call by reference	☐	Type reference (TYPE)	SADT_PROP_STRING		Generic property key/value type bla	20100316

Method SET_ECLIPSE_PROJECT on class CL_ADT_GUI_EVENT_DISPATCHER has no exception.

Method UPDATE_ADT_EDITOR_TITLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	OBJECT_NAME	Call by reference	☐	Type reference (TYPE)	SEU_OBJKEY			20100507
2	Importing	OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	SEU_OBJTYP			20100507
3	Importing	WB_REQUEST	Call by reference	☑	Object reference (TYPE REF TO)	CL_WB_REQUEST			20100507

#	Exception	Resumable	Description	Created on
1	CX_ADT_GUI_EVENT_ERROR	☐		20100507

Method WB_FINISHED Signature

Method WB_FINISHED on class CL_ADT_GUI_EVENT_DISPATCHER has no parameter.
Method WB_FINISHED on class CL_ADT_GUI_EVENT_DISPATCHER has no exception.

Method WB_OBJECT_DELETED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_OBJECT_NAME	Value transfer	☐	Attribute reference (LIKE)				20100719
2	Importing	P_OBJECT_TYPE	Value transfer	☐	Attribute reference (LIKE)				20100719

Method WB_OBJECT_DELETED on class CL_ADT_GUI_EVENT_DISPATCHER has no exception.

History

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