SAP ABAP Class CL_SOTR_F4_HELP (F4 Help for OTR Texts as ALV Tree)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-OTR (Application Component) Online Text Repository
     ⤷ SOTR (Package) Online Text Repository

Properties

Class	CL_SOTR_F4_HELP
Short Description	F4 Help for OTR Texts as ALV Tree
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class	SOTR_MESS
Program status
Category	0
Package	SOTR	Online Text Repository
Created	20001108	SAP
Last change	20010622	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CL_GUI_COLUMN_TREE	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	ICON	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_SOTR_F4_HELP has no interface implemented.

Friends

Class CL_SOTR_F4_HELP has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GL_C_EXPAND_LIMIT	Instance attribute	Private	☐	Type reference (TYPE)	I	50		20001215
2	GL_R_DRAG_DROP_COPY	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_DRAGDROP		Behavior for Drag and Drop	20001220
3	GL_R_DRAG_DROP_OBJECT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_DRAGDROPOBJECT		Drag&Drop Data Object	20001220
4	GL_R_TOOLBAR	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_TOOLBAR		Toolbar Control	20001213
5	GL_R_TREE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_ALV_TREE		ALV tree control	20001212
6	GL_T_FIELDCATALOG	Instance attribute	Private	☐	Type reference (TYPE)	LVC_T_FCAT		Field Catalog for List Viewer Control	20001215
7	GL_T_SOTR_TREE	Instance attribute	Private	☐	Type reference (TYPE)	SOTR_TREES		Transfer Structure for Hierarchy Display of OTR Concepts	20001215
8	GL_T_SOTR_TREE_T	Instance attribute	Private	☐	Type reference (TYPE)	SOTR_TREES		Transfer Structure for Hierarchy Display of OTR Concepts	20001215
9	GL_V_DISPLAY_MODE	Instance attribute	Private	☐	Type reference (TYPE)	CHAR10	'PAKET'	Defines Sort Order (Poss. Entries: PACKAGE; OBJECT; ADMIN)	20001214
10	GL_V_DRAGDROP_COPY_HANDLE	Instance attribute	Private	☐	Type reference (TYPE)	INT2		2-byte integer (signed)	20001220
11	GL_V_DRAG_SUPPORTED	Instance attribute	Private	☐	Type reference (TYPE)	AS4FLAG		Indicator (X or Blank)	20001220

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_TREE_NODE	Instance method	Private	Method	Insert Group	20001215
2	ADD_TREE_TEXT	Instance method	Private	Method	Add Page	20001215
3	BUILD_OTR_FIELDCATALOG	Instance method	Private	Method	Creates Field Catalog for OTR F4 Help	20001108
4	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	20001108
5	FREE	Instance method	Public	Method	Release Resources	20001215
6	GET_SELECTED_ITEM	Instance method	Public	Method	Returns Selected Entry	20001215
7	GET_TOOLBAR_EXCLUDING	Instance method	Private	Method	Remove Standard Functions from ALV Tree	20010110
8	GET_TOOLBAR_OBJECT	Instance method	Public	Method	Supplies Toolbar Object	20010110
9	HANDLE_ITEM_CTMENU_REQUEST	Instance method	Private	Event handling method		20001212
10	HANDLE_ITEM_CTMENU_SELECTED	Instance method	Private	Event handling method		20001212
11	HANDLE_ITEM_DOUBLE_CLICK	Instance method	Private	Event handling method		20001212
12	HANDLE_NODE_CTMENU_REQUEST	Instance method	Private	Event handling method	Event Handler for Callup of Context Menu	20001212
13	HANDLE_NODE_CTMENU_SELECTED	Instance method	Private	Event handling method	Event Handler for Selection of Context Menu	20001212
14	HANDLE_NODE_DOUBLE_CLICK	Instance method	Private	Event handling method		20001212
15	MODIFY_TOOLBAR	Instance method	Private	Method	Modify ALV Tree Toolbar	20001213
16	ON_DRAG	Instance method	Private	Event handling method		20001220
17	ON_FUNCTION_SELECTED	Instance method	Private	Event handling method		20001213
18	ON_TOOLBAR_DROPDOWN	Instance method	Private	Event handling method		20001213
19	REGISTER_EVENTS	Instance method	Private	Method	Register Events	20001211
20	SELECT_ENTRY	Instance method	Public	Method	Select Entry from Tree	20010116
21	SET_FUNCTION_CODE	Instance method	Public	Method	Sets Function Code	20010113
22	UPDATE_OTR_TREE	Instance method	Public	Method	Updates OTR Tree	20001108

Events

#	Event	Type	Visibility	Description	Created on
1	DOUBLE_CLICKED	Instance Event (0)	Public (2)		20001215
2	DRAG	Instance Event (0)	Public (2)		20001220

Types

Class CL_SOTR_F4_HELP has no local type.

Method Signatures

Method ADD_TREE_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	I_NODE_KEY	Call by reference	☐	Type reference (TYPE)	LVC_NKEY		ALV-Tree-Control: Node-key	20001215
2	Importing	I_NODE_TEXT	Call by reference	☐	Type reference (TYPE)	LVC_VALUE		ALV-Control: Zelleninhalt	20001215
3	Importing	I_RELAT_KEY	Call by reference	☐	Type reference (TYPE)	LVC_NKEY		ALV-Tree-Control: Node-key	20001215

Method ADD_TREE_NODE on class CL_SOTR_F4_HELP has no exception.

Method ADD_TREE_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	I_LAST_KEY	Call by reference	☐	Type reference (TYPE)	LVC_NKEY		ALV-Tree-Control: Node-key	20001215
2	Importing	I_RELAT_KEY	Call by reference	☐	Type reference (TYPE)	LVC_NKEY		ALV-Tree-Control: Node-key	20001215
3	Importing	I_SOTR_TREE	Call by reference	☐	Type reference (TYPE)	SOTR_TREE		Übergabestruktur für hierarchische Darstellung des OTR	20001215

Method ADD_TREE_TEXT on class CL_SOTR_F4_HELP has no exception.

Method BUILD_OTR_FIELDCATALOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_FIELDCATALOG	Call by reference	☐	Type reference (TYPE)	LVC_T_FCAT		Feldkatalog für ListViewerControl	20001108
2	Importing	I_MODE	Call by reference	☐	Type reference (TYPE)	CHAR10	'PAKET'	Characterfeld der Länge 10	20001108

Method BUILD_OTR_FIELDCATALOG on class CL_SOTR_F4_HELP has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DRAG_SUPPORTED	Call by reference	☐	Type reference (TYPE)	AS4FLAG	' '	Flag (X oder Blank)	20001220
2	Importing	MODE	Call by reference	☐	Type reference (TYPE)	CHAR10		Characterfeld der Länge 10	20001108
3	Importing	PARENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Abstracter Container fuer GUI Controls	20001108

Method CONSTRUCTOR on class CL_SOTR_F4_HELP has no exception.

Method FREE Signature

Method FREE on class CL_SOTR_F4_HELP has no parameter.
Method FREE on class CL_SOTR_F4_HELP has no exception.

Method GET_SELECTED_ITEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_SOTR_TREE	Call by reference	☐	Type reference (TYPE)	SOTR_TREE		Übergabestruktur für hierarchische Darstellung des OTR	20001215

Method GET_SELECTED_ITEM on class CL_SOTR_F4_HELP has no exception.

Method GET_TOOLBAR_EXCLUDING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_TOOLBAR_EXCLUDING	Call by reference	☐	Type reference (TYPE)	UI_FUNCTIONS		Funktionscodestabelle	20010110

Method GET_TOOLBAR_EXCLUDING on class CL_SOTR_F4_HELP has no exception.

Method GET_TOOLBAR_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_R_TOOLBAR	Call by reference	☐	Object reference (TYPE REF TO)	CL_GUI_TOOLBAR		Toolbar Control	20010110

Method GET_TOOLBAR_OBJECT on class CL_SOTR_F4_HELP has no exception.

Method HANDLE_ITEM_CTMENU_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FIELDNAME	Call by reference	☐	Attribute reference (LIKE)				20001212
2	Importing	MENU	Call by reference	☐	Attribute reference (LIKE)				20001212
3	Importing	NODE_KEY	Call by reference	☐	Attribute reference (LIKE)				20001212

Method HANDLE_ITEM_CTMENU_REQUEST on class CL_SOTR_F4_HELP has no exception.

Method HANDLE_ITEM_CTMENU_SELECTED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FCODE	Call by reference	☐	Attribute reference (LIKE)				20001212
2	Importing	FIELDNAME	Call by reference	☐	Attribute reference (LIKE)				20001212
3	Importing	NODE_KEY	Call by reference	☐	Attribute reference (LIKE)				20001212

Method HANDLE_ITEM_CTMENU_SELECTED on class CL_SOTR_F4_HELP has no exception.

Method HANDLE_ITEM_DOUBLE_CLICK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FIELDNAME	Call by reference	☐	Attribute reference (LIKE)				20001212
2	Importing	NODE_KEY	Call by reference	☐	Attribute reference (LIKE)				20001212

Method HANDLE_ITEM_DOUBLE_CLICK on class CL_SOTR_F4_HELP has no exception.

Method HANDLE_NODE_CTMENU_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MENU	Call by reference	☐	Attribute reference (LIKE)				20001212
2	Importing	NODE_KEY	Call by reference	☐	Attribute reference (LIKE)				20001212

Method HANDLE_NODE_CTMENU_REQUEST on class CL_SOTR_F4_HELP has no exception.

Method HANDLE_NODE_CTMENU_SELECTED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FCODE	Call by reference	☐	Attribute reference (LIKE)				20001212
2	Importing	NODE_KEY	Call by reference	☐	Attribute reference (LIKE)				20001212

Method HANDLE_NODE_CTMENU_SELECTED on class CL_SOTR_F4_HELP has no exception.

Method HANDLE_NODE_DOUBLE_CLICK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NODE_KEY	Call by reference	☐	Attribute reference (LIKE)				20001212

Method HANDLE_NODE_DOUBLE_CLICK on class CL_SOTR_F4_HELP has no exception.

Method MODIFY_TOOLBAR Signature

Method MODIFY_TOOLBAR on class CL_SOTR_F4_HELP has no parameter.
Method MODIFY_TOOLBAR on class CL_SOTR_F4_HELP has no exception.

Method ON_DRAG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DRAG_DROP_OBJECT	Call by reference	☐	Attribute reference (LIKE)				20001220
2	Importing	FIELDNAME	Call by reference	☐	Attribute reference (LIKE)				20001220
3	Importing	NODE_KEY	Call by reference	☐	Attribute reference (LIKE)				20001220

Method ON_DRAG on class CL_SOTR_F4_HELP has no exception.

Method ON_FUNCTION_SELECTED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FCODE	Call by reference	☐	Attribute reference (LIKE)				20001213

Method ON_FUNCTION_SELECTED on class CL_SOTR_F4_HELP has no exception.

Method ON_TOOLBAR_DROPDOWN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FCODE	Call by reference	☐	Attribute reference (LIKE)				20001213
2	Importing	POSX	Call by reference	☐	Attribute reference (LIKE)				20001213
3	Importing	POSY	Call by reference	☐	Attribute reference (LIKE)				20001213

Method ON_TOOLBAR_DROPDOWN on class CL_SOTR_F4_HELP has no exception.

Method REGISTER_EVENTS Signature

Method REGISTER_EVENTS on class CL_SOTR_F4_HELP has no parameter.
Method REGISTER_EVENTS on class CL_SOTR_F4_HELP has no exception.

Method SELECT_ENTRY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ALIAS	Call by reference	☑	Type reference (TYPE)	SOTR_ALIAS		Eindeutiger Alias Name für OTR-Konzept	20010116
2	Importing	I_SOTR_KEY	Call by reference	☑	Type reference (TYPE)	SOTR_KEY		Schlüssel für Zugriff auf OTR-Texte	20010116

Method SELECT_ENTRY on class CL_SOTR_F4_HELP has no exception.

Method SET_FUNCTION_CODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_UCOMM	Call by reference	☐	Type reference (TYPE)	SY-UCOMM		Funktionscode	20010113

Method SET_FUNCTION_CODE on class CL_SOTR_F4_HELP has no exception.

Method UPDATE_OTR_TREE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_SOTR_TREES	Call by reference	☐	Type reference (TYPE)	SOTR_TREES		Übergabestruktur für hierarchische Darstellung von OTR Konz.	20001215

Method UPDATE_OTR_TREE on class CL_SOTR_F4_HELP has no exception.

Event Signatures

Event DOUBLE_CLICKED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	E_SOTR_TREE	Exporting	Value transfer	☐	Type reference (TYPE)	SOTR_TREE		Übergabestruktur für hierarchische Darstellung des OTR	20001215

Event DRAG Signature
Event DRAG on class CL_SOTR_F4_HELP has no parameter.

History

Last changed by/on	SAP	20010622
SAP Release Created in	610