SAP ABAP Class CL_RSRA_GUI_COMPONENT_TREE (Tree Control with Toolbar in Reporting Agent UI)

Hierarchy

☛ SAP_BW (Software Component) SAP Business Warehouse
   ⤷ BW-BEX-ET (Application Component) End User Technology
     ⤷ RSRB (Package) BW: Batch Reporting

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_RSRA_GUI_COMPONENT	Component of Reporting Agent UI	20010611

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_RSRA_AVAILABLE_TREE_BM	Tree with the Available RA Settings + Toolbar	20020116
2	Inheritance (c INHERITING FROM c_ref)	CL_RSRA_AVAILABLE_TREE_MX	Tree with the Available RA Settings + Toolbar	20020409
3	Inheritance (c INHERITING FROM c_ref)	CL_RSRA_AVAILABLE_TREE_RA	Tree with the Available RA Settings + Toolbar	20020507

Properties

Class	CL_RSRA_GUI_COMPONENT_TREE
Short Description	Tree Control with Toolbar in Reporting Agent UI
Super Class	CL_RSRA_GUI_COMPONENT	Component of Reporting Agent UI
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	RSRB	BW: Batch Reporting
Created	20010611	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)
2	RS	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_RSRA_GUI_COMPONENT_TREE has no interface implemented.

Friends

Class CL_RSRA_GUI_COMPONENT_TREE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	O_R_CONTAINER_TOOLBAR	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Abstract Container for GUI Controls	20020116
2	O_R_CONTAINER_TREE	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Abstract Container for GUI Controls	20020116
3	O_R_CONTROL	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_GUI_CONTROL		Proxy Class for Control in GUI	20020117
4	O_R_SPLITTER	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_GUI_SPLITTER_CONTAINER		Splitter Control	20020116
5	O_R_TOOLBAR	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_GUI_TOOLBAR		Toolbar Control	20020116
6	O_R_TREE_MODEL	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_COLUMN_TREE_MODEL		Column Tree Control with Data Management at Backend	20020116
7	O_R_TREE_OBJECT	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	CL_RSRA_TREE_OBJECT		Object of a Tree in the Reporting Agent	20020117

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_OBJECTS	Instance method	Protected	Method	Add Objects	20020117
2	APPEND_NODE	Instance method	Protected	Method	Insert Group	20020117
3	COLLAPSE_ALL_NODES	Instance method	Protected	Method	Collapse All Nodes	20020117
4	CREATE_DRAGDROP	Instance method	Protected	Method	Initialize Drag&Drop Objects	20020412
5	CREATE_SPLITTER	Instance method	Protected	Method	Creates Toolbar / Tree Splitter Control	20020116
6	CREATE_TOOLBAR	Instance method	Protected	Method	Creates Toolbar Control	20020116
7	CREATE_TREE	Instance method	Protected	Method	Creates Tree Control	20020117
8	DISPLAY	Instance method	Public	Method	Display Control	20020117
9	EXECUTE_FUNCTION	Instance method	Protected	Method	Execute function	20020117
10	EXPAND_NODE	Instance method	Protected	Method	Expand Node	20020118
11	EXPAND_NODE_INTERNAL	Instance method	Protected	Method	Expand Node	20020118
12	EXPAND_NODE_RECURSIVE	Instance method	Protected	Method	Expand Root Nodes	20020712
13	EXPAND_ROOT_NODES	Instance method	Protected	Method	Expand Root Nodes	20020118
14	FREE	Instance method	Public	Method	Remove Control	20020117
15	GET_CHILDREN	Instance method	Protected	Method	Get Children of User Object	20020411
16	GET_EXPANDED_NODES	Instance method	Protected	Method	Delivers Expanded Nodes	20020121
17	GET_INITIAL_DATA	Instance method	Protected	Method	Read Data in Intial View	20020117
18	GET_ROOT_NODES	Instance method	Protected	Method	Delivers Root Nodes	20020118
19	LEVEL_OF_NODE	Instance method	Protected	Method	Delivers Hierarchy Level of a Node	20020121
20	NODE_GET_PARENT_USER_OBJECT	Instance method	Protected	Method	Delivers User Object of Parent Node	20020411
21	ON_DRAG	Instance method	Protected	Event handling method	Handler for Drag Event	20020412
22	ON_DROP	Instance method	Protected	Event handling method	Event Handler for Drop Event	20020412
23	ON_DROPDOWN_CLICKED_TOOLBAR	Instance method	Protected	Event handling method	Handler for Toolbar Event	20020116
24	ON_EXPAND_NO_CHILDREN	Instance method	Protected	Event handling method	Handler for Expand Event	20020118
25	ON_FUNCTION_SELECTED_TOOLBAR	Instance method	Protected	Event handling method	Handler for Toolbar Event	20020116
26	ON_NODE_CONTEXT_MENU_REQUEST	Instance method	Protected	Event handling method	Event Handler	20020410
27	ON_NODE_CONTEXT_MENU_SELECT	Instance method	Protected	Event handling method	Event Handler	20020117
28	ON_NODE_DOUBLE_CLICK	Instance method	Protected	Event handling method	Event handler	20020806
29	REFRESH	Instance method	Protected	Method	Refresh Tree	20020121
30	REFRESH_NODE	Instance method	Protected	Method	Refresh Node	20020411
31	SEARCH	Instance method	Public	Method	Find in Tree	20020515
32	SET_ROOT_LEVEL	Instance method	Protected	Method	Set Root Node	20020117
33	SET_TOOLBAR	Instance method	Protected	Method	Customize Toolbar	20020116
34	SET_TREE	Instance method	Protected	Method	Customize Tree	20020117

Events

Class CL_RSRA_GUI_COMPONENT_TREE has no event.

Types

Class CL_RSRA_GUI_COMPONENT_TREE has no local type.

Method Signatures

Method ADD_OBJECTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_PARENT_NODEKEY	Call by reference	☑	Type reference (TYPE)	TM_NODEKEY		Tree Model: Schlüssel eines Knotens	20020117
2	Importing	I_T_OBJECT	Call by reference	☐	Type reference (TYPE)	RSRA_T_OBJECT		Tabelle von Objektreferenzen	20020117

Method ADD_OBJECTS on class CL_RSRA_GUI_COMPONENT_TREE has no exception.

Method APPEND_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_T_ITEM	Call by reference	☐	Type reference (TYPE)	TREEMCITAC		Itemtabelle	20020117
2	Changing	C_T_NODE	Call by reference	☐	Type reference (TYPE)	TREEMCNOTA		Knotentabelle	20020117
3	Importing	I_NODEKEY	Call by reference	☐	Type reference (TYPE)	TM_NODEKEY		Tree Model: Schlüssel eines Knotens	20020117
4	Importing	I_PARENT_NODEKEY	Call by reference	☐	Type reference (TYPE)	TM_NODEKEY		Tree Model: Schlüssel eines Knotens	20020117
5	Importing	I_R_OBJECT	Call by reference	☐	Object reference (TYPE REF TO)	CL_RSRA_TREE_OBJECT		Tree-Objekt	20020117

Method APPEND_NODE on class CL_RSRA_GUI_COMPONENT_TREE has no exception.

Method COLLAPSE_ALL_NODES Signature

Method COLLAPSE_ALL_NODES on class CL_RSRA_GUI_COMPONENT_TREE has no parameter.
Method COLLAPSE_ALL_NODES on class CL_RSRA_GUI_COMPONENT_TREE has no exception.

Method CREATE_DRAGDROP Signature

Method CREATE_DRAGDROP on class CL_RSRA_GUI_COMPONENT_TREE has no parameter.
Method CREATE_DRAGDROP on class CL_RSRA_GUI_COMPONENT_TREE has no exception.

Method CREATE_SPLITTER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_R_CONTAINER	Call by reference	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER		Container fuer Custom Controls in der Dynpro Area	20020116

Method CREATE_SPLITTER on class CL_RSRA_GUI_COMPONENT_TREE has no exception.

Method CREATE_TOOLBAR Signature

Method CREATE_TOOLBAR on class CL_RSRA_GUI_COMPONENT_TREE has no parameter.
Method CREATE_TOOLBAR on class CL_RSRA_GUI_COMPONENT_TREE has no exception.

Method CREATE_TREE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_S_HIERARCHY_HEADER	Call by reference	☐	Type reference (TYPE)	TREEMHHDR		Tree Model: Eigenschaften des Hierarchie Headers	20020117

Method CREATE_TREE on class CL_RSRA_GUI_COMPONENT_TREE has no exception.

Method DISPLAY Signature

Method DISPLAY on class CL_RSRA_GUI_COMPONENT_TREE has no parameter.
Method DISPLAY on class CL_RSRA_GUI_COMPONENT_TREE has no exception.

Method EXECUTE_FUNCTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_FCODE	Call by reference	☐	Type reference (TYPE)	SY-UCOMM		Funktionscode	20020117
2	Importing	I_NODE_KEY	Call by reference	☐	Type reference (TYPE)	TM_NODEKEY		Tree Model: Schlüssel eines Knotens	20020117

Method EXECUTE_FUNCTION on class CL_RSRA_GUI_COMPONENT_TREE has no exception.

Method EXPAND_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_EXPAND_LEVEL	Call by reference	☑	Type reference (TYPE)	I		Anzahl zu expandierender Level	20020118
2	Importing	I_EXPAND_SUBTREE	Call by reference	☐	Type reference (TYPE)	RS_BOOL	RS_C_FALSE	Alle Nachfahren expandieren	20020118
3	Importing	I_NODEKEY	Call by reference	☐	Type reference (TYPE)	TM_NODEKEY		Tree Model: Schlüssel eines Knotens	20020118
4	Importing	I_REFRESH	Call by reference	☑	Type reference (TYPE)	RS_BOOL		Daten neu beschaffen	20020411

#	Exception	Resumable	Description	Created on
1	NODE_NOT_FOUND	☐	Knoten nicht gefunden	20020118

Method EXPAND_NODE_INTERNAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_EXPAND_LEVEL	Call by reference	☑	Type reference (TYPE)	I		Anzahl zu expandierender Level	20020118
2	Importing	I_EXPAND_SUBTREE	Call by reference	☐	Type reference (TYPE)	RS_BOOL	RS_C_FALSE	Alle Nachfahren expandieren	20020118
3	Importing	I_NODEKEY	Call by reference	☐	Type reference (TYPE)	TM_NODEKEY		Tree Model: Schlüssel eines Knotens	20020118
4	Importing	I_REFRESH	Call by reference	☑	Type reference (TYPE)	RS_BOOL		Boolean	20020411

#	Exception	Resumable	Description	Created on
1	NODE_NOT_FOUND	☐	Knoten nicht gefunden	20020118

Method EXPAND_NODE_RECURSIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NODEKEY	Call by reference	☑	Type reference (TYPE)	TM_NODEKEY		Tree Model: Schlüssel eines Knotens	20020712

Method EXPAND_NODE_RECURSIVE on class CL_RSRA_GUI_COMPONENT_TREE has no exception.

Method EXPAND_ROOT_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_EXPAND_LEVEL	Call by reference	☑	Type reference (TYPE)	I			20020118
2	Importing	I_EXPAND_SUBTREE	Call by reference	☐	Type reference (TYPE)	RS_BOOL	RS_C_FALSE	Boolean	20020118

Method EXPAND_ROOT_NODES on class CL_RSRA_GUI_COMPONENT_TREE has no exception.

Method FREE Signature

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

Method GET_CHILDREN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_T_OBJECT	Call by reference	☐	Type reference (TYPE)	RSRA_T_OBJECT		Tabelle von Objektreferenzen	20020411
2	Importing	I_REFRESH	Call by reference	☑	Type reference (TYPE)	RS_BOOL		Boolean	20020411
3	Importing	I_R_OBJECT	Call by reference	☐	Object reference (TYPE REF TO)	OBJECT			20020411

Method GET_CHILDREN on class CL_RSRA_GUI_COMPONENT_TREE has no exception.

Method GET_EXPANDED_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_T_NODEKEY	Call by reference	☐	Type reference (TYPE)	TREEMNOTAB		Tree Model: Tabelle von Knotenschlüsseln	20020121

Method GET_EXPANDED_NODES on class CL_RSRA_GUI_COMPONENT_TREE has no exception.

Method GET_INITIAL_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_REFRESH	Call by reference	☑	Type reference (TYPE)	RS_BOOL		Auffrischen	20020704

Method GET_INITIAL_DATA on class CL_RSRA_GUI_COMPONENT_TREE has no exception.

Method GET_ROOT_NODES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_T_NODEKEY	Call by reference	☐	Type reference (TYPE)	TREEMNOTAB		Tree Model: Tabelle von Knotenschlüsseln	20020118

Method GET_ROOT_NODES on class CL_RSRA_GUI_COMPONENT_TREE has no exception.

Method LEVEL_OF_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NODEKEY	Call by reference	☐	Type reference (TYPE)	TM_NODEKEY		Tree Model: Schlüssel eines Knotens	20020121
2	Returning	R_LEVEL	Value transfer	☐	Type reference (TYPE)	RSRA_COUNTER		Numerierung der eindimensionalen Aufrisse	20020121

#	Exception	Resumable	Description	Created on
1	NODE_NOT_FOUND	☐	Knoten nicht gefunden	20020121

Method NODE_GET_PARENT_USER_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	NODE_KEY	Call by reference	☐	Type reference (TYPE)	TM_NODEKEY		Tree Model: Schlüssel eines Knotens	20020411
2	Exporting	USER_OBJECT	Value transfer	☐	Object reference (TYPE REF TO)	OBJECT			20020411

Method NODE_GET_PARENT_USER_OBJECT on class CL_RSRA_GUI_COMPONENT_TREE has no exception.

Method ON_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)				20020412
2	Importing	ITEM_NAME	Call by reference	☐	Attribute reference (LIKE)				20020412
3	Importing	NODE_KEY	Call by reference	☐	Attribute reference (LIKE)				20020412
4	Importing	SENDER	Call by reference	☐	Attribute reference (LIKE)				20020412

Method ON_DRAG on class CL_RSRA_GUI_COMPONENT_TREE has no exception.

Method ON_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)				20020412
2	Importing	NODE_KEY	Call by reference	☐	Attribute reference (LIKE)				20020412
3	Importing	SENDER	Call by reference	☐	Attribute reference (LIKE)				20020412

Method ON_DROP on class CL_RSRA_GUI_COMPONENT_TREE has no exception.

Method ON_DROPDOWN_CLICKED_TOOLBAR Signature

Method ON_DROPDOWN_CLICKED_TOOLBAR on class CL_RSRA_GUI_COMPONENT_TREE has no parameter.
Method ON_DROPDOWN_CLICKED_TOOLBAR on class CL_RSRA_GUI_COMPONENT_TREE has no exception.

Method ON_EXPAND_NO_CHILDREN 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)				20020118

Method ON_EXPAND_NO_CHILDREN on class CL_RSRA_GUI_COMPONENT_TREE has no exception.

Method ON_FUNCTION_SELECTED_TOOLBAR Signature

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

Method ON_FUNCTION_SELECTED_TOOLBAR on class CL_RSRA_GUI_COMPONENT_TREE has no exception.

Method ON_NODE_CONTEXT_MENU_REQUEST Signature

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

Method ON_NODE_CONTEXT_MENU_REQUEST on class CL_RSRA_GUI_COMPONENT_TREE has no exception.

Method ON_NODE_CONTEXT_MENU_SELECT Signature

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

Method ON_NODE_CONTEXT_MENU_SELECT on class CL_RSRA_GUI_COMPONENT_TREE has no exception.

Method ON_NODE_DOUBLE_CLICK 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)				20020806
2	Importing	SENDER	Call by reference	☐	Attribute reference (LIKE)				20020806

Method ON_NODE_DOUBLE_CLICK on class CL_RSRA_GUI_COMPONENT_TREE has no exception.

Method REFRESH Signature

Method REFRESH on class CL_RSRA_GUI_COMPONENT_TREE has no parameter.
Method REFRESH on class CL_RSRA_GUI_COMPONENT_TREE has no exception.

Method REFRESH_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NODE_KEY	Call by reference	☐	Type reference (TYPE)	TM_NODEKEY		Tree Model: Schlüssel eines Knotens	20020411

#	Exception	Resumable	Description	Created on
1	NODE_NOT_FOUND	☐	Knoten nicht gefunden	20020411

Method SEARCH Signature

Method SEARCH on class CL_RSRA_GUI_COMPONENT_TREE has no parameter.
Method SEARCH on class CL_RSRA_GUI_COMPONENT_TREE has no exception.

Method SET_ROOT_LEVEL Signature

Method SET_ROOT_LEVEL on class CL_RSRA_GUI_COMPONENT_TREE has no parameter.
Method SET_ROOT_LEVEL on class CL_RSRA_GUI_COMPONENT_TREE has no exception.

Method SET_TOOLBAR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DELETE	Call by reference	☐	Type reference (TYPE)	RS_BOOL	RS_C_TRUE	Boolean	20020409

Method SET_TOOLBAR on class CL_RSRA_GUI_COMPONENT_TREE has no exception.

Method SET_TREE Signature

Method SET_TREE on class CL_RSRA_GUI_COMPONENT_TREE has no parameter.
Method SET_TREE on class CL_RSRA_GUI_COMPONENT_TREE has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in	30A