SAP ABAP Class CL_ABAP_DOCU_TREE (Tree Structure of ABAP Docu)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-ABA-LA (Application Component) Syntax, Compiler, Runtime
     ⤷ SABAPDOCU (Package) ABAP Documentation Objects in ABAP Workbench

Properties

Class	CL_ABAP_DOCU_TREE
Short Description	Tree Structure of ABAP Docu
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SABAPDOCU	ABAP Documentation Objects in ABAP Workbench
Created	20080225	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

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

Interfaces

Class CL_ABAP_DOCU_TREE has no interface implemented.

Friends

Class CL_ABAP_DOCU_TREE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MSG_KEY	Static Attribute	Private	☐	Type reference (TYPE)	SCX_T100KEY			20080415
2	NODE_ICONS	Static Attribute	Private	☐	See coding				20080228
3	NODE_TEXTS	Static Attribute	Private	☐	See coding				20080225
4	RETRY_FLAG	Static Attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20100322

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_NODE_TABLE_DOCUMENTS	Static method	Public	Method		20080827
2	CHECK_NODE_TABLE_STRUCTURE	Static method	Public	Method	Checks Whether the Node Table is Built Correctly.	20080414
3	CHECK_NODE_TYPE_INSIDE	Static method	Public	Method	Checks Whether a Node Type Occurs in a Node Table	20080414
4	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20080228
5	CLEANUP_TEXT	Static method	Private	Method	Removes SAPscript Tags from Ttext	20080812
6	CREATE_NODE_TEXTS	Static method	Private	Method	Creates Node Text Table	20080225
7	GET_ABAP_DOCU_TREE	Static method	Public	Method	Gets node table	20090728
8	GET_NODE_IMAGE	Static method	Public	Method	Gets Node Icon By Way Of Node Type	20080414
9	GET_NODE_TABLE	Static method	Public	Method	Creates Node Table from Database Table	20080225
10	GET_NODE_TEXT	Static method	Public	Method	Provides Node Text	20080225
11	GET_NODE_TEXTS	Static method	Private	Method	Provides Node Text Table	20080225
12	GET_NODE_TYPE	Static method	Public	Method	Derives Node Type from Name of Document - Without FOL	20080414
13	GET_TEXT_FROM_ITF	Static method	Private	Method	Gets Text Lines from SAPscript	20080812
14	INITIALIZE_NODE	Static method	Public	Method	Sets Fixed Attributes of the Node	20080414
15	REFRESH_NODE_TEXTS	Static method	Public	Method	Inserts new text into the Text Table	20080815
16	SAVE_NODE_TABLE	Static method	Public	Method	Saves Database Table for Node Table	20080225

Events

Class CL_ABAP_DOCU_TREE has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	ITF_TABLE	Private	See coding			20080812	ITF_TABLE type STANDARD TABLE OF tline with NON-UNIQUE DEFAULT KEY WITHOUT FURTHER SECONDARY KEYS
2	NODE_ICON	Private	See coding			20080228	BEGIN OF node_icon, type TYPE abapdocu_tree-node_type, icon TYPE string, END OF node_icon
3	NODE_TEXT	Private	See coding			20080225	BEGIN OF node_text, node TYPE dokil-object, text TYPE string, END OF node_text

Method Signatures

Method CHECK_NODE_TABLE_DOCUMENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	A_NODE_TABLE	Call by reference	☐	Type reference (TYPE)	TREEMSNOTA			20080827
2	Exporting	RET	Call by reference	☐	Type reference (TYPE)	C			20080827
3	Exporting	RET_MSG	Call by reference	☐	Type reference (TYPE)	STRING			20080827

Method CHECK_NODE_TABLE_DOCUMENTS on class CL_ABAP_DOCU_TREE has no exception.

Method CHECK_NODE_TABLE_STRUCTURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	A_NODE_TABLE	Call by reference	☐	Type reference (TYPE)	TREEMSNOTA			20080414
2	Exporting	RET	Call by reference	☐	Type reference (TYPE)	C			20080414
3	Exporting	RET_MSG	Call by reference	☐	Type reference (TYPE)	STRING			20080414
4	Exporting	WRONG_NODE_KEY	Call by reference	☐	Type reference (TYPE)	TM_NODEKEY			20080414

Method CHECK_NODE_TABLE_STRUCTURE on class CL_ABAP_DOCU_TREE has no exception.

Method CHECK_NODE_TYPE_INSIDE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	A_NODE_KEY	Call by reference	☐	Type reference (TYPE)	TM_NODEKEY			20080414
2	Importing	A_NODE_TABLE	Call by reference	☐	Type reference (TYPE)	TREEMSNOTA			20080414
3	Importing	A_NODE_TYPE	Call by reference	☐	Type reference (TYPE)	ABDOCTYPE			20080414
4	Exporting	RET	Call by reference	☐	Type reference (TYPE)	C			20080414

Method CHECK_NODE_TYPE_INSIDE on class CL_ABAP_DOCU_TREE has no exception.

Method CLASS_CONSTRUCTOR Signature

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

Method CLEANUP_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	TEXT	Call by reference	☐	Type reference (TYPE)	CLIKE			20080812

Method CLEANUP_TEXT on class CL_ABAP_DOCU_TREE has no exception.

Method CREATE_NODE_TEXTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LANGU	Call by reference	☐	Type reference (TYPE)	SY-LANGU		Sprache	20080225
2	Importing	OLD_DATE	Value transfer	☐	Type reference (TYPE)	SY-DATUM	'00010101'		20080225
3	Importing	OLD_TIME	Value transfer	☐	Type reference (TYPE)	SY-UZEIT	'000000'		20080225

Method CREATE_NODE_TEXTS on class CL_ABAP_DOCU_TREE has no exception.

Method GET_ABAP_DOCU_TREE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LANGU	Call by reference	☐	Type reference (TYPE)	SY-LANGU			20090728
2	Returning	TREE_TAB	Value transfer	☐	Object reference (TYPE REF TO)	TREEMSNOTA			20090728

Method GET_ABAP_DOCU_TREE on class CL_ABAP_DOCU_TREE has no exception.

Method GET_NODE_IMAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	NODE_IMAGE	Value transfer	☐	Type reference (TYPE)	TV_IMAGE			20080414
2	Importing	NODE_KEY	Call by reference	☐	Type reference (TYPE)	TM_NODEKEY			20080414
3	Importing	NODE_TYPE	Value transfer	☑	Type reference (TYPE)	ABDOCTYPE			20090728

#	Exception	Resumable	Description	Created on
1	CX_ABAP_DOCU_TREE	☐		20080414

Method GET_NODE_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LANGU	Call by reference	☐	Type reference (TYPE)	SY-LANGU		Sprache	20080225

Method GET_NODE_TABLE on class CL_ABAP_DOCU_TREE has no exception.

Method GET_NODE_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LANGU	Call by reference	☐	Type reference (TYPE)	SY-LANGU			20080225
2	Returning	NODE_TEXT	Value transfer	☐	Type reference (TYPE)	STRING			20080225
3	Importing	OBJECT	Call by reference	☐	Type reference (TYPE)	DOKIL-OBJECT			20080225

#	Exception	Resumable	Description	Created on
1	CX_ABAP_DOCU_TREE	☐		20080414

Method GET_NODE_TEXTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LANGU	Call by reference	☐	Type reference (TYPE)	SY-LANGU		sparche	20080225

Method GET_NODE_TEXTS on class CL_ABAP_DOCU_TREE has no exception.

Method GET_NODE_TYPE 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			20080414
2	Returning	NODE_TYPE	Value transfer	☐	Type reference (TYPE)	ABDOCTYPE			20080414

#	Exception	Resumable	Description	Created on
1	CX_ABAP_DOCU_TREE	☐		20080414

Method GET_TEXT_FROM_ITF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	ITF	Call by reference	☐	Type reference (TYPE)	ITF_TABLE		Sapscript- Text	20080812
2	Importing	LANGU	Call by reference	☐	Type reference (TYPE)	SY-LANGU		Sprache	20080812
3	Importing	P_HEADER	Call by reference	☐	Type reference (TYPE)	THEAD		Header für Textinclude-Ersetzung	20080812
4	Exporting	TEXT_LINE	Value transfer	☐	Type reference (TYPE)	STRING		Text	20080812

Method GET_TEXT_FROM_ITF on class CL_ABAP_DOCU_TREE has no exception.

Method INITIALIZE_NODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	NODE	Call by reference	☐	Type reference (TYPE)	TREEMSNODT			20080414

Method INITIALIZE_NODE on class CL_ABAP_DOCU_TREE has no exception.

Method REFRESH_NODE_TEXTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	LANGU	Call by reference	☐	Type reference (TYPE)	SY-LANGU		Sprachenschlüssel	20080815
2	Importing	NODE_KEY	Call by reference	☐	Type reference (TYPE)	TM_NODEKEY		Schlüssel eines Knotens	20080815

Method REFRESH_NODE_TEXTS on class CL_ABAP_DOCU_TREE has no exception.

Method SAVE_NODE_TABLE 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)	TREEMSNOTA		Knotentabelle für Baumanzeige	20080225

Method SAVE_NODE_TABLE on class CL_ABAP_DOCU_TREE has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in	711