SAP ABAP Class CL_AR_TREE (Archiving Factory - Tree)

Hierarchy

☛ SAP_ABA (Software Component) Cross-Application Component
   ⤷ CA-FS-ARE (Application Component) Archiving Engine
     ⤷ ARFA_ARCHIVING_FACTORY (Package) Archiving Factory

Properties

Class	CL_AR_TREE
Short Description	Archiving Factory - Tree
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	ARFA_ARCHIVING_FACTORY	Archiving Factory
Created	20050528	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ARFA	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	ICON	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_AR_TREE has no interface implemented.

Friends

Class CL_AR_TREE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CON_FUNC_CREATE	Constant	Private	☐	Type reference (TYPE)	SALV_DE_FUNCTION	'CREATE'	ALV Function	20060821
2	CON_FUNC_REFRESH	Constant	Private	☐	Type reference (TYPE)	SALV_DE_FUNCTION	'REFRESH'	ALV Function	20060918
3	M_TAH_ARNODES_MAP	Instance attribute	Private	☐	Type reference (TYPE)	TYP_TAH_ARNODE_MAP			20061120
4	O_TREE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SALV_TREE		Basis Class for Tree Structure	20050528
5	P_ACLAS_VISIBLE	Static Attribute	Public	☐	Type reference (TYPE)	XFELD		Archiving Class Visible/Not Visible	20050611
6	REF_MODEL	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_AR_TREE_MODEL		Model for Archiving Object Tree	20060818
7	S_REF_TREE	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_AR_TREE		Tree Handling	20060817
8	TAB_OUTPUT	Instance attribute	Private	☐	Type reference (TYPE)	TYP_T_AR_NODE		Amount of Class Nodes	20060817

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_FROM_ARNODE	Instance method	Private	Method	Add Node(s) from Model (Including Subtree)	20060822
2	ADD_NODE	Instance method	Private	Method	Add Node(s)	20050528
3	ADD_NODE_AS_SIBLING	Instance method	Private	Method	Add Node(s)	20060918
4	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20060817
5	DISPLAY	Instance method	Public	Method	Display tree	20060817
6	GET_ARNODE	Instance method	Public	Method	Determine Archiving Node(s)	20050528
7	GET_KEY	Instance method	Private	Method	Determine Node Key	20050530
8	GET_SELECTEDARNODE	Instance method	Public	Method	Determine Archiving Node(s)	20050528
9	GET_SELECTEDNODE	Instance method	Public	Method	Determine Selected Nodes	20050528
10	GET_TOP_NODE	Instance method	Public	Method		20060818
11	GET_TREENODE	Instance method	Public	Method		20060817
12	GET_TREENODES_FROM_NODE	Instance method	Public	Method	Determine Tree Nodes for Model Nodes	20060817
13	GET_TREENODE_FROM_KEY	Instance method	Private	Method		20060817
14	INIT	Instance method	Public	Method	Initiate Tree	20060817
15	INIT_FUNCTIONS	Instance method	Private	Method		20060818
16	ON_ADDED_FUNCTION	Instance method	Private	Event handling method		20060818
17	ON_CHANGEMODE_CHANGED	Instance method	Private	Event handling method	Activate/Deactivate Change Mode	20060818
18	ON_DOUBLE_CLICK	Instance method	Private	Event handling method		20060818
19	ON_NODES_DELETED	Instance method	Private	Event handling method		20060821
20	ON_NODE_CHANGED	Instance method	Private	Event handling method		20060824
21	ON_NODE_CREATED	Instance method	Private	Event handling method		20060822
22	SET_ACLAS_VISIBILITY	Instance method	Public	Method	Subtrees for Archiving Classes to Visible/Not Visible	20050611
23	S_GET_INSTANCE	Static method	Public	Method	Get Instance	20060817

Events

#	Event	Type	Visibility	Description	Created on
1	DOUBLE_CLICK	Instance Event (0)	Public (2)	Double-Click Node	20060818
2	FUNC_CALLED	Instance Event (0)	Public (2)	Fuction selected	20060818

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TYP_FCODE	Public	Type reference (TYPE)	SALV_DE_FUNCTION	ALV Function	20060818
2	TYP_STR_ARNODE_MAP	Private	See coding			20061120	BEGIN OF typ_str_arnode_map, ref_arnode TYPE REF TO cl_ar_node, node_key TYPE salv_de_node_key, END OF typ_str_arnode_map
3	TYP_TAB_NODEKEYS	Public	See coding			20060817	typ_tab_nodekeys TYPE STANDARD TABLE OF salv_de_node_key WITH DEFAULT KEY
4	TYP_TAB_TREENODES	Public	See coding			20060817	typ_tab_treenodes TYPE STANDARD TABLE OF REF TO cl_salv_node WITH DEFAULT KEY
5	TYP_TAH_ARNODE_MAP	Private	See coding			20061120	typ_tah_arnode_map TYPE HASHED TABLE OF typ_str_arnode_map WITH UNIQUE KEY ref_arnode

Method Signatures

Method ADD_FROM_ARNODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_REF_ARNODE	Call by reference	☐	Object reference (TYPE REF TO)	CL_AR_NODE			20060822

Method ADD_FROM_ARNODE on class CL_AR_TREE has no exception.

Method ADD_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	F_KEY_FATHER	Call by reference	☐	Type reference (TYPE)	SALV_DE_NODE_KEY		Knotenschlüssel	20050528
2	Returning	O_NODE	Value transfer	☐	Object reference (TYPE REF TO)	CL_SALV_NODE		Einzelnes Knotenobjekt der Baumstruktur	20050528

Method ADD_NODE on class CL_AR_TREE has no exception.

Method ADD_NODE_AS_SIBLING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_KEY_PREV_SIBLING	Call by reference	☐	Type reference (TYPE)	SALV_DE_NODE_KEY		Knotenschlüssel	20060918
2	Returning	REF_NODE	Value transfer	☐	Object reference (TYPE REF TO)	CL_SALV_NODE		Einzelnes Knotenobjekt der Baumstruktur	20060918

Method ADD_NODE_AS_SIBLING on class CL_AR_TREE has no exception.

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_AR_TREE has no parameter.
Method CLASS_CONSTRUCTOR on class CL_AR_TREE has no exception.

Method DISPLAY Signature

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

Method GET_ARNODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	O_ARNODE	Value transfer	☐	Object reference (TYPE REF TO)	CL_AR_NODE		Archiving Factory: Klassenknoten	20050528
2	Importing	O_NODE	Call by reference	☐	Object reference (TYPE REF TO)	CL_SALV_NODE		Einzelnes Knotenobjekt der Baumstruktur	20050528

Method GET_ARNODE on class CL_AR_TREE has no exception.

Method GET_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_REF_ARNODE	Call by reference	☐	Object reference (TYPE REF TO)	CL_AR_NODE		Einzelnes Knotenobjekt der Baumstruktur	20060919
2	Returning	R_KEY	Value transfer	☐	Type reference (TYPE)	SALV_DE_NODE_KEY		Knotenschlüssel	20060919

Method GET_KEY on class CL_AR_TREE has no exception.

Method GET_SELECTEDARNODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_REF_ARNODE	Value transfer	☐	Object reference (TYPE REF TO)	CL_AR_NODE		Archiving Factory: Klassenknoten	20060913

Method GET_SELECTEDARNODE on class CL_AR_TREE has no exception.

Method GET_SELECTEDNODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_REF_NODE	Value transfer	☐	Object reference (TYPE REF TO)	CL_SALV_NODE		Einzelnes Knotenobjekt der Baumstruktur	20060913

Method GET_SELECTEDNODE on class CL_AR_TREE has no exception.

Method GET_TOP_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_REF_TOPNODE	Value transfer	☐	Object reference (TYPE REF TO)	CL_SALV_NODE		Einzelnes Knotenobjekt der Baumstruktur	20060818

Method GET_TOP_NODE on class CL_AR_TREE has no exception.

Method GET_TREENODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_REF_NODE	Call by reference	☐	Object reference (TYPE REF TO)	CL_AR_NODE		Archiving Factory: Klassenknoten	20060817
2	Returning	R_REF_TREENODE	Value transfer	☐	Object reference (TYPE REF TO)	CL_SALV_NODE		Einzelnes Knotenobjekt der Baumstruktur	20060817

Method GET_TREENODE on class CL_AR_TREE has no exception.

Method GET_TREENODES_FROM_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_REF_NODE	Call by reference	☐	Object reference (TYPE REF TO)	CL_AR_NODE		Archiving Factory: Klassenknoten	20060817
2	Returning	R_TAB_NODES	Value transfer	☐	Type reference (TYPE)	TYP_TAB_TREENODES			20060817

Method GET_TREENODES_FROM_NODE on class CL_AR_TREE has no exception.

Method GET_TREENODE_FROM_KEY 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)	SALV_DE_NODE_KEY		Knotenschlüssel	20060817
2	Returning	R_REF_TREENODE	Value transfer	☐	Object reference (TYPE REF TO)	CL_SALV_NODE		Einzelnes Knotenobjekt der Baumstruktur	20060817

Method GET_TREENODE_FROM_KEY on class CL_AR_TREE has no exception.

Method INIT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_REF_CONTAINER	Call by reference	☐	Object reference (TYPE REF TO)	CL_GUI_CONTAINER			20060817
2	Importing	I_REF_MODEL	Call by reference	☐	Object reference (TYPE REF TO)	CL_AR_TREE_MODEL			20060818

Method INIT on class CL_AR_TREE has no exception.

Method INIT_FUNCTIONS Signature

Method INIT_FUNCTIONS on class CL_AR_TREE has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_SALV_EXISTING	☐	ALV: Allg. Fehlerklasse (wird bei Syntaxprüfung geprüft)	20060818
2	CX_SALV_WRONG_CALL	☐	ALV: Allg. Fehlerklasse (wird bei Syntaxprüfung geprüft)	20060818

Method ON_ADDED_FUNCTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	E_SALV_FUNCTION	Value transfer	☐	Attribute reference (LIKE)				20060818

Method ON_ADDED_FUNCTION on class CL_AR_TREE has no exception.

Method ON_CHANGEMODE_CHANGED Signature

Method ON_CHANGEMODE_CHANGED on class CL_AR_TREE has no parameter.
Method ON_CHANGEMODE_CHANGED on class CL_AR_TREE has no exception.

Method ON_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)				20060818

Method ON_DOUBLE_CLICK on class CL_AR_TREE has no exception.

Method ON_NODES_DELETED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	TAB_ROOT_NODES	Value transfer	☐	Attribute reference (LIKE)				20060821

Method ON_NODES_DELETED on class CL_AR_TREE has no exception.

Method ON_NODE_CHANGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	REF_NODE	Value transfer	☐	Attribute reference (LIKE)				20060824

Method ON_NODE_CHANGED on class CL_AR_TREE has no exception.

Method ON_NODE_CREATED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	REF_NODE	Value transfer	☐	Attribute reference (LIKE)				20060822

Method ON_NODE_CREATED on class CL_AR_TREE has no exception.

Method SET_ACLAS_VISIBILITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	P_VISIBLE	Call by reference	☐	Type reference (TYPE)	XFELD		Feld zum Ankreuzen	20050611

Method SET_ACLAS_VISIBILITY on class CL_AR_TREE has no exception.

Method S_GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_REF_TREE	Value transfer	☐	Object reference (TYPE REF TO)	CL_AR_TREE		Tree Handling	20060817

Method S_GET_INSTANCE on class CL_AR_TREE has no exception.

Event Signatures

Event DOUBLE_CLICK Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	REF_SELECTED_NODE	Exporting	Value transfer	☐	Object reference (TYPE REF TO)	CL_AR_NODE		Archiving Factory: Backend-Knoten	20060818

Event FUNC_CALLED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	FCODE	Exporting	Value transfer	☐	Type reference (TYPE)	TYP_FCODE		Funktionscode	20060818
2	REF_SELECTED_NODE	Exporting	Value transfer	☑	Object reference (TYPE REF TO)	CL_AR_NODE		Archiving Factory: Backend-Knoten	20060818

History

Last changed by/on	SAP	20110908
SAP Release Created in	40