SAP ABAP Class CL_CLS_F4HELP (F4 help based on a chatacteristic)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DWB-UTL-CLS (Application Component) Classification Toolset
     ⤷ SPAK_TOOL_CLASSIFICATION_PUB (Package) SPAK_TOOL_CLASSIFICATION_PUB

Properties

Class	CL_CLS_F4HELP
Short Description	F4 help based on a chatacteristic
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SPAK_TOOL_CLASSIFICATION_PUB	SPAK_TOOL_CLASSIFICATION_PUB
Created	20051202	SAP
Last change	20071217	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)
2	ICON	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_CLS_F4HELP has no interface implemented.

Friends

Class CL_CLS_F4HELP has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ALVTREE	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_GUI_ALV_TREE		ALV Tree Control	20051202
2	CONTAINER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Abstract Container for GUI Controls	20051202
3	KEY_INDEX	Instance attribute	Protected	☐	Type reference (TYPE)	TY_KEY_INDEX			20051202
4	LIST	Instance attribute	Private	☐	Type reference (TYPE)	CLS_BROWSER_LINES		Lines in browsers	20051202
5	OBJECT_GRAPH	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_CLS_OBJECT_GRAPH		Object graph	20060126
6	OBJECT_SELECTED	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20051202
7	SELECTED_OBJECT	Instance attribute	Private	☐	Type reference (TYPE)	PAK_OBJECT_KEY		Object key	20051202
8	TITLE	Instance attribute	Protected	☐	Type reference (TYPE)	STRING			20051202

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_OBJECT_NODE	Instance method	Private	Method		20051202
2	ADD_ROOTS	Instance method	Private	Method		20051202
3	ADD_STRUCTURE_NODE	Instance method	Private	Method		20051202
4	BUILD_TREE	Instance method	Private	Method		20051202
5	CHANGE_ALVTREE_TOOLBAR	Instance method	Protected	Method		20051202
6	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20051202
7	EXCLUDE_TB_FUNCTIONS	Instance method	Protected	Method		20051202
8	FREE	Instance method	Public	Method		20051202
9	GET_SELECTED_OBJECT	Instance method	Public	Method		20051202
10	HANDLE_EXPAND_NC	Instance method	Private	Event handling method		20051202
11	HANDLE_ITEM_DOUBLE_CLICK	Instance method	Protected	Event handling method		20051202
12	HANDLE_NODE_DOUBLE_CLICK	Instance method	Protected	Event handling method		20051202
13	HIER_HEADER	Instance method	Protected	Method		20051202
14	REGISTER_ALVTREE_EVENTS	Instance method	Protected	Method		20051202
15	SELECT	Instance method	Public	Method		20051202
16	SETUP_TREE	Instance method	Private	Method	CONSTRUCTOR	20051202

Events

Class CL_CLS_F4HELP has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_KEY_INDEX	Protected	See coding			20051202	ty_key_index type HASHED TABLE OF ty_key_index_entry with unique key key
2	TY_KEY_INDEX_ENTRY	Protected	See coding			20051202	begin of ty_key_index_entry, key type lvc_nkey, id type i, end of ty_key_index_entry

Method Signatures

Method ADD_OBJECT_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_NODE	Call by reference	☐	Type reference (TYPE)	CL_CLS_OBJECT_GRAPH=>TY_NODE			20051202
2	Importing	IM_PARENT_KEY	Call by reference	☑	Type reference (TYPE)	LVC_NKEY		ALV Tree Control: Node Key	20051202

Method ADD_OBJECT_NODE on class CL_CLS_F4HELP has no exception.

Method ADD_ROOTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_PARENT_KEY	Call by reference	☑	Type reference (TYPE)	LVC_NKEY		ALV Tree Control: Node Key	20051202

Method ADD_ROOTS on class CL_CLS_F4HELP has no exception.

Method ADD_STRUCTURE_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_NODE	Call by reference	☐	Type reference (TYPE)	CL_CLS_OBJECT_GRAPH=>TY_NODE			20051202
2	Importing	IM_PARENT_KEY	Call by reference	☑	Type reference (TYPE)	LVC_NKEY		ALV Tree Control: Node Key	20051202

Method ADD_STRUCTURE_NODE on class CL_CLS_F4HELP has no exception.

Method BUILD_TREE Signature

Method BUILD_TREE on class CL_CLS_F4HELP has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_PAK_GUI_ERROR	☐	GUI Package-Builder exceptions	20051202

Method CHANGE_ALVTREE_TOOLBAR Signature

Method CHANGE_ALVTREE_TOOLBAR on class CL_CLS_F4HELP has no parameter.
Method CHANGE_ALVTREE_TOOLBAR on class CL_CLS_F4HELP has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ATTRIBUTE	Call by reference	☐	Type reference (TYPE)	CLS_ATTRIBUTE_NAME		Characteristic	20051202
2	Importing	IM_OBJ_TYPE	Call by reference	☑	Type reference (TYPE)	TROBJTYPE		Object Type	20051202
3	Importing	IM_TITLE	Call by reference	☐	Type reference (TYPE)	CLIKE			20051202

#	Exception	Resumable	Description	Created on
1	CX_PAK_GUI_ERROR	☐	GUI Package-Builder exceptions	20051202
2	CX_PAK_INVALID_DATA	☐	Invalid data	20051202
3	CX_PAK_INVALID_STATE	☐	Operation can't be executed in present object state	20051202
4	CX_PAK_NOT_AUTHORIZED	☐	User doesn't have sufficient authorizations	20051202

Method EXCLUDE_TB_FUNCTIONS Signature

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

Method EXCLUDE_TB_FUNCTIONS on class CL_CLS_F4HELP has no exception.

Method FREE Signature

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

Method GET_SELECTED_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_OBJECT_SELECTED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20051202
2	Exporting	EX_SELECTED_OBJECT	Value transfer	☐	Type reference (TYPE)	PAK_OBJECT_KEY		Attribute	20051202

Method GET_SELECTED_OBJECT on class CL_CLS_F4HELP has no exception.

Method HANDLE_EXPAND_NC Signature

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

Method HANDLE_EXPAND_NC on class CL_CLS_F4HELP 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	Value transfer	☐	Attribute reference (LIKE)				20051202
2	Importing	NODE_KEY	Value transfer	☐	Attribute reference (LIKE)				20051202

Method HANDLE_ITEM_DOUBLE_CLICK on class CL_CLS_F4HELP 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	Value transfer	☐	Attribute reference (LIKE)				20051202

Method HANDLE_NODE_DOUBLE_CLICK on class CL_CLS_F4HELP has no exception.

Method HIER_HEADER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	P_HIERARCHY_HEADER	Call by reference	☐	Type reference (TYPE)	TREEV_HHDR			20051202

Method HIER_HEADER on class CL_CLS_F4HELP has no exception.

Method REGISTER_ALVTREE_EVENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ACTIVATION	Call by reference	☑	Type reference (TYPE)	CHAR1	'X'		20051202

#	Exception	Resumable	Description	Created on
1	CTRL_ERROR	☐		20051202

Method SELECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CONTAINER	Call by reference	☑	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Abstract Container for GUI Controls	20051202
2	Importing	IM_OBJECT_TYPE	Call by reference	☑	Type reference (TYPE)	TROBJTYPE		Object Type	20051202

#	Exception	Resumable	Description	Created on
1	CX_PAK_GUI_ERROR	☐	GUI Package-Builder exceptions	20051202

Method SETUP_TREE Signature

Method SETUP_TREE on class CL_CLS_F4HELP has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_PAK_GUI_ERROR	☐	GUI Package-Builder exceptions	20051202

History

Last changed by/on	SAP	20071217
SAP Release Created in	710