SAP ABAP Class CL_WDR_DOCU_UTILITY (Web Dynpro ABAP: Read Various SAPscript Texts)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ BC-WD-ABA-RUN (Application Component) Web Dynpro ABAP Runtime
     ⤷ SWDP_RUNTIME_CORE (Package) Web Dynpro Runtime: Core Functions

Properties

Class	CL_WDR_DOCU_UTILITY
Short Description	Web Dynpro ABAP: Read Various SAPscript Texts
Super Class
Instantiability of a Class	1	Protected
Final	☑

General Data

Message Class
Program status
Category	0
Package	SWDP_RUNTIME_CORE	Web Dynpro Runtime: Core Functions
Created	20050819	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_WDR_DOCU_UTILITY has no interface implemented.

Friends

Class CL_WDR_DOCU_UTILITY has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	C_DOCU_PART	Constant	Public	☐	See coding				20060622
2	M_INSTANCE	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_WDR_DOCU_UTILITY		Docu for WebDynpro ABAP	20060622

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_DOCU_EXIST	Instance method	Public	Method	Check whether a message has a long text	20070515
2	FIND_DOCU_PART	Instance method	Private	Method	Cut out parts of SAPscript documentation	20060622
3	GET_DTEL_DOCU	Instance method	Public	Method	SapScript Documentation for a Data Element	20060622
4	GET_DTEL_DOCU_AS_WAD_TEXT	Instance method	Public	Method	SapScript docu for a data element formatted with WAD tags	20060629
5	GET_EXCEPTION_DOCU	Instance method	Public	Method	Long Text for an Exception	20060629
6	GET_GENERAL_DOCU	Instance method	Public	Method	General SapScript Documentation	20060629
7	GET_GENERAL_DOCU_AS_FMT_TEXT	Instance method	Public	Method	SapScript Docu of a General Text Formatted with Format Tags	20110128
8	GET_GENERAL_DOCU_AS_WAD_TEXT	Instance method	Public	Method	SapScript docu for a general test formatted with WAD tags	20070305
9	GET_INSTANCE	Static method	Public	Method	Returns instances for this class	20060622
10	GET_MESSAGE_DOCU	Instance method	Public	Method	Long Text of Message	20060629
11	GET_TABLEFIELD_DOCU	Instance method	Public	Method	SapScript Documentation for a Table Field	20060622

Events

Class CL_WDR_DOCU_UTILITY has no event.

Types

Class CL_WDR_DOCU_UTILITY has no local type.

Method Signatures

Method CHECK_DOCU_EXIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	DOCU_EXISTS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20070515
2	Exporting	DOCU_LANGU	Call by reference	☐	Type reference (TYPE)	SY-LANGU		Sprachenschlüssel der aktuellen Textumgebung	20070515
3	Importing	OBJECTID	Call by reference	☐	Type reference (TYPE)	DOKIL-OBJECT		Dokumentations-Objekt	20070515

Method CHECK_DOCU_EXIST on class CL_WDR_DOCU_UTILITY has no exception.

Method FIND_DOCU_PART Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	DOCU_PART_LINES	Value transfer	☐	Type reference (TYPE)	TLINETAB		Lines of ITF	20060622
2	Importing	DOC_LINES	Call by reference	☐	Type reference (TYPE)	TLINETAB		Lines of ITF	20060622
3	Importing	DOC_PART	Call by reference	☑	Type reference (TYPE)	STRING			20060622

Method FIND_DOCU_PART on class CL_WDR_DOCU_UTILITY has no exception.

Method GET_DTEL_DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DATAELEMENT	Call by reference	☐	Type reference (TYPE)	STRING			20060622
2	Importing	DOCU_PART	Call by reference	☑	Type reference (TYPE)	STRING	SPACE	Werte siehe cl_wdr_docu_utilities->c_docu_part	20060622
3	Exporting	HEADER	Call by reference	☐	Type reference (TYPE)	THEAD		SAPscript: Text-Header	20060629
4	Importing	LANGU	Call by reference	☑	Type reference (TYPE)	SY-LANGU		Sprachenschlüssel	20060622
5	Exporting	LINES	Call by reference	☐	Type reference (TYPE)	TLINETAB		Tabelle von Strings	20060629

#	Exception	Resumable	Description	Created on
1	NO_DOCUMENTATION_AVAILABLE	☐	Keine Dokumenation verfügbar	20060622

Method GET_DTEL_DOCU_AS_WAD_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DATAELEMENT	Call by reference	☐	Type reference (TYPE)	STRING			20060629
2	Importing	DOCU_PART	Call by reference	☐	Type reference (TYPE)	STRING			20060629
3	Returning	WAD_TEXT	Value transfer	☐	Type reference (TYPE)	STRING			20060629

Method GET_DTEL_DOCU_AS_WAD_TEXT on class CL_WDR_DOCU_UTILITY has no exception.

Method GET_EXCEPTION_DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	HEADER	Call by reference	☐	Type reference (TYPE)	THEAD		SAPscript: Text-Header	20080924
2	Importing	IF_MESSAGE	Call by reference	☐	Object reference (TYPE REF TO)	IF_MESSAGE		Schnittstelle zum Zugriff auf Texte von Meldungsobjekten	20060629
3	Importing	LANGU	Call by reference	☑	Type reference (TYPE)	LANGU		Sprachenschlüssel	20060629
4	Exporting	LINES	Call by reference	☐	Type reference (TYPE)	TLINETAB		Lines of ITF	20060629

#	Exception	Resumable	Description	Created on
1	NO_DOCUMENTATION_AVAILABLE	☐	Keine Dokumentation verfügbar	20080618

Method GET_GENERAL_DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	HEADER	Call by reference	☐	Type reference (TYPE)	THEAD		SAPscript: Text-Header	20060629
2	Importing	ID	Call by reference	☐	Type reference (TYPE)	DOKU_ID		Dokumentenklasse	20060629
3	Importing	LANGU	Call by reference	☑	Type reference (TYPE)	SY-LANGU		Sprachenschlüssel der aktuellen Textumgebung	20060629
4	Exporting	LINES	Call by reference	☐	Type reference (TYPE)	TLINETAB		Lines of ITF	20060629
5	Importing	OBJECT	Call by reference	☐	Type reference (TYPE)	DOKU_OBJ		Dokumentations-Objekt	20060629

#	Exception	Resumable	Description	Created on
1	NO_DOCUMENTATION_AVAILABLE	☐		20060629

Method GET_GENERAL_DOCU_AS_FMT_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	FMT_TEXT	Value transfer	☐	Type reference (TYPE)	STRING			20110128
2	Importing	ID	Call by reference	☐	Type reference (TYPE)	DOKU_ID	'TX'	Dokumentenklasse	20110128
3	Importing	LANGU	Call by reference	☐	Type reference (TYPE)	SY-LANGU		Sprachenschlüssel der aktuellen Textumgebung	20110128
4	Importing	OBJECT	Call by reference	☐	Type reference (TYPE)	DOKU_OBJ		Dokumentations-Objekt	20110128

Method GET_GENERAL_DOCU_AS_FMT_TEXT on class CL_WDR_DOCU_UTILITY has no exception.

Method GET_GENERAL_DOCU_AS_WAD_TEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	ID	Call by reference	☐	Type reference (TYPE)	DOKU_ID	'TX'	Dokumentenklasse	20070305
2	Importing	LANGU	Call by reference	☐	Type reference (TYPE)	SY-LANGU		Sprachenschlüssel der aktuellen Textumgebung	20070305
3	Importing	OBJECT	Call by reference	☐	Type reference (TYPE)	DOKU_OBJ		Dokumentations-Objekt	20070305
4	Returning	WAD_TEXT	Value transfer	☐	Type reference (TYPE)	STRING			20070305

Method GET_GENERAL_DOCU_AS_WAD_TEXT on class CL_WDR_DOCU_UTILITY has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_WDR_DOCU_UTILITY		Doku für webDynpro ABAP	20060622

Method GET_INSTANCE on class CL_WDR_DOCU_UTILITY has no exception.

Method GET_MESSAGE_DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	HEADER	Call by reference	☐	Type reference (TYPE)	THEAD		SAPscript: Text-Header	20060629
2	Exporting	HELP_INFO	Call by reference	☐	Type reference (TYPE)	HELP_INFO		Übergabewerte für den Helpprozessor	20060629
3	Importing	LANGU	Call by reference	☑	Type reference (TYPE)	LANGU		Sprachenschlüssel	20060629
4	Exporting	LINES	Call by reference	☐	Type reference (TYPE)	TLINETAB		Lines of ITF	20060629
5	Importing	MESSAGE	Call by reference	☐	Type reference (TYPE)	SYMSG		Struktur der Message-Variablen	20060629

#	Exception	Resumable	Description	Created on
1	NO_DOCUMENTATION_AVAILABLE	☐		20060629

Method GET_TABLEFIELD_DOCU Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	DOCU_PART	Call by reference	☐	Type reference (TYPE)	STRING	SPACE		20060622
2	Importing	FIELDNAME	Call by reference	☐	Type reference (TYPE)	STRING			20060622
3	Exporting	HEADER	Call by reference	☐	Type reference (TYPE)	THEAD		SAPscript: Text-Header	20060629
4	Importing	LANGU	Call by reference	☑	Type reference (TYPE)	SY-LANGU		Sprachenschlüssel der aktuellen Textumgebung	20060622
5	Exporting	LINES	Call by reference	☐	Type reference (TYPE)	TLINETAB		Lines of ITF	20060629
6	Importing	TABNAME	Call by reference	☐	Type reference (TYPE)	STRING			20060622

#	Exception	Resumable	Description	Created on
1	NO_DOCUMENTATION_AVAILABLE	☐		20060622

History

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