SAP ABAP Class CL_GUI_LIST_TREE (List Tree Control)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-DWB-UTL (Application Component) Workbench Utilities
     ⤷ SEU_TREE_CONTROL (Package) OO Framework for Tree Control

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_ITEM_TREE_CONTROL	Internal Tree Control Class	00000000

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_EEWA_LIST_TREE	Enhanced Tree Implementation	20040210
2	Inheritance (c INHERITING FROM c_ref)	CL_SAT_UI_LIST_TREE_CTRL	*NO* Reuse: Customized list tree Control	20071109

Properties

Class	CL_GUI_LIST_TREE
Short Description	List Tree Control
Super Class	CL_ITEM_TREE_CONTROL	Internal Tree Control Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	SEU_TREE_CONTROL	OO Framework for Tree Control
Created	19981022	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☐
Unicode checks active	☑

Forward declarations

Class CL_GUI_LIST_TREE has no forward declaration.

Interfaces

Class CL_GUI_LIST_TREE has no interface implemented.

Friends

Class CL_GUI_LIST_TREE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	ALIGN_AUTO	Constant	Public	☐	Type reference (TYPE)	I	align_auto_int	Automatic Length	19981022
2	HEADER	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_OBJECT		"	19990401
3	HEADERS	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_OBJECT		"	19990401
4	ITEM	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_OBJECT		"	19990322

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CALL_ITEM_METHOD	Instance method	Private	Method	Call Method of an Item	19981022
2	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	19981022
3	HIERARCHY_HEADER_ADJUST_WIDTH	Instance method	Public	Method	Adapt the Width of the Hierarchy Area to the Contents	19981022
4	HIERARCHY_HEADER_GET_WIDTH	Instance method	Public	Method	Read the Width of the Hierarchy Header	19981022
5	HIERARCHY_HEADER_SET_TEXT	Instance method	Public	Method	Set the Text of the Hierarchy Header	19981022
6	HIERARCHY_HEADER_SET_TOOLTIP	Instance method	Public	Method	Set Tool Tip for Hierarchy Header	19981204
7	HIERARCHY_HEADER_SET_T_IMAGE	Instance method	Public	Method	Sets the Picture for the Hierarchy Header	19981022
8	HIERARCHY_HEADER_SET_WIDTH	Instance method	Public	Method	Sets the Width of the Hierarchy Header	19981022
9	ITEM_SET_ALIGNMENT	Instance method	Public	Method	Sets the Alignment of an Item / Automatic Width	19981022
10	ITEM_SET_LENGTH	Instance method	Public	Method	Sets the Width of an Item	19981022
11	LIST_HEADER_SET_TEXT	Instance method	Public	Method	Sets Text for the List Header	19981022
12	LIST_HEADER_SET_TOOLTIP	Instance method	Public	Method	Sets Tool Tip for the List Header	19981204
13	LIST_HEADER_SET_T_IMAGE	Instance method	Public	Method	Sets Picture for List Header	19981022
14	NODE_SET_LAST_HIERARCHY_ITEM	Instance method	Public	Method	Defines Last Item Under the Hierarchy Header	19981022
15	SETUP_LIST_HEADER	Instance method	Private	Method	Sets Properties of the List Header	19981022

Events

Class CL_GUI_LIST_TREE has no event.

Types

Class CL_GUI_LIST_TREE has no local type.

Method Signatures

Method CALL_ITEM_METHOD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ITEM_NAME	Value transfer	☐	Type reference (TYPE)	TV_ITMNAME		Name des Items	19981022
2	Importing	METHOD_NAME	Value transfer	☐	Type reference (TYPE)	C		Name der Methode	19981022
3	Importing	NODE_KEY	Value transfer	☐	Type reference (TYPE)	TV_NODEKEY		Schlüssel des Knotens	19981022
4	Importing	P1	Value transfer	☑	Type reference (TYPE)	ANY		1. Parameter	19981022
5	Importing	P2	Value transfer	☑	Type reference (TYPE)	ANY		2. Parameter	19981022
6	Importing	P3	Value transfer	☑	Type reference (TYPE)	ANY		3. Parameter	19981022
7	Importing	P_COUNT	Value transfer	☐	Type reference (TYPE)	I		Anzahl Parameter	19981022

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐	"	19981022
2	FAILED	☐	"	19981022
3	ITEM_NOT_FOUND	☐	"	19981022
4	METHOD_CALL_ERROR	☐	"	19981022
5	NODE_NOT_FOUND	☐	"	19981022

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	HIDE_SELECTION	Value transfer	☑	Type reference (TYPE)	AS4FLAG		Sichtbarkeit der Selektion	19981022
2	Importing	HIERARCHY_HEADER	Call by reference	☑	Type reference (TYPE)	TREEV_HHDR		Hierarchie-Header	19981022
3	Importing	ITEM_SELECTION	Value transfer	☐	Type reference (TYPE)	AS4FLAG		Selektierbarkeit einzelner Items	19981022
4	Importing	LIFETIME	Value transfer	☑	Type reference (TYPE)	I		Lebensdauer	19981029
5	Importing	LIST_HEADER	Call by reference	☑	Type reference (TYPE)	TREEV_LHDR		List-Header	19981022
6	Importing	NAME	Value transfer	☑	Type reference (TYPE)	STRING		Name	20000117
7	Importing	NODE_SELECTION_MODE	Value transfer	☐	Type reference (TYPE)	I		Knoten: Einfach- oder Mehrfachselektion	19981022
8	Importing	PARENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Parent-Container	19981216
9	Importing	SHELLSTYLE	Value transfer	☑	Type reference (TYPE)	I		Shellstyle	19981022
10	Importing	WITH_HEADERS	Value transfer	☐	Type reference (TYPE)	AS4FLAG		'X': mit Headern	19981022

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐	"	19981022
2	CREATE_ERROR	☐	Fehler bei der Controlerzeugung	19981022
3	FAILED	☐	allgemeiner Fehler	19981022
4	ILLEGAL_NODE_SELECTION_MODE	☐	Parameter NODE_SELECTION_MODE fehlerhaft	19981022
5	LIFETIME_ERROR	☐	"	19981029

Method HIERARCHY_HEADER_ADJUST_WIDTH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	INCLUDE_HEADING	Value transfer	☑	Type reference (TYPE)	AS4FLAG		'X': Überschrift bei der Breitenberechnung berücksichtigen	19990916

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐	"	19981022
2	FAILED	☐	Allgemeiner Fehler	19981022
3	TREE_HAS_NO_HEADERS	☐	Tree Control hat keine Header	19981022

Method HIERARCHY_HEADER_GET_WIDTH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	WIDTH	Call by reference	☐	Type reference (TYPE)	I		Breite des Headers	19981022
2	Importing	WIDTH_PIX	Value transfer	☑	Type reference (TYPE)	AS4FLAG	'X'	'X': Breite in Pixeln lesen; ' ': in Zeichen	19990208

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐	"	19981022
2	FAILED	☐	Allgemeiner Fehler	19981022
3	TREE_HAS_NO_HEADERS	☐	Tree Control hat keine Header	19981022

Method HIERARCHY_HEADER_SET_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	TEXT	Value transfer	☐	Type reference (TYPE)	TV_HEADING		Text des Headers	19981022

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐	"	19981022
2	FAILED	☐	Allgemeiner Fehler	19981022
3	TREE_HAS_NO_HEADERS	☐	Tree Control hat keine Header	19981022

Method HIERARCHY_HEADER_SET_TOOLTIP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	TOOLTIP	Value transfer	☐	Type reference (TYPE)	TV_HEADING		Tooltip des Headers	19981204

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐	"	19981204
2	FAILED	☐	Allgemeiner Fehler	19981204
3	TREE_HAS_NO_HEADERS	☐	Tree Control hat keine Header	19981204

Method HIERARCHY_HEADER_SET_T_IMAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	T_IMAGE	Value transfer	☐	Type reference (TYPE)	TV_IMAGE		Bild des Headers	19981022

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐	"	19981022
2	FAILED	☐	Allgemeiner Fehler	19981022
3	TREE_HAS_NO_HEADERS	☐	Tree Control hat keine Header	19981022

Method HIERARCHY_HEADER_SET_WIDTH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	WIDTH	Value transfer	☐	Type reference (TYPE)	I		Breite des Headers	19981022
2	Importing	WIDTH_PIX	Value transfer	☑	Type reference (TYPE)	AS4FLAG		' ': Breite in Zeichen, 'X': in Pixeln	19981022

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐	"	19981022
2	FAILED	☐	Allgemeiner Fehler	19981022
3	TREE_HAS_NO_HEADERS	☐	Tree Control hat keine Header	19981022

Method ITEM_SET_ALIGNMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ALIGNMENT	Value transfer	☐	Type reference (TYPE)	I		Ausrichtung des Itmes	19981022
2	Importing	ITEM_NAME	Value transfer	☐	Type reference (TYPE)	TV_ITMNAME		Name des Items	19981022
3	Importing	NODE_KEY	Value transfer	☐	Type reference (TYPE)	TV_NODEKEY		Schlüssel des Knotens	19981022

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐	"	19981022
2	FAILED	☐	Allgemeiner Fehler	19981022
3	ILLEGAL_ALIGNMENT	☐	Parameter ALIGNMENT enhält unzulässigen Wert	19990826
4	ITEM_NOT_FOUND	☐	Item mit Namen ITEM_NAME nicht vorhanden	19981022
5	NODE_NOT_FOUND	☐	Knoten mit Schlüssel NODE_KEY nicht vorhanden	19981022

Method ITEM_SET_LENGTH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ITEM_NAME	Value transfer	☐	Type reference (TYPE)	TV_ITMNAME		Name des Items	19981022
2	Importing	LENGTH	Value transfer	☐	Type reference (TYPE)	I		Ausrichtung des Itmes	19981022
3	Importing	LENGTH_PIX	Value transfer	☑	Type reference (TYPE)	AS4FLAG		'X': Länge in Pixeln; ' ': in Zeichen	19981022
4	Importing	NODE_KEY	Value transfer	☐	Type reference (TYPE)	TV_NODEKEY		Schlüssel des Knotens	19981022

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐	"	19981022
2	FAILED	☐	Allgemeiner Fehler	19981022
3	ITEM_NOT_FOUND	☐	Item mit Namen ITEM_NAME nicht vorhanden	19981022
4	NODE_NOT_FOUND	☐	Knoten mit Schlüssel NODE_KEY nicht vorhanden	19981022

Method LIST_HEADER_SET_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	TEXT	Value transfer	☐	Type reference (TYPE)	TV_HEADING		Text des Headers	19981022

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐	"	19981022
2	FAILED	☐	Allgemeiner Fehler	19981022
3	TREE_HAS_NO_HEADERS	☐	Tree Control hat keine Header	19981022

Method LIST_HEADER_SET_TOOLTIP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	TOOLTIP	Value transfer	☐	Type reference (TYPE)	TV_HEADING		Tooltip des Headers	19981204

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐	"	19981204
2	FAILED	☐	Allgemeiner Fehler	19981204
3	TREE_HAS_NO_HEADERS	☐	Tree Control hat keine Header	19981204

Method LIST_HEADER_SET_T_IMAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	T_IMAGE	Value transfer	☐	Type reference (TYPE)	TV_IMAGE		Bild des Headers	19981022

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐	"	19981022
2	FAILED	☐	Allgemeiner Fehler	19981022
3	TREE_HAS_NO_HEADERS	☐	Tree Control hat keine Header	19981022

Method NODE_SET_LAST_HIERARCHY_ITEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LAST_HIERARCHY_ITEM	Value transfer	☐	Type reference (TYPE)	TV_ITMNAME		Name des Items	19981022
2	Importing	NODE_KEY	Value transfer	☐	Type reference (TYPE)	TV_NODEKEY		Schlüssel des Knotens	19981022

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐	"	19981022
2	FAILED	☐	allgemeiner Fehler	19981022
3	NODE_NOT_FOUND	☐	Knoten existiert nicht	19981022
4	TREE_HAS_NO_HEADERS	☐	Tree Control hat keine Header	19981022

Method SETUP_LIST_HEADER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LHEADER	Value transfer	☐	Type reference (TYPE)	TREEV_LHDR		"	19981022

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐	"	19981022
2	FAILED	☐	"	19981022

History

Last changed by/on	SAP	20130531
SAP Release Created in