SAP ABAP Class CL_UAP_TREE_NAVIGATION (Navigation with Overview Tree)

Hierarchy

☛ EA-FINSERV (Software Component) SAP Enterprise Extension Financial Services
   ⤷ TR (Application Component) Treasury
     ⤷ UAP_GUI_ENABLING_FRAMEWORK (Package) Framework for GUI Programming

Properties

Class	CL_UAP_TREE_NAVIGATION
Short Description	Navigation with Overview Tree
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status	P	SAP Standard Production Program
Category	0
Package	UAP_GUI_ENABLING_FRAMEWORK	Framework for GUI Programming
Created	20000117	SAP
Last change	20041006	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

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

Interfaces

Class CL_UAP_TREE_NAVIGATION has no interface implemented.

Friends

Class CL_UAP_TREE_NAVIGATION has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	_BEHAVIOUR	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_DRAGDROP		Behavior for Drag&Drop	20010124
2	_CONTAINER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Docking Control	20010311
3	_DOCKING	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_DOCKING_CONTAINER		Docking Control	20000117
4	_DYNNR	Instance attribute	Private	☐	Type reference (TYPE)	SY-DYNNR		Screen Number	20000120
5	_FAVORITES	Instance attribute	Private	☐	Type reference (TYPE)	UAP_BOOLEAN		Boolean	20010309
6	_HTML_SEARCH	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_HTML_VIEWER		HTML Control Proxy Class	20010213
7	_INDEX	Instance attribute	Private	☐	Type reference (TYPE)	UAP_BOOLEAN		Boolean	20010213
8	_NODES	Instance attribute	Private	☐	Type reference (TYPE)	UAP_NODES		Nodes for Navigation	20001215
9	_REPID	Instance attribute	Private	☐	Type reference (TYPE)	SY-REPID		Program Name	20000120
10	_SEARCH	Instance attribute	Private	☐	Type reference (TYPE)	UAP_BOOLEAN		Boolean	20010213
11	_SHOW_TOOLBAR	Instance attribute	Private	☐	Type reference (TYPE)	UAP_BOOLEAN		Boolean	20010311
12	_SPLITTER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_SPLITTER_CONTAINER		Splitter Control	20010201
13	_TOOLBAR	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_TOOLBAR		Toolbar Control	20010201
14	_TREE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_GUI_SIMPLE_TREE		Tree Control	20000117

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_NODES	Instance method	Public	Event handling method	<> Generate Data for Tree	20001203
2	ADD_TO_FAVORITES	Instance method	Public	Method	<> Add to Favorites	20010306
3	ADJUST_TOOLBAR_STATUS	Instance method	Public	Method	<> Update Status of Functions	20010201
4	ADJUST_TREE	Instance method	Public	Method	Adjust for <> Tree Settings	20000120
5	CHECK_AUTHORITY	Instance method	Private	Method	<> Authorization Check	20010322
6	COLLAPSE_TREE	Instance method	Public	Method	<> Collapse	20010202
7	COMPLETE_NODES	Instance method	Private	Method	<> Node Environment	20010223
8	CONSTRUCTOR	Instance method	Public	Constructor	<> Constructor	20000117
9	CREATE_TREE_NODE	Instance method	Private	Method	<> Generate Node for Tree	20010215
10	DELETE_NODES	Instance method	Public	Method	<> Remove Node	20010130
11	DROP_IS_ALLOWED	Instance method	Private	Method	<> Drag Possible	20010207
12	EXPAND_TREE	Instance method	Public	Method	<> Open	20010202
13	GET_EXTENSION	Instance method	Public	Method	<> Width of Tree	20000620
14	GET_SELECTED_NODE	Instance method	Public	Method	Selected Node	20010313
15	HANDLE_CMENU_REQUEST	Instance method	Private	Event handling method	<> Generate Context Menu	20001201
16	HANDLE_CMENU_SELECT	Instance method	Private	Event handling method	<> Query Function Code	20001201
17	HANDLE_DOUBLE_CLICK	Instance method	Private	Event handling method	<> Process Selection from Tree	20001201
18	HANDLE_DRAG	Instance method	Private	Event handling method	<> Drag	20010123
19	HANDLE_DROP	Instance method	Private	Event handling method	<> Drop	20010123
20	INCLUDE_SEARCH	Instance method	Private	Method	<> Incorporate Search	20010213
21	INCLUDE_TOOLBAR	Instance method	Private	Method	<> Incorporate Toolbar	20010213
22	INCLUDE_TREE	Instance method	Private	Method	<> Incorporate Tree	20010213
23	INIT_TREE	Instance method	Public	Method	<> Create Tree Control for Navigation	20000117
24	INSERT_NODES	Instance method	Public	Method	<> Insert New Nodes	20010124
25	IS_ACTIVE	Instance method	Public	Method	<> Active for Tree	20000626
26	LOCK_DRAG_DROP	Instance method	Private	Method	<> Drag Possible	20010319
27	ON_KEY_CHANGED	Instance method	Private	Event handling method	<> Change Selection	20010205
28	ON_SEARCH	Instance method	Private	Event handling method	<> Search Initiated	20010213
29	ON_TOOLBAR_DROPDOWN	Instance method	Private	Event handling method	<> CMenu for Function	20010201
30	ON_TOOLBAR_SELECTION	Instance method	Private	Event handling method	<> Function Code	20010201
31	SEARCH_EQUAL_NODES	Instance method	Public	Method	<> Node Search	20010223

Events

#	Event	Type	Visibility	Description	Created on
1	CMENU_REQUESTED	Instance Event (0)	Public (2)	Menu Requested	20010201
2	DROPDOWN_REQUESTED	Instance Event (0)	Private (0)	Dropdown for Function	20010201
3	FUNCTION_SELECTION	Instance Event (0)	Public (2)	Function Selection	20010201
4	NODE_SELECTION	Instance Event (0)	Public (2)	Selection of node	20010201

Types

Class CL_UAP_TREE_NAVIGATION 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_KEY	Call by reference	☐	Attribute reference (LIKE)				20001203

Method ADD_NODES on class CL_UAP_TREE_NAVIGATION has no exception.

Method ADD_TO_FAVORITES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_NODE	Call by reference	☐	Object reference (TYPE REF TO)	CL_UAP_NAVIGATION_NODE		Navigationsknoten	20010306
2	Importing	IM_PARENT	Value transfer	☑	Object reference (TYPE REF TO)	CL_UAP_NAVIGATION_NODE		Navigationsknoten	20010306

Method ADD_TO_FAVORITES on class CL_UAP_TREE_NAVIGATION has no exception.

Method ADJUST_TOOLBAR_STATUS Signature

Method ADJUST_TOOLBAR_STATUS on class CL_UAP_TREE_NAVIGATION has no parameter.
Method ADJUST_TOOLBAR_STATUS on class CL_UAP_TREE_NAVIGATION has no exception.

Method ADJUST_TREE Signature

Method ADJUST_TREE on class CL_UAP_TREE_NAVIGATION has no parameter.
Method ADJUST_TREE on class CL_UAP_TREE_NAVIGATION has no exception.

Method CHECK_AUTHORITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DESTINATION	Value transfer	☐	Object reference (TYPE REF TO)	CL_UAP_NAVIGATION_NODE		Navigationsknoten	20010322
2	Importing	IM_SOURCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_UAP_NAVIGATION_NODE		Navigationsknoten	20010322
3	Returning	RE_MODE	Value transfer	☐	Type reference (TYPE)	CDCHNGIND		Art der Änderung (U, I, E, D)	20010322

Method CHECK_AUTHORITY on class CL_UAP_TREE_NAVIGATION has no exception.

Method COLLAPSE_TREE Signature

Method COLLAPSE_TREE on class CL_UAP_TREE_NAVIGATION has no parameter.
Method COLLAPSE_TREE on class CL_UAP_TREE_NAVIGATION has no exception.

Method COMPLETE_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CH_NODES	Call by reference	☐	Type reference (TYPE)	UAP_NODES		Knoten für Navigation	20010223

Method COMPLETE_NODES on class CL_UAP_TREE_NAVIGATION has no exception.

Method CONSTRUCTOR 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		Abstracter Container fuer GUI Controls	20010311
2	Importing	IM_DYNNR	Call by reference	☐	Type reference (TYPE)	SY-DYNNR		Dynpronummer	20000117
3	Importing	IM_FAVORITES	Call by reference	☐	Type reference (TYPE)	UAP_BOOLEAN	SPACE	Boolean	20010309
4	Importing	IM_INDEX	Call by reference	☐	Type reference (TYPE)	UAP_BOOLEAN	SPACE	Boolean	20010213
5	Importing	IM_REPID	Call by reference	☐	Type reference (TYPE)	SY-REPID		Programmname	20000117
6	Importing	IM_SEARCH	Call by reference	☐	Type reference (TYPE)	UAP_BOOLEAN	SPACE	Boolean	20010213

Method CONSTRUCTOR on class CL_UAP_TREE_NAVIGATION has no exception.

Method CREATE_TREE_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_NODE	Call by reference	☐	Object reference (TYPE REF TO)	CL_UAP_NAVIGATION_NODE		Navigationsknoten	20010215
2	Returning	RE_TREE_NODE	Value transfer	☐	Type reference (TYPE)	MTREESNODE		Knotenstruktur eines Simple Trees (Report saptrex3)	20010215

Method CREATE_TREE_NODE on class CL_UAP_TREE_NAVIGATION has no exception.

Method DELETE_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ALL	Call by reference	☐	Type reference (TYPE)	UAP_BOOLEAN	SPACE	alle Vorkommen	20010212
2	Importing	IM_NODES	Call by reference	☐	Type reference (TYPE)	UAP_NODES		Knoten für Navigation	20010130
3	Importing	IM_ONLY_FAVORITES	Call by reference	☐	Type reference (TYPE)	UAP_BOOLEAN	SPACE	Boolean	20010309

Method DELETE_NODES on class CL_UAP_TREE_NAVIGATION has no exception.

Method DROP_IS_ALLOWED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DESTINATION	Value transfer	☐	Object reference (TYPE REF TO)	CL_UAP_NAVIGATION_NODE		Navigationsknoten	20010207
2	Importing	IM_SOURCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_UAP_NAVIGATION_NODE		Navigationsknoten	20010207
3	Returning	RE_RESULT	Value transfer	☐	Type reference (TYPE)	UAP_BOOLEAN		Boolean	20010207

Method DROP_IS_ALLOWED on class CL_UAP_TREE_NAVIGATION has no exception.

Method EXPAND_TREE Signature

Method EXPAND_TREE on class CL_UAP_TREE_NAVIGATION has no parameter.
Method EXPAND_TREE on class CL_UAP_TREE_NAVIGATION has no exception.

Method GET_EXTENSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_EXTENSION	Value transfer	☐	Type reference (TYPE)	I		Breite	20000620

Method GET_EXTENSION on class CL_UAP_TREE_NAVIGATION has no exception.

Method GET_SELECTED_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_NODE	Value transfer	☐	Object reference (TYPE REF TO)	CL_UAP_NAVIGATION_NODE		Navigationsknoten	20010313

Method GET_SELECTED_NODE on class CL_UAP_TREE_NAVIGATION has no exception.

Method HANDLE_CMENU_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MENU	Call by reference	☐	Type reference (TYPE)				20001201
2	Importing	NODE_KEY	Call by reference	☐	Attribute reference (LIKE)				20010109

Method HANDLE_CMENU_REQUEST on class CL_UAP_TREE_NAVIGATION has no exception.

Method HANDLE_CMENU_SELECT Signature

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

Method HANDLE_CMENU_SELECT on class CL_UAP_TREE_NAVIGATION has no exception.

Method HANDLE_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)			NODE_KEY	20001201

Method HANDLE_DOUBLE_CLICK on class CL_UAP_TREE_NAVIGATION has no exception.

Method HANDLE_DRAG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DRAG_DROP_OBJECT	Call by reference	☐	Attribute reference (LIKE)				20010123
2	Importing	NODE_KEY	Call by reference	☐	Attribute reference (LIKE)				20010123

Method HANDLE_DRAG on class CL_UAP_TREE_NAVIGATION has no exception.

Method HANDLE_DROP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DRAG_DROP_OBJECT	Call by reference	☐	Attribute reference (LIKE)				20010123
2	Importing	NODE_KEY	Call by reference	☐	Attribute reference (LIKE)				20010123

Method HANDLE_DROP on class CL_UAP_TREE_NAVIGATION has no exception.

Method INCLUDE_SEARCH Signature

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

Method INCLUDE_SEARCH on class CL_UAP_TREE_NAVIGATION has no exception.

Method INCLUDE_TOOLBAR Signature

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

Method INCLUDE_TOOLBAR on class CL_UAP_TREE_NAVIGATION has no exception.

Method INCLUDE_TREE Signature

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

Method INCLUDE_TREE on class CL_UAP_TREE_NAVIGATION has no exception.

Method INIT_TREE Signature

Method INIT_TREE on class CL_UAP_TREE_NAVIGATION has no parameter.
Method INIT_TREE on class CL_UAP_TREE_NAVIGATION has no exception.

Method INSERT_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_NODES	Value transfer	☐	Type reference (TYPE)	UAP_NODES		Knoten für Navigation	20010124

Method INSERT_NODES on class CL_UAP_TREE_NAVIGATION has no exception.

Method IS_ACTIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_RESULT	Value transfer	☐	Type reference (TYPE)	OS_BOOLEAN		Boolean	20000626

Method IS_ACTIVE on class CL_UAP_TREE_NAVIGATION has no exception.

Method LOCK_DRAG_DROP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DESTINATION	Value transfer	☐	Object reference (TYPE REF TO)	CL_UAP_NAVIGATION_NODE		Navigationsknoten	20010319
2	Importing	IM_SOURCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_UAP_NAVIGATION_NODE		Navigationsknoten	20010319
3	Returning	RE_MODE	Value transfer	☐	Type reference (TYPE)	CDCHNGIND		Art der Änderung (U, I, E, D)	20010319

Method LOCK_DRAG_DROP on class CL_UAP_TREE_NAVIGATION has no exception.

Method ON_KEY_CHANGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	EX_NEW_KEY	Call by reference	☐	Attribute reference (LIKE)				20010205

Method ON_KEY_CHANGED on class CL_UAP_TREE_NAVIGATION has no exception.

Method ON_SEARCH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ACTION	Call by reference	☐	Attribute reference (LIKE)				20010213
2	Importing	FRAME	Call by reference	☐	Attribute reference (LIKE)				20010213
3	Importing	GETDATA	Call by reference	☐	Attribute reference (LIKE)				20010213
4	Importing	POSTDATA	Call by reference	☐	Attribute reference (LIKE)				20010213
5	Importing	QUERY_TABLE	Call by reference	☐	Attribute reference (LIKE)				20010213

Method ON_SEARCH on class CL_UAP_TREE_NAVIGATION has no exception.

Method ON_TOOLBAR_DROPDOWN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FCODE	Call by reference	☐	Attribute reference (LIKE)				20010201
2	Importing	POSX	Call by reference	☐	Attribute reference (LIKE)				20010201
3	Importing	POSY	Call by reference	☐	Attribute reference (LIKE)				20010201

Method ON_TOOLBAR_DROPDOWN on class CL_UAP_TREE_NAVIGATION has no exception.

Method ON_TOOLBAR_SELECTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	FCODE	Call by reference	☐	Attribute reference (LIKE)				20010201

Method ON_TOOLBAR_SELECTION on class CL_UAP_TREE_NAVIGATION has no exception.

Method SEARCH_EQUAL_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_NODE	Call by reference	☐	Object reference (TYPE REF TO)	CL_UAP_NAVIGATION_NODE		Navigationsknoten	20010223
2	Returning	RE_NODES	Value transfer	☐	Type reference (TYPE)	UAP_NODES		Knoten für Navigation	20010223

Method SEARCH_EQUAL_NODES on class CL_UAP_TREE_NAVIGATION has no exception.

Event Signatures

Event CMENU_REQUESTED Signature
Event CMENU_REQUESTED on class CL_UAP_TREE_NAVIGATION has no parameter.
Event DROPDOWN_REQUESTED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	EX_OK_CODE	Exporting	Value transfer	☐	Type reference (TYPE)	UAP_OK		OK-Code	20010201

Event FUNCTION_SELECTION Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	EX_OK_CODE	Exporting	Value transfer	☐	Type reference (TYPE)	UAP_OK		OK-Code	20010201

Event NODE_SELECTION Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	EX_NODE	Exporting	Value transfer	☐	Object reference (TYPE REF TO)	CL_UAP_NAVIGATION_NODE		Navigationsknoten	20010201

History

Last changed by/on	SAP	20041006
SAP Release Created in