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

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DWB-UTL (Application Component) Workbench Utilities
     ⤷ SQF_UI (Package) User Interface

Properties

Class	CL_SQF_QUERY_BROWSER
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	SQF_UI	User Interface
Created	20071124	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)
2	CL_SQF_QUERY_LIST	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	ICON	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_SQF_QUERY_BROWSER has no interface implemented.

Friends

Class CL_SQF_QUERY_BROWSER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ALLOW_CHANGES	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20080711
2	ALLOW_CREATION	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20080711
3	ALLOW_EXECUTION	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20080711
4	ALVTREE	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_GUI_ALV_TREE		ALV Tree Control	20071124
5	CONTAINER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Abstract Container for GUI Controls	20071124
6	CONTROLLER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SQF_CONTROLLER		Controller	20071125
7	CO_COMMAND	Instance attribute	Private	☐	See coding				20071125
8	CO_EXECUTION_MODE	Constant	Public	☐	See coding				20080410
9	CO_NODE_TYPE	Instance attribute	Private	☐	See coding				20071124
10	EXECUTION_MODE	Instance attribute	Private	☐	Type reference (TYPE)	CHAR1		Single-Character Flag	20080410
11	KEY_INDEX	Instance attribute	Protected	☐	Type reference (TYPE)	TY_KEY_INDEX			20071124
12	LIST	Instance attribute	Private	☐	See coding				20071124
13	OBJECT_GRAPH	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_CLS_OBJECT_GRAPH		Object graph	20071124
14	QUERY_INDEX	Instance attribute	Private	☐	Type reference (TYPE)	TY_QUERY_INDEX			20071124
15	TOOL_INDEX	Instance attribute	Private	☐	Type reference (TYPE)	TY_TOOL_INDEX			20071124

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_INFO_NODE	Instance method	Private	Method		20110304
2	ADD_PROTOCOL	Instance method	Private	Method		20080328
3	ADD_QUERY_NODE	Instance method	Private	Method		20071125
4	ADD_ROOTS	Instance method	Private	Method		20071124
5	ADD_STRUCTURE_NODE	Instance method	Private	Method		20071124
6	ADD_TOOL_NODE	Instance method	Private	Method		20071125
7	BUILD_TREE	Instance method	Public	Method		20071124
8	CHANGE_ALVTREE_TOOLBAR	Instance method	Protected	Method		20071124
9	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20071124
10	CREATE_EXECUTION_DETAILS_NODE	Static method	Public	Method		20071127
11	DELETE_PROTOCOL	Instance method	Private	Method		20080328
12	EXCLUDE_TB_FUNCTIONS	Instance method	Protected	Method		20071124
13	EXECUTE	Instance method	Private	Method		20080410
14	EXPAND_STRUCTURE_NODE	Instance method	Private	Method		20071125
15	FREE	Instance method	Public	Method		20071124
16	GET_CATEGORY_NODE	Instance method	Private	Method		20110304
17	GET_EXECUTION_MODE	Instance method	Public	Method		20080410
18	GET_MESSAGE_ICON	Instance method	Private	Method		20080328
19	GET_QUERY_ICON	Instance method	Private	Method		20071125
20	GET_TOOL_NODE	Instance method	Private	Method		20110304
21	HANDLE_NEW_QUERY	Instance method	Private	Event handling method		20071125
22	HANDLE_NODE_CM_REQ	Instance method	Private	Event handling method		20071124
23	HANDLE_NODE_CM_SEL	Instance method	Private	Event handling method		20071124
24	HANDLE_NODE_DOUBLE_CLICK	Instance method	Protected	Event handling method		20071124
25	HANDLE_QUERY_DELETED	Instance method	Private	Event handling method		20071125
26	HANDLE_QUERY_STATE_CHANGED	Instance method	Private	Event handling method		20071125
27	HIER_HEADER	Instance method	Protected	Method		20071124
28	REGISTER_ALVTREE_EVENTS	Instance method	Protected	Method		20071124
29	SETUP_FIELDCAT	Static method	Private	Method		20071124
30	SETUP_TREE	Instance method	Private	Method	CONSTRUCTOR	20071124
31	SET_EXECUTION_MODE	Instance method	Public	Method		20080410

Events

Class CL_SQF_QUERY_BROWSER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_KEY_INDEX	Protected	See coding			20071124	ty_key_index type hashed table of ty_key_index_entry with unique key key
2	TY_KEY_INDEX_ENTRY	Protected	See coding			20071124	begin of ty_key_index_entry, key type lvc_nkey, node_type type c length 1, node_graph_id type i, tool type cl_sqf_controller=>ty_tool, query type cl_sqf_query_list=>ty_query, protocol_keys type lvc_t_nkey, status_node type lvc_nkey, end of ty_key_index_entry
3	TY_QUERY_INDEX	Protected	See coding			20071124	ty_query_index type hashed table of ty_query_index_entry with unique key query_id
4	TY_QUERY_INDEX_ENTRY	Protected	See coding			20071124	begin of ty_query_index_entry, query_id type i, key type lvc_nkey, end of ty_query_index_entry
5	TY_TOOL_INDEX	Protected	See coding			20071124	ty_tool_index type hashed table of ty_tool_index_entry with unique key tool_name
6	TY_TOOL_INDEX_ENTRY	Protected	See coding			20071124	begin of ty_tool_index_entry, tool_name type sobj_name, key type lvc_nkey, end of ty_tool_index_entry

Method Signatures

Method ADD_INFO_NODE 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	20110304
2	Importing	IM_TEXT	Call by reference	☐	Type reference (TYPE)	CLIKE			20110304
3	Returning	RE_KEY	Value transfer	☐	Type reference (TYPE)	LVC_NKEY		ALV Tree Control: Node Key	20110304

Method ADD_INFO_NODE on class CL_SQF_QUERY_BROWSER has no exception.

Method ADD_PROTOCOL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CH_KEY_INDEX_ENTRY	Call by reference	☐	Type reference (TYPE)	TY_KEY_INDEX_ENTRY			20080328
2	Importing	IM_PARENT_KEY	Call by reference	☑	Type reference (TYPE)	LVC_NKEY		ALV Tree Control: Node Key	20080328
3	Importing	IM_PROTOCOL	Call by reference	☐	Object reference (TYPE REF TO)	IF_SQF_PROTOCOL		Protocol	20080328

Method ADD_PROTOCOL on class CL_SQF_QUERY_BROWSER has no exception.

Method ADD_QUERY_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_QUERY	Call by reference	☐	Type reference (TYPE)	CL_SQF_QUERY_LIST=>TY_QUERY			20071125
2	Returning	RE_NODE_KEY	Value transfer	☐	Type reference (TYPE)	LVC_NKEY		ALV Tree Control: Node Key	20071125

Method ADD_QUERY_NODE on class CL_SQF_QUERY_BROWSER 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	20071124

Method ADD_ROOTS on class CL_SQF_QUERY_BROWSER 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_EXPAND	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20110304
2	Importing	IM_NODE	Call by reference	☐	Type reference (TYPE)	CL_CLS_OBJECT_GRAPH=>TY_NODE			20071124
3	Importing	IM_PARENT_KEY	Call by reference	☑	Type reference (TYPE)	LVC_NKEY		ALV Tree Control: Node Key	20071124
4	Returning	RE_KEY	Value transfer	☐	Type reference (TYPE)	LVC_NKEY		ALV Tree Control: Node Key	20110304

Method ADD_STRUCTURE_NODE on class CL_SQF_QUERY_BROWSER has no exception.

Method ADD_TOOL_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			20071125
2	Importing	IM_PARENT_KEY	Call by reference	☑	Type reference (TYPE)	LVC_NKEY		ALV Tree Control: Node Key	20071125
3	Returning	RE_KEY	Value transfer	☐	Type reference (TYPE)	LVC_NKEY		ALV Tree Control: Node Key	20110304

Method ADD_TOOL_NODE on class CL_SQF_QUERY_BROWSER has no exception.

Method BUILD_TREE Signature

Method BUILD_TREE on class CL_SQF_QUERY_BROWSER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SQF_GUI_ERROR	☐	GUI Package-Builder exceptions	20071125

Method CHANGE_ALVTREE_TOOLBAR Signature

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

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ALLOW_CHANGES	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20080711
2	Importing	IM_ALLOW_CREATION	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20080711
3	Importing	IM_ALLOW_EXECUTION	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20080711
4	Importing	IM_CONTAINER	Call by reference	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Abstract Container for GUI Controls	20071124
5	Importing	IM_CONTROLLER	Call by reference	☐	Object reference (TYPE REF TO)	CL_SQF_CONTROLLER		Controller	20071125

#	Exception	Resumable	Description	Created on
1	CX_SQF_GUI_ERROR	☐	GUI Exceptions	20071125

Method CREATE_EXECUTION_DETAILS_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_ICON	Call by reference	☐	Type reference (TYPE)	TV_IMAGE		Tree Control: Icon / Image	20071127
2	Exporting	EX_ICON_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20111109
3	Exporting	EX_NODE_TEXT	Call by reference	☐	Type reference (TYPE)	LVC_VALUE		ALV control: Cell content	20071127
4	Importing	IM_QUERY	Call by reference	☐	Object reference (TYPE REF TO)	IF_SQF_QUERY		Query	20071127

Method CREATE_EXECUTION_DETAILS_NODE on class CL_SQF_QUERY_BROWSER has no exception.

Method DELETE_PROTOCOL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CH_KEY_INDEX_ENTRY	Call by reference	☐	Type reference (TYPE)	TY_KEY_INDEX_ENTRY			20080328

Method DELETE_PROTOCOL on class CL_SQF_QUERY_BROWSER has no exception.

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			20071124

Method EXCLUDE_TB_FUNCTIONS on class CL_SQF_QUERY_BROWSER has no exception.

Method EXECUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_QUERY	Call by reference	☐	Object reference (TYPE REF TO)	IF_SQF_QUERY		Query	20080410

#	Exception	Resumable	Description	Created on
1	CX_SQF_GUI_ERROR	☐	UI Problems	20080410
2	CX_SQF_INVALID_STATE	☐	Invalid state	20080410
3	CX_SQF_NOT_AUTHORIZED	☐	Permission problems	20080410
4	CX_SQF_QUERY_ERROR	☐	Query errors	20080818

Method EXPAND_STRUCTURE_NODE Signature

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

Method EXPAND_STRUCTURE_NODE on class CL_SQF_QUERY_BROWSER has no exception.

Method FREE Signature

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

Method GET_CATEGORY_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_CATEGORY_ID	Call by reference	☐	Type reference (TYPE)	I			20110304
2	Returning	RE_CATEGORY_NODE	Value transfer	☐	Type reference (TYPE)	LVC_NKEY		ALV Tree Control: Node Key	20110304

Method GET_CATEGORY_NODE on class CL_SQF_QUERY_BROWSER has no exception.

Method GET_EXECUTION_MODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_EXECUTION_MODE	Value transfer	☐	Type reference (TYPE)	CHAR1		Single-Character Flag	20080410

Method GET_EXECUTION_MODE on class CL_SQF_QUERY_BROWSER has no exception.

Method GET_MESSAGE_ICON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_TYPE	Call by reference	☐	Type reference (TYPE)	SY-MSGTY		Type	20080328
2	Returning	RE_ICON	Value transfer	☐	Type reference (TYPE)	TV_IMAGE		Tree Control: Icon / Image	20080328

Method GET_MESSAGE_ICON on class CL_SQF_QUERY_BROWSER has no exception.

Method GET_QUERY_ICON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_STATE	Call by reference	☐	Type reference (TYPE)	SQF_QUERY_STATE		Query State	20071125
2	Returning	RE_ICON	Value transfer	☐	Type reference (TYPE)	TV_IMAGE		Tree Control: Icon / Image	20071125

Method GET_QUERY_ICON on class CL_SQF_QUERY_BROWSER has no exception.

Method GET_TOOL_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_TOOL_NAME	Call by reference	☐	Type reference (TYPE)	SOBJ_NAME		Object Name in Object Directory	20110304
2	Returning	RE_KEY	Value transfer	☐	Type reference (TYPE)	LVC_NKEY		ALV Tree Control: Node Key	20110304

Method GET_TOOL_NODE on class CL_SQF_QUERY_BROWSER has no exception.

Method HANDLE_NEW_QUERY Signature

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

Method HANDLE_NEW_QUERY on class CL_SQF_QUERY_BROWSER has no exception.

Method HANDLE_NODE_CM_REQ Signature

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

Method HANDLE_NODE_CM_REQ on class CL_SQF_QUERY_BROWSER has no exception.

Method HANDLE_NODE_CM_SEL Signature

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

Method HANDLE_NODE_CM_SEL on class CL_SQF_QUERY_BROWSER 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)				20071124

Method HANDLE_NODE_DOUBLE_CLICK on class CL_SQF_QUERY_BROWSER has no exception.

Method HANDLE_QUERY_DELETED Signature

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

Method HANDLE_QUERY_DELETED on class CL_SQF_QUERY_BROWSER has no exception.

Method HANDLE_QUERY_STATE_CHANGED Signature

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

Method HANDLE_QUERY_STATE_CHANGED on class CL_SQF_QUERY_BROWSER 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			20071124

Method HIER_HEADER on class CL_SQF_QUERY_BROWSER 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'		20071124

#	Exception	Resumable	Description	Created on
1	CTRL_ERROR	☐		20071124

Method SETUP_FIELDCAT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CH_FIELDCAT	Call by reference	☐	Type reference (TYPE)	LVC_T_FCAT		Field catalog for ListViewer control	20071124
2	Importing	IM_STRUCTURE_NAME	Call by reference	☐	Type reference (TYPE)	TABNAME	'SQF_BROWSER_LINE'	Table Name	20071124

#	Exception	Resumable	Description	Created on
1	CX_SQF_GUI_ERROR	☐	GUI Package-Builder exceptions	20071125

Method SETUP_TREE Signature

Method SETUP_TREE on class CL_SQF_QUERY_BROWSER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SQF_GUI_ERROR	☐	GUI Package-Builder exceptions	20071125

Method SET_EXECUTION_MODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_EXECUTION_MODE	Call by reference	☐	Type reference (TYPE)	CHAR1		Single-Character Flag	20080410

Method SET_EXECUTION_MODE on class CL_SQF_QUERY_BROWSER has no exception.

History

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