SAP ABAP Class CL_GUI_SIMPLE_TREE (Simple 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_TREE_CONTROL_BASE	Internal Tree Control Class	00000000

Properties

Class	CL_GUI_SIMPLE_TREE
Short Description	Simple Tree Control
Super Class	CL_TREE_CONTROL_BASE	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	19981013	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☐
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	CNTL	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_GUI_SIMPLE_TREE has no interface implemented.

Friends

Class CL_GUI_SIMPLE_TREE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	STRUCTURES	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_OBJECT		"	19990322
2	TEXT	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_OBJECT		"	19990322
3	THIS_CLASS_NAME	Constant	Private	☐	Type reference (TYPE)	CHAR80	'CL_GUI_SIMPLE_TREE'	Class Name	19981015

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_NODES	Instance method	Public	Method	Insert Nodes	19981014
2	CC_ADD_DESIGNTIME_SAMPLE_DATA	Static method	Private	Method	"	20000302
3	CC_CREATE_SIMPLE_TREE	Static method	Public	Method	Internal	20000302
4	CC_CREATE_SIMPLE_TREE_INITIAL	Static method	Public	Method	Internal	20000302
5	CC_CREATE_SIMPLE_TREE_INT	Static method	Private	Method	"	20000302
6	CONSTRUCTOR	Instance method	Public	Constructor	Constructor	19981013
7	HANDLE_DRAG_DROP_COMPLETE	Instance method	Private	Method	Handle ONDRAG and ONDROPCOMPLETE	19990216
8	INIT_SIMPLE_TREE	Instance method	Private	Method	Additional Initialization of Simple Tree	19981014
9	NODE_SET_TEXT	Instance method	Public	Method	Set Text of a Node	19981015
10	UPDATE_NODES	Instance method	Public	Method	Change Nodes	19981015

Events

#	Event	Type	Visibility	Description	Created on
1	ON_DRAG	Instance Event (0)	Public (2)	Event for Filling Drag and Drop Data Object	19990125
2	ON_DRAG_MULTIPLE	Instance Event (0)	Public (2)	Event for Filling Drag and Drop Data Object	19990216
3	ON_DROP_COMPLETE	Instance Event (0)	Public (2)	Event After Successful Drop	19990125
4	ON_DROP_COMPLETE_MULTIPLE	Instance Event (0)	Public (2)	Event After Successful Drop	19990216

Types

Class CL_GUI_SIMPLE_TREE has no local type.

Method Signatures

Method ADD_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NODE_TABLE	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE		Knotentabelle	19981014
2	Importing	TABLE_STRUCTURE_NAME	Value transfer	☐	Type reference (TYPE)	X030L-TABNAME		Name der Struktur der Knotentabelle	19981014

#	Exception	Resumable	Description	Created on
1	DP_ERROR	☐	Fehler beim Data Provider	19981014
2	ERROR_IN_NODE_TABLE	☐	Knotentabelle fehlerhaft	19981014
3	FAILED	☐	allgemeiner Fehler	19981014
4	TABLE_STRUCTURE_NAME_NOT_FOUND	☐	Struktur im Dictionary nicht gefunden	19981014

Method CC_ADD_DESIGNTIME_SAMPLE_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	TREE	Value transfer	☐	Object reference (TYPE REF TO)	CL_GUI_SIMPLE_TREE		"	20000302

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

Method CC_CREATE_SIMPLE_TREE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	CONTROL	Value transfer	☐	Object reference (TYPE REF TO)	CL_GUI_CONTROL		instance of Control proxy	20000302
2	Importing	CONTROL_TREE_NODE	Value transfer	☐	Object reference (TYPE REF TO)	IF_CONTROL_TREE_NODE		root node of describing Control Tree	20000302
3	Exporting	ERROR_TEXT	Call by reference	☐	Type reference (TYPE)	STRING		Error description	20000302
4	Importing	FOR_DESIGN	Value transfer	☑	Type reference (TYPE)	BOOLEAN		'X'=true, ' '=false; create in design mode	20000302
5	Importing	LIFETIME	Value transfer	☑	Type reference (TYPE)	I		Lifetime (Dynpro or IMode)	20000302
6	Importing	LOADER_REF	Value transfer	☐	Object reference (TYPE REF TO)	OBJECT		reference object within Control Loader	20000302
7	Importing	PARENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Parent Container	20000302
8	Importing	SHELLSTYLE	Value transfer	☑	Type reference (TYPE)	I		Shellstyle	20000302

#	Exception	Resumable	Description	Created on
1	CLASS_NAME_MISMATCH	☐	name in Control Tree node does not match class name	20000302
2	CNTL_ERROR	☐	"	20000302
3	CNTL_SYSTEM_ERROR	☐	"	20000302
4	CONTROL_ERROR	☐	error when creating Subcontrol	20000302
5	CREATE_ERROR	☐	"	20000302
6	LIFETIME_ERROR	☐	"	20000302
7	NO_NODE	☐	input parameter CONTROL_TREE_NODE not supplied	20000302
8	NO_PARENT	☐	input parameter PARENT not supplied	20000302
9	TREE_ERROR	☐	error when traversing given Control Tree	20000302
10	WRONG_NODE_TYPE	☐	some tree node has wrong node type	20000302

Method CC_CREATE_SIMPLE_TREE_INITIAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	CONTROL	Value transfer	☐	Object reference (TYPE REF TO)	CL_GUI_CONTROL		instance of Control proxy	20000302
2	Importing	CONTROL_TREE_NODE	Value transfer	☐	Object reference (TYPE REF TO)	IF_CONTROL_TREE_NODE		root node of initial Control Tree	20000302
3	Exporting	ERROR_TEXT	Call by reference	☐	Type reference (TYPE)	STRING		Error description	20000302
4	Importing	LIFETIME	Value transfer	☑	Type reference (TYPE)	I		Lifetime (Dynpro or IMode)	20000302
5	Importing	LOADER_REF	Value transfer	☐	Object reference (TYPE REF TO)	OBJECT		reference object within Control Loader	20000302
6	Importing	PARENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Parent Container	20000302
7	Importing	SHELLSTYLE	Value transfer	☑	Type reference (TYPE)	I		Shellstyle	20000302

#	Exception	Resumable	Description	Created on
1	CLASS_NAME_MISMATCH	☐	name in Control Tree node does not match class name	20000302
2	CNTL_ERROR	☐	error condition of Control	20000302
3	CNTL_SYSTEM_ERROR	☐	error condition of Control	20000302
4	CONTROL_ERROR	☐	error when creating Subcontrol	20000302
5	CREATE_ERROR	☐	error condition of Control	20000302
6	LIFETIME_ERROR	☐	error condition of Control	20000302
7	NO_NODE	☐	input parameter CONTROL_TREE_NODE not supplied	20000302
8	NO_PARENT	☐	input parameter PARENT not supplied	20000302
9	TREE_ERROR	☐	error when traversing given Control Tree	20000302
10	WRONG_NODE_TYPE	☐	some tree node has wrong node type	20000302

Method CC_CREATE_SIMPLE_TREE_INT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	CONTROL	Value transfer	☐	Object reference (TYPE REF TO)	CL_GUI_CONTROL		instance of Control proxy	20000302
2	Importing	FOR_DESIGN	Value transfer	☐	Type reference (TYPE)	AS4FLAG		'X'=true, ' '=false; create in design mode	20000302
3	Importing	HIDE_SELECTION	Value transfer	☐	Type reference (TYPE)	AS4FLAG		"	20000302
4	Importing	LIFETIME	Value transfer	☑	Type reference (TYPE)	I		Lifetime (Dynpro or IMode)	20000302
5	Importing	NODE_SELECTION_MODE	Value transfer	☐	Type reference (TYPE)	I		"	20000302
6	Importing	PARENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Parent Container	20000302
7	Importing	SHELLSTYLE	Value transfer	☑	Type reference (TYPE)	I		Shellstyle	20000302

#	Exception	Resumable	Description	Created on
1	CNTL_ERROR	☐	"	20000302
2	CNTL_SYSTEM_ERROR	☐	"	20000302
3	CREATE_ERROR	☐	"	20000302
4	LIFETIME_ERROR	☐	"	20000302

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			19981014
2	Importing	LIFETIME	Value transfer	☑	Type reference (TYPE)	I		"	19981029
3	Importing	NAME	Value transfer	☑	Type reference (TYPE)	STRING		Name	20000117
4	Importing	NODE_SELECTION_MODE	Value transfer	☐	Type reference (TYPE)	I		"	19981014
5	Importing	PARENT	Value transfer	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Parent-Container	19981216
6	Importing	SHELLSTYLE	Value transfer	☑	Type reference (TYPE)	I		Shellstyle	19981013

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐	"	19981013
2	CREATE_ERROR	☐	Fehler bei der Controlerzeugung	19981013
3	FAILED	☐	Allgemeiner Fehler	19981014
4	ILLEGAL_NODE_SELECTION_MODE	☐	Parameter NODE_SELECTION_MODE falsch	19981014
5	LIFETIME_ERROR	☐	"	19981029

Method HANDLE_DRAG_DROP_COMPLETE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DRAGDROPOBJECT	Value transfer	☐	Object reference (TYPE REF TO)	CL_DRAGDROPOBJECT		DragDrop DataObject	19990216
2	Importing	ON_DRAG	Value transfer	☐	Type reference (TYPE)	AS4FLAG		'X': ONDRAG behandeln	19990216
3	Importing	PROPERTIES	Value transfer	☐	Object reference (TYPE REF TO)	CL_SIMPLEPROPBAG		Parameter des Drag Drop	19990216

Method HANDLE_DRAG_DROP_COMPLETE on class CL_GUI_SIMPLE_TREE has no exception.

Method INIT_SIMPLE_TREE Signature

Method INIT_SIMPLE_TREE on class CL_GUI_SIMPLE_TREE has no parameter.

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

Method NODE_SET_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NODE_KEY	Value transfer	☐	Type reference (TYPE)	TV_NODEKEY		Schlüssel des Knotens	19981015
2	Importing	TEXT	Value transfer	☐	Type reference (TYPE)	C		Text des Knotens	19981015

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐	"	19981015
2	FAILED	☐	Allgemeiner Fehler	19981015
3	NODE_NOT_FOUND	☐	Knoten mit Schlüssel NODE_KEY existiert nicht	19981015

Method UPDATE_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NODE_TABLE	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE		Knotentabelle	19981015
2	Importing	NODE_TABLE_STRUCTURE_NAME	Value transfer	☐	Type reference (TYPE)	X030L-TABNAME		Name der Struktur der Knotentabelle	19981015

#	Exception	Resumable	Description	Created on
1	CNTL_SYSTEM_ERROR	☐	"	19981015
2	DP_ERROR	☐	Fehler beim Data Provider	19981015
3	ERROR_IN_NODE_TABLE	☐	Knotentabelle fehlerhaft	19981015
4	FAILED	☐	Allgemeiner Fehler	19981015
5	TABLE_STRUCTURE_NAME_NOT_FOUND	☐	Struktur der Knotentabelle existiert nicht	19981015

Event Signatures

Event ON_DRAG Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	DRAG_DROP_OBJECT	Exporting	Value transfer	☐	Object reference (TYPE REF TO)	CL_DRAGDROPOBJECT		Drag Drop Objekt	19990125
2	NODE_KEY	Exporting	Value transfer	☐	Type reference (TYPE)	TV_NODEKEY		Schlüssel des Knotens der gedragged wurde	19990216

Event ON_DRAG_MULTIPLE Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	DRAG_DROP_OBJECT	Exporting	Value transfer	☐	Object reference (TYPE REF TO)	CL_DRAGDROPOBJECT		Drag Drop Objekt	19990216
2	NODE_KEY_TABLE	Exporting	Value transfer	☐	Type reference (TYPE)	TREEV_NKS		Tabelle mit Knotenschlüsseln	19990216

Event ON_DROP_COMPLETE Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	DRAG_DROP_OBJECT	Exporting	Value transfer	☐	Object reference (TYPE REF TO)	CL_DRAGDROPOBJECT		Drag Drop Objekt	19990125
2	NODE_KEY	Exporting	Value transfer	☐	Type reference (TYPE)	TV_NODEKEY		Schlüssel des Knotens der gedragged wurde	19990125

Event ON_DROP_COMPLETE_MULTIPLE Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	DRAG_DROP_OBJECT	Exporting	Value transfer	☐	Object reference (TYPE REF TO)	CL_DRAGDROPOBJECT		Drag Drop Objekt	19990216
2	NODE_KEY_TABLE	Exporting	Value transfer	☐	Type reference (TYPE)	TREEV_NKS		Tabelle mit Knotenschlüsseln	19990216

History

Last changed by/on	SAP	20130531
SAP Release Created in