SAP ABAP Class CL_CO_XMLTOOL (Methods for XML Processing)

Hierarchy

☛ BBPCRM (Software Component) BBPCRM
   ⤷ CRM-CIC (Application Component) Interaction Center WinClient
     ⤷ CO (Package) R/3 Application development: PP Production orders

Properties

Class	CL_CO_XMLTOOL
Short Description	Methods for XML Processing
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	CO	R/3 Application development: PP Production orders
Created	20070619	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_CO_XMLTOOL has no forward declaration.

Interfaces

Class CL_CO_XMLTOOL has no interface implemented.

Friends

Class CL_CO_XMLTOOL has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CON_COLUMN_TITLE	Constant	Private	☐	Type reference (TYPE)	STRING	'COLTITLE'	Column Heading	20070619
2	CON_HEADER_LINE	Constant	Private	☐	Type reference (TYPE)	STRING	'TAB_HEADER'	Headings	20070619
3	CON_M	Constant	Public	☐	Type reference (TYPE)	XFELD	'M'	Checkbox	20080630
4	CON_NL	Constant	Private	☐	Type reference (TYPE)	CHAR7	'…'	Unicode Character for New Line	20070619
5	CON_PP	Constant	Private	☐	Type reference (TYPE)	CHAR7	'…'	Unicode Character '...'	20070619
6	CON_ROW_INFO	Constant	Private	☐	Type reference (TYPE)	STRING	'ROW_INFO'	Information on Line (e.g. Color)	20070619
7	CON_S	Constant	Public	☐	Type reference (TYPE)	XFELD	'S'	Checkbox	20090217
8	CON_TABLE_CELL	Constant	Private	☐	Type reference (TYPE)	STRING	'TAB_CELL'	Table Cell	20070619
9	CON_TABLE_ROW	Constant	Private	☐	Type reference (TYPE)	STRING	'TAB_ROW'	Table Line	20070619
10	CON_VALUE_CHAR	Constant	Private	☐	Type reference (TYPE)	STRING	'VALUE_C'	Value (Character)	20070619
11	CON_X	Constant	Public	☐	Type reference (TYPE)	XFELD	'X'	Checkbox	20070619
12	CON_XML_START	Constant	Private	☐	Type reference (TYPE)	STRING	''	Root of an XML Document	20070619
13	G_DEBUG	Static Attribute	Public	☐	Type reference (TYPE)	XFELD	SPACE	Activate Debugger	20070619
14	G_MULTI	Static Attribute	Public	☑	Type reference (TYPE)	XFELD	SPACE	Forms Will Be Bundled	20080630

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_CLOSING_TAG	Static method	Public	Method	Adds a Closing Tag	20070619
2	ADD_OPENING_TAG	Static method	Public	Method	Adds an Opening Tag	20070619
3	ADD_TABLE	Static method	Public	Method	Converts Table to an XML Fragment	20070619
4	ADD_VALUED_TAG	Static method	Public	Method	Adds a Simple Tag with Value	20070619
5	CONVERT_XML_TO_UTF8	Static method	Public	Method	Converts XML String to UTF8 XString	20070619
6	CONV_XML_TO_PDF	Static method	Public	Method	Convert XML to PDF	20070619
7	DEBUG_XML	Static method	Public	Method	Convert Part XML to UTF-8 and Invoke Debugger	20070619
8	GET_XML_START	Static method	Public	Method	Generates Start of XML	20070619
9	_TEXTCELL	Static method	Private	Method	Intern: Format Multiline Text Cell	20070910
10	_VAL2STR	Static method	Private	Method	Intern: Prepare Value for Output	20070619

Events

Class CL_CO_XMLTOOL has no event.

Types

Class CL_CO_XMLTOOL has no local type.

Method Signatures

Method ADD_CLOSING_TAG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_XML	Call by reference	☐	Type reference (TYPE)	STRING		XML-Datenstrom	20070619
2	Importing	I_TAG	Call by reference	☐	Type reference (TYPE)	STRING		XML-TAG	20070619

Method ADD_CLOSING_TAG on class CL_CO_XMLTOOL has no exception.

Method ADD_OPENING_TAG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_XML	Call by reference	☐	Type reference (TYPE)	STRING		XML-Datenstrom	20070619
2	Importing	I_TAG	Call by reference	☐	Type reference (TYPE)	STRING		XML-TAG	20070619

Method ADD_OPENING_TAG on class CL_CO_XMLTOOL has no exception.

Method ADD_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_XML	Call by reference	☐	Type reference (TYPE)	STRING		XML-Datenstrom	20070619
2	Exporting	ET_FIELDS	Call by reference	☐	Type reference (TYPE)	COXML_T_FIELD_LIST		Feldliste mit Überschriften	20070619
3	Importing	IT_FIELDS	Call by reference	☑	Type reference (TYPE)	COXML_T_FIELD_LIST		Feldliste mit Überschriften	20070619
4	Importing	IT_TABLE	Call by reference	☐	Type reference (TYPE)	ANY TABLE		ABAP-Tabelle	20070619
5	Importing	I_NO_COLTITLES	Call by reference	☑	Type reference (TYPE)	XFELD		Keine Spaltenüberschriften erzeugen	20070619
6	Importing	I_NO_INITIALS	Call by reference	☑	Type reference (TYPE)	XFELD		Initiale Werte als Leerzeichen anzeigen	20070619
7	Importing	I_NO_INITIALS_LINE	Call by reference	☑	Type reference (TYPE)	XFELD		Initiale Zeilen als Leerzeichen anzeigen	20101028
8	Importing	I_OPTIMIZE_COLUMNS	Call by reference	☑	Type reference (TYPE)	XFELD		Breiten aller Spalten optimieren	20070619
9	Importing	I_ROWINFO_COLUMN	Call by reference	☑	Type reference (TYPE)	LVC_FNAME		Spalte mit Inhalt für TAG: ROW_INFO	20070619
10	Importing	I_ROWINFO_COL_EVEN	Call by reference	☑	Type reference (TYPE)	STRING		ROW_INFO bei geraden Zeilen	20070619
11	Importing	I_ROWINFO_COL_ODD	Call by reference	☑	Type reference (TYPE)	STRING		ROW_INFO bei ungeraden Zeilen	20070619
12	Importing	I_STRUCTURE_NAME	Call by reference	☑	Type reference (TYPE)	STRUKNAME		Name einer Struktur	20070619
13	Importing	I_TAG	Call by reference	☐	Type reference (TYPE)	STRING		XML-TAG	20070619

Method ADD_TABLE on class CL_CO_XMLTOOL has no exception.

Method ADD_VALUED_TAG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_XML	Call by reference	☐	Type reference (TYPE)	STRING		XML-Datenstrom	20070619
2	Importing	I_CONDENSE	Call by reference	☑	Type reference (TYPE)	XFELD		Leerzeichen (z.B. Vorzeichen bei Zahlenwerten) entfernen	20070619
3	Importing	I_NO_CONV	Call by reference	☑	Type reference (TYPE)	XFELD		Wert wird nicht konvertiert	20070913
4	Importing	I_NO_HIDE	Call by reference	☑	Type reference (TYPE)	XFELD		'<' Zeichen nicht verstecken	20080218
5	Importing	I_TAG	Call by reference	☐	Type reference (TYPE)	STRING		XML-TAG	20070619
6	Importing	I_VALUE	Call by reference	☐	Type reference (TYPE)	ANY		Wert	20070619

Method ADD_VALUED_TAG on class CL_CO_XMLTOOL has no exception.

Method CONVERT_XML_TO_UTF8 Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_UTF8	Call by reference	☐	Type reference (TYPE)	XSTRING		XML im UTF-8 Format	20070619
2	Importing	I_KEEP_TRAILING_BLANKS	Call by reference	☐	Type reference (TYPE)	XFELD	CON_X	Leerzeichen vor einem TAG in harte Leerzeichen umwandeln	20070619
3	Importing	I_XML	Call by reference	☐	Type reference (TYPE)	STRING		XML-Datenstrom	20070619

#	Exception	Resumable	Description	Created on
1	CX_PARAMETER_INVALID_RANGE	☐	Parameter mit ungültigem Wertebereich	20070619
2	CX_SY_CODEPAGE_CONVERTER_INIT	☐	System-Exception für Initialisierung Code Page Converter	20070619

Method CONV_XML_TO_PDF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ERROR_TEXT	Call by reference	☐	Type reference (TYPE)	STRING		Fehlertext	20070906
2	Exporting	E_PDF	Call by reference	☐	Type reference (TYPE)	XSTRING		PDF Dokument (nicht beim Drucken)	20070619
3	Importing	I_FORM_NAME	Call by reference	☐	Type reference (TYPE)	FPWBFORMNAME		PDF-basierte Formulare: Formularname	20070619
4	Importing	I_MULTI_END	Call by reference	☑	Type reference (TYPE)	XFELD		E_PDF nach Bündelung holen	20080630
5	Importing	I_MULTI_START	Call by reference	☑	Type reference (TYPE)	XFELD		Mehrere Formulare bündeln (keine Rückgabe von E_PDF)	20080630
6	Importing	I_MULTI_STITCH	Call by reference	☑	Type reference (TYPE)	XFELD		Zusammenfügen statt Bündeln	20090217
7	Importing	I_PREVIEW	Call by reference	☑	Type reference (TYPE)	XFELD		Drucken mit Vorschau	20070619
8	Importing	I_PRINT	Call by reference	☑	Type reference (TYPE)	XFELD		Direkt Drucken ohne Vorschau	20070901
9	Importing	I_PRINT_PARAMETER	Call by reference	☑	Type reference (TYPE)	SFPOUTPUTPARAMS		Druckparameter (überschreibt I_PREVIEW / I_PRINT)	20070904
10	Importing	I_RESTRICT_CHANGES	Call by reference	☑	Type reference (TYPE)	FPCHANGESRESTRICTED		Einschränkung der Änderungsmöglichkeiten des PDF-Dokuments	20080627
11	Importing	I_XML	Call by reference	☐	Type reference (TYPE)	XSTRING		XML-Datenstrom im UTF-8 Format	20070619

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Interner Fehler	20070619

Method DEBUG_XML Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_XML	Call by reference	☐	Type reference (TYPE)	STRING		XML-Datenstrom	20070619

Method DEBUG_XML on class CL_CO_XMLTOOL has no exception.

Method GET_XML_START Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_XML	Value transfer	☐	Type reference (TYPE)	STRING		XML-Datenstrom	20070619

Method GET_XML_START on class CL_CO_XMLTOOL has no exception.

Method _TEXTCELL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_TEXT	Call by reference	☐	Type reference (TYPE)	STRING		Zu konvertierender Text	20070910
2	Exporting	E_LINES	Call by reference	☐	Type reference (TYPE)	I		Anzahl Zeilen im Ergebnis	20070910
3	Exporting	E_MAX_WIDTH	Call by reference	☐	Type reference (TYPE)	I		Tatsächliche Spaltenbreite	20070914
4	Importing	I_DATA_TYPE	Call by reference	☐	Type reference (TYPE)	INTTYPE		ABAP-Datentyp (C,D,N,...)	20070914
5	Importing	I_FROM_BEGIN	Call by reference	☐	Type reference (TYPE)	INT1		Anzahl zu übernehmender Zeilen vom Anfang	20070910
6	Importing	I_TO_END	Call by reference	☐	Type reference (TYPE)	INT1		Anzahl zu übernehmender Zeilen zum Ende	20070910
7	Importing	I_WIDTH	Call by reference	☐	Type reference (TYPE)	I		Breite der Spalte	20070910

Method _TEXTCELL on class CL_CO_XMLTOOL has no exception.

Method _VAL2STR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_LEN	Call by reference	☐	Type reference (TYPE)	INT4		Breite ohne Leerzeichen	20070619
2	Exporting	E_LINES	Call by reference	☐	Type reference (TYPE)	INT4		Anzahl Ausgabezeilen	20070910
3	Exporting	E_VAL	Call by reference	☐	Type reference (TYPE)	STRING		Aufbereitete Ausgabe	20070619
4	Importing	IS_DATA	Call by reference	☐	Type reference (TYPE)	ANY		Tabellenzeile	20070619
5	Importing	IS_FCAT	Call by reference	☐	Type reference (TYPE)	COXML_S_FIELD_LIST		Feldkatalogzeile	20070619
6	Importing	I_NO_INITIALS	Call by reference	☐	Type reference (TYPE)	XFELD		Initiale Werte als Leerzeichen anzeigen	20070619

Method _VAL2STR on class CL_CO_XMLTOOL has no exception.

History

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