SAP ABAP Class CL_SQF_RESULT_TREE (Tree format for results)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DWB-UTL (Application Component) Workbench Utilities
     ⤷ SQF_API (Package) API

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_SQF_RESULT_FLAT_LIST	Generic table result	20081017

Properties

Class	CL_SQF_RESULT_TREE
Short Description	Tree format for results
Super Class	CL_SQF_RESULT_FLAT_LIST	Generic table result
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SQF_API	API
Created	20081017	SAP
Last change	20130531	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)

Interfaces

Class CL_SQF_RESULT_TREE has no interface implemented.

Friends

Class CL_SQF_RESULT_TREE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	HIERARCHY_HEADER	Instance attribute	Private	☐	Type reference (TYPE)	TREEV_HHDR		Tree Control: Attributes of the Hierarchy Header	20081017
2	ICONS	Instance attribute	Private	☐	Type reference (TYPE)	TY_ICON_DIR			20081017
3	ICONS_DEFINED	Instance attribute	Private	☐	Type reference (TYPE)	I			20081017
4	NODES	Instance attribute	Private	☐	Type reference (TYPE)	TY_NODE_DIR			20081017
5	SELECTED_NODE	Instance attribute	Private	☐	Type reference (TYPE)	I			20081212
6	TYPE_TREE	Constant	Public	☐	Type reference (TYPE)	SOBJ_NAME	'CL_SQF_RESULT_TREE'	Object Name in Object Directory	20081017

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_NODE	Instance method	Public	Method	Add a node	20081017
2	DECLARE_ICON	Instance method	Public	Method	Declare an icon with quick-infos	20081017
3	GET_HIERARCHY_HEADER	Instance method	Public	Method	Hierarchy Column	20081017
4	GET_ICON	Instance method	Public	Method	Get an icon with quickinfo froman icon id	20081017
5	GET_NODES	Instance method	Public	Method	Get nodes and icons	20081017
6	GET_NODE_TEXT	Instance method	Public	Method	Get the text of a node	20081017
7	GET_SELECTED_NODE	Instance method	Public	Method		20081212
8	SET_HIERARCHY_HEADER	Instance method	Public	Method	Hierarchy Column	20081017
9	SET_SELECTED_NODE	Instance method	Public	Method		20081212

Events

Class CL_SQF_RESULT_TREE has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_ICON	Public	See coding			20081017	begin of ty_icon, id type i, icon_def type icon_d, quickinfos type sqf_texts, end of ty_icon
2	TY_ICON_DIR	Public	See coding			20081017	ty_icon_dir type hashed table of ty_icon with unique key id
3	TY_NODE	Public	See coding			20081017	begin of ty_node, related_node type i, relationship type i, " from cl_gui_column_tree=>relat.... line_index type i, node_texts type sqf_texts, node_icon type i, " icon ref end of ty_node
4	TY_NODE_DIR	Public	See coding			20081017	ty_node_dir type standard table of ty_node with default key

Method Signatures

Method ADD_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_NODE_ICON	Call by reference	☑	Type reference (TYPE)	I		Icon reference	20081017
2	Importing	IM_NODE_TEXT_KEY	Call by reference	☑	Type reference (TYPE)	TEXTPOOLKY		Text element key (number/selection name)	20081017
3	Importing	IM_NODE_TEXT_MSGV1	Call by reference	☑	Type reference (TYPE)	CLIKE		#textid or & or Text	20081017
4	Importing	IM_NODE_TEXT_MSGV2	Call by reference	☑	Type reference (TYPE)	CLIKE		#textid or & or Text	20081017
5	Importing	IM_NODE_TEXT_MSGV3	Call by reference	☑	Type reference (TYPE)	CLIKE		#textid or & or Text	20081017
6	Importing	IM_NODE_TEXT_MSGV4	Call by reference	☑	Type reference (TYPE)	CLIKE		#textid or & or Text	20081017
7	Importing	IM_OUTTAB_LINE	Call by reference	☑	Type reference (TYPE)	ANY		Outtab line	20081017
8	Importing	IM_RELATED_NODE	Call by reference	☑	Type reference (TYPE)	I		Related Node	20081017
9	Importing	IM_RELATIONSHIP	Call by reference	☐	Type reference (TYPE)	I	CL_GUI_COLUMN_TREE=>RELAT_LAST_CHILD	Relation according to CL_GUI_COLUMN_TREE=>RELAT...	20081017
10	Returning	RE_NODE_KEY	Value transfer	☐	Type reference (TYPE)	I		Node Key	20081017

#	Exception	Resumable	Description	Created on
1	CX_SQF_QUERY_ERROR	☐	Query errors	20081017

Method DECLARE_ICON Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ICON	Call by reference	☐	Type reference (TYPE)	ICON_D		Icon in text fields (substitute display, alias)	20081017
2	Importing	IM_KEY	Call by reference	☑	Type reference (TYPE)	TEXTPOOLKY		Text element key (number/selection name)	20081017
3	Importing	IM_MSGV1	Call by reference	☑	Type reference (TYPE)	CLIKE		#textid or & or Text	20081017
4	Importing	IM_MSGV2	Call by reference	☑	Type reference (TYPE)	CLIKE		#textid or & or Text	20081017
5	Importing	IM_MSGV3	Call by reference	☑	Type reference (TYPE)	CLIKE		#textid or & or Text	20081017
6	Importing	IM_MSGV4	Call by reference	☑	Type reference (TYPE)	CLIKE		#textid or & or Text	20081017
7	Returning	RE_ICON_ID	Value transfer	☐	Type reference (TYPE)	I			20081017

Method DECLARE_ICON on class CL_SQF_RESULT_TREE has no exception.

Method GET_HIERARCHY_HEADER Signature

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

Method GET_HIERARCHY_HEADER on class CL_SQF_RESULT_TREE has no exception.

Method GET_ICON 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	20111109
2	Exporting	EX_ICON_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20111109
3	Exporting	EX_QUICKINFO	Call by reference	☐	Type reference (TYPE)	STRING			20111109
4	Importing	IM_ICON_ID	Call by reference	☐	Type reference (TYPE)	I			20081017

Method GET_ICON on class CL_SQF_RESULT_TREE has no exception.

Method GET_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_NODES	Call by reference	☐	Type reference (TYPE)	TY_NODE_DIR			20081017

Method GET_NODES on class CL_SQF_RESULT_TREE has no exception.

Method GET_NODE_TEXT 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)	TY_NODE			20081017
2	Returning	RE_TEXT	Value transfer	☐	Type reference (TYPE)	STRING			20081017

Method GET_NODE_TEXT on class CL_SQF_RESULT_TREE has no exception.

Method GET_SELECTED_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_NODE	Call by reference	☐	Type reference (TYPE)	TY_NODE			20081212
2	Exporting	EX_ROW	Call by reference	☐	Type reference (TYPE)	ANY			20081212

Method GET_SELECTED_NODE on class CL_SQF_RESULT_TREE has no exception.

Method SET_HIERARCHY_HEADER Signature

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

Method SET_HIERARCHY_HEADER on class CL_SQF_RESULT_TREE has no exception.

Method SET_SELECTED_NODE Signature

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

Method SET_SELECTED_NODE on class CL_SQF_RESULT_TREE has no exception.

History

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