SAP ABAP Class /BCV/CL_UIF_PDF_PRINT (Printing PDF)

Hierarchy

☛ SAP_BS_FND (Software Component) SAP Business Suite Foundation
   ⤷ CA-EPT-BCV (Application Component) Business Context Viewer
     ⤷ /BCV/UIF (Package) BCV User Interface Layer

Properties

Class	/BCV/CL_UIF_PDF_PRINT
Short Description	Printing PDF
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	/BCV/UIF	BCV User Interface Layer
Created	20081203	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class /BCV/CL_UIF_PDF_PRINT has no forward declaration.

Interfaces

Class /BCV/CL_UIF_PDF_PRINT has no interface implemented.

Friends

Class /BCV/CL_UIF_PDF_PRINT has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CO_AMOUNT_COLUMNS_NOT_SET	Constant	Private	☐	Type reference (TYPE)	I	99	Max amount of Columns if not already set	20090319
2	CO_COLUMN_TITLE	Constant	Private	☐	Type reference (TYPE)	STRING	'COLTITLE'	Column heading	20081205
3	CO_COLUMN_WIDTH	Constant	Private	☐	Type reference (TYPE)	I	200	Width for String	20090319
4	CO_HEADER_LINE	Constant	Private	☐	Type reference (TYPE)	STRING	'TAB_HEADER'	Headings	20081205
5	CO_M	Constant	Public	☐	Type reference (TYPE)	CHAR1	'M'	Change to Multi Mode	20081205
6	CO_NL	Constant	Private	☐	Type reference (TYPE)	CHAR7	'…'	Unicode Character for New Line	20081205
7	CO_PP	Constant	Private	☐	Type reference (TYPE)	CHAR7	'…'	Unicode Character '...'	20081205
8	CO_ROW_INFO	Constant	Private	☐	Type reference (TYPE)	STRING	'ROW_INFO'	Information on Line (e.g. Color)	20081205
9	CO_TABLE_CELL	Constant	Private	☐	Type reference (TYPE)	STRING	'TAB_CELL'	Table Cell	20081205
10	CO_TABLE_ROW	Constant	Private	☐	Type reference (TYPE)	STRING	'TAB_ROW'	Table Line	20081205
11	CO_VALUE_CHAR	Constant	Private	☐	Type reference (TYPE)	STRING	'VALUE_C'	Value (Character)	20081205
12	CO_X	Constant	Public	☐	Type reference (TYPE)	XFELD	'X'	Checkbox	20081205
13	CO_XML_START	Constant	Private	☐	Type reference (TYPE)	STRING	''	Root of an XML Document	20081205
14	GT_PRINTING_XML	Static Attribute	Public	☐	Type reference (TYPE)	/BCV/T_UIF_STRING		Table of Strings	20090323
15	GV_MULTI	Static Attribute	Public	☐	Type reference (TYPE)	XFELD	SPACE	Formulare werden gebündelt	20081204

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_CLOSING_TAG	Instance method	Public	Method	Add Closing Tag	20081204
2	ADD_OPENING_TAG	Instance method	Public	Method	Adds an Opening Tag	20081204
3	ADD_VALUED_TAG	Instance method	Public	Method	Adds a Simple Tag with Value	20081204
4	CONVERT_XML_TO_UTF8	Instance method	Public	Method	Converts XML String to UTF8 XString	20081204
5	CONV_XML_TO_PDF	Instance method	Public	Method	Convert XML to PDF	20081204
6	GET_XML_START	Instance method	Public	Method	Generates Start of XML	20081204
7	XML_CREATE_PDF_DOCUMENT	Instance method	Public	Method	Test Method	20090213
8	XML_PDF_ADD_DOCUMENT_END	Instance method	Public	Method	Adds the End Tag for XML (PDF Document)	20081205
9	XML_PDF_ADD_DOCUMENT_START	Instance method	Public	Method	Create Head Information for XML	20081205
10	XML_PDF_ADD_HEAD_INFORMATION	Instance method	Public	Method	Add Header Information to XML for BCV	20081204
11	XML_PDF_ADD_PICTURE	Instance method	Public	Method	Add Picture Information	20081204
12	XML_PDF_ADD_TABLE	Instance method	Public	Method	Converts Table to an XML Fragment	20081205
13	XML_PDF_CONVERT_FCAT_FLIST	Instance method	Public	Method		20081205
14	XML_PDF_GET_FIELD_CATALOG	Instance method	Private	Method		20090116
15	XML_PDF_GET_FIELD_LIST	Instance method	Private	Method		20081204
16	XML_PDF_QUERY_VIEW_ADD	Instance method	Public	Method	Adds Input Table, Graphic, Output Table	20081205
17	_TEXTCELL	Instance method	Private	Method	Intern: Format Multiline Text Cell	20081204
18	_VAL2STR	Instance method	Private	Method	Intern: Prepare Value for Output	20081204

Events

Class /BCV/CL_UIF_PDF_PRINT has no event.

Types

Class /BCV/CL_UIF_PDF_PRINT 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	CV_XML	Call by reference	☐	Type reference (TYPE)	STRING		XML Data Stream	20081204
2	Importing	IV_TAG	Call by reference	☐	Type reference (TYPE)	STRING		XML Tag	20081204

Method ADD_CLOSING_TAG on class /BCV/CL_UIF_PDF_PRINT has no exception.

Method ADD_OPENING_TAG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_XML	Call by reference	☐	Type reference (TYPE)	STRING		XML Data Stream	20081204
2	Importing	IV_TAG	Call by reference	☐	Type reference (TYPE)	STRING		XML Tag	20081204

Method ADD_OPENING_TAG on class /BCV/CL_UIF_PDF_PRINT has no exception.

Method ADD_VALUED_TAG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_XML	Call by reference	☐	Type reference (TYPE)	STRING		XML Data Stream	20081204
2	Importing	IV_CONDENSE	Call by reference	☑	Type reference (TYPE)	XFELD		Remove Space (e.g. Sign in Case of Numeric Values)	20081204
3	Importing	IV_NO_CONV	Call by reference	☑	Type reference (TYPE)	XFELD		Value will not be converted	20081204
4	Importing	IV_NO_HIDE	Call by reference	☑	Type reference (TYPE)	XFELD		'<' Do Not Hide Symbol	20081204
5	Importing	IV_TAG	Call by reference	☐	Type reference (TYPE)	STRING		XML Tag	20081204
6	Importing	IV_VALUE	Call by reference	☐	Type reference (TYPE)	ANY		Value	20081204

Method ADD_VALUED_TAG on class /BCV/CL_UIF_PDF_PRINT 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	EV_UTF8	Call by reference	☐	Type reference (TYPE)	XSTRING		XML in UTF-8 Format	20081204
2	Importing	IV_KEEP_TRAILING_BLANKS	Call by reference	☐	Type reference (TYPE)	XFELD	CO_X	Convert Spaces Before a Tag to Hard Spaces	20081204
3	Importing	IV_XML	Call by reference	☐	Type reference (TYPE)	STRING		XML Data Stream	20081204

Method CONVERT_XML_TO_UTF8 on class /BCV/CL_UIF_PDF_PRINT has no exception.

Method CONV_XML_TO_PDF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_ERROR_TEXT	Call by reference	☐	Type reference (TYPE)	STRING		Error Text	20081204
2	Exporting	EV_PDF	Call by reference	☐	Type reference (TYPE)	XSTRING		PDF Document (Not When Printing)	20081204
3	Importing	IV_FORM_NAME	Call by reference	☐	Type reference (TYPE)	FPWBFORMNAME		PDF-Based Forms: Form Name	20081204
4	Importing	IV_MULTI_END	Call by reference	☑	Type reference (TYPE)	XFELD		Get E_PDF After Bundeling	20081204
5	Importing	IV_MULTI_START	Call by reference	☑	Type reference (TYPE)	XFELD		Bundle Several Forms (No Return of E_PDF)	20081204
6	Importing	IV_PREVIEW	Call by reference	☑	Type reference (TYPE)	XFELD		Print with Preview	20081204
7	Importing	IV_PRINT	Call by reference	☑	Type reference (TYPE)	XFELD		Direct Printing Without Preview	20081204
8	Importing	IV_PRINT_PARAMETER	Call by reference	☑	Type reference (TYPE)	SFPOUTPUTPARAMS		Print Parameter (Overwrites I_PREVIEW / I_PRINT)	20081204
9	Importing	IV_RESTRICT_CHANGES	Call by reference	☑	Type reference (TYPE)	FPCHANGESRESTRICTED		Restricted Editing Options for PDF Document	20081204
10	Importing	IV_XML	Call by reference	☐	Type reference (TYPE)	XSTRING		XML Datastream in UTF-8 Format	20081204

#	Exception	Resumable	Description	Created on
1	INTERNAL_ERROR	☐	Internal Error	20081204

Method GET_XML_START Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EV_XML	Value transfer	☐	Type reference (TYPE)	STRING		XML Data Str.	20081205

Method GET_XML_START on class /BCV/CL_UIF_PDF_PRINT has no exception.

Method XML_CREATE_PDF_DOCUMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_PDF	Call by reference	☐	Type reference (TYPE)	XSTRING		PDF file (XSTRING)	20090213
2	Importing	IS_HEAD_DATA	Call by reference	☐	Type reference (TYPE)	/BCV/S_UIF_QVIEW_HEAD		Structure for Query Views	20090220
3	Importing	IS_PRINT_PARAM	Call by reference	☐	Type reference (TYPE)	/BCV/S_UIF_PRINT_PAR		Structure of Printing Parameters for Forms	20090213
4	Importing	IT_QUERY_INPUT	Call by reference	☐	Type reference (TYPE)	ANY TABLE		Query Input Table	20090213
5	Importing	IT_QUERY_RESULT	Call by reference	☑	Type reference (TYPE)	ANY TABLE		Query Result Table	20090213
6	Importing	IT_QUERY_RESULT_FIELD_LIST	Call by reference	☑	Type reference (TYPE)	/BCV/T_UIF_PDF_FIELD_LIST		Field Catalog for Query Result	20090326
7	Importing	IV_BUSINESS_PIC	Call by reference	☑	Type reference (TYPE)	XSTRING		Business Graphic	20090213
8	Importing	IV_PIC_DESCR	Call by reference	☑	Type reference (TYPE)	STRING		Business Graphic Description	20090213

Method XML_CREATE_PDF_DOCUMENT on class /BCV/CL_UIF_PDF_PRINT has no exception.

Method XML_PDF_ADD_DOCUMENT_END Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_XML	Call by reference	☐	Type reference (TYPE)	STRING		XML Data Stream	20081205

Method XML_PDF_ADD_DOCUMENT_END on class /BCV/CL_UIF_PDF_PRINT has no exception.

Method XML_PDF_ADD_DOCUMENT_START Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_XML	Call by reference	☐	Type reference (TYPE)	STRING		XML Data Stream	20081205

Method XML_PDF_ADD_DOCUMENT_START on class /BCV/CL_UIF_PDF_PRINT has no exception.

Method XML_PDF_ADD_HEAD_INFORMATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_XML	Call by reference	☐	Type reference (TYPE)	STRING		XML Data Stream	20081204

Method XML_PDF_ADD_HEAD_INFORMATION on class /BCV/CL_UIF_PDF_PRINT has no exception.

Method XML_PDF_ADD_PICTURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_XML	Call by reference	☐	Type reference (TYPE)	STRING		XML Data Stream	20081204
2	Importing	IV_PIC_DATA	Call by reference	☐	Type reference (TYPE)	XSTRING		Business Graphic	20081204
3	Importing	IV_TITEL	Call by reference	☑	Type reference (TYPE)	STRING		Business Graphic Description	20081204

Method XML_PDF_ADD_PICTURE on class /BCV/CL_UIF_PDF_PRINT has no exception.

Method XML_PDF_ADD_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_XML	Call by reference	☐	Type reference (TYPE)	STRING		XML Data Stream	20081205
2	Exporting	ET_FIELD_LIST	Call by reference	☐	Type reference (TYPE)	/BCV/T_UIF_PDF_FIELD_LIST		Field List with Headings	20090116
3	Importing	IT_FIELD_CATALOG	Call by reference	☑	Type reference (TYPE)	LVC_T_FCAT		Field List with Headings	20090116
4	Importing	IT_QUERY_RESULT_FIELD_LIST	Call by reference	☑	Type reference (TYPE)	/BCV/T_UIF_PDF_FIELD_LIST		Field Catalog	20090326
5	Importing	IT_TABLE	Call by reference	☐	Type reference (TYPE)	ANY TABLE		ABAP Table	20081205
6	Importing	IV_IGNORE_EMPTY_COLUMNS	Call by reference	☑	Type reference (TYPE)	XFELD		Ignore Empty Columns	20090216
7	Importing	IV_NO_COLTITLES	Call by reference	☑	Type reference (TYPE)	XFELD		Do Not Generate Column Headings	20081205
8	Importing	IV_NO_INITIALS	Call by reference	☑	Type reference (TYPE)	XFELD		Display Initial Values as Spaces	20081205
9	Importing	IV_NUMBER_OF_CHARS	Call by reference	☑	Type reference (TYPE)	I		Maximal Number of Chars per Line	20081205
10	Importing	IV_OPTIMIZE_COLUMNS	Call by reference	☑	Type reference (TYPE)	XFELD		Optimize Widths of All Columns	20081205
11	Importing	IV_ROWINFO_COLUMN	Call by reference	☑	Type reference (TYPE)	LVC_FNAME		Column with Content for Tag: ROW_INFO	20081205
12	Importing	IV_ROWINFO_COL_EVEN	Call by reference	☑	Type reference (TYPE)	STRING		ROW_INFO in Case of Even Lines	20081205
13	Importing	IV_ROWINFO_COL_ODD	Call by reference	☑	Type reference (TYPE)	STRING		ROW_INFO in Case of Odd Lines	20081205
14	Importing	IV_STRUCTURE_NAME	Call by reference	☑	Type reference (TYPE)	STRUKNAME		Name of a Structure	20081205
15	Importing	IV_TAG	Call by reference	☐	Type reference (TYPE)	STRING		XML Tag	20081205

Method XML_PDF_ADD_TABLE on class /BCV/CL_UIF_PDF_PRINT has no exception.

Method XML_PDF_CONVERT_FCAT_FLIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_FIELD_LIST	Call by reference	☐	Type reference (TYPE)	/BCV/T_UIF_PDF_FIELD_LIST		Field Catalog	20081205
2	Importing	IT_FIELD_CATALOG	Call by reference	☐	Type reference (TYPE)	LVC_T_FCAT		Field Catalog for List Viewer Control	20081205

Method XML_PDF_CONVERT_FCAT_FLIST on class /BCV/CL_UIF_PDF_PRINT has no exception.

Method XML_PDF_GET_FIELD_CATALOG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_FIELD_CATALOG	Call by reference	☐	Type reference (TYPE)	LVC_T_FCAT		Field Catalog	20090116
2	Importing	IT_ANY_TABLE	Call by reference	☐	Type reference (TYPE)	ANY TABLE		Table	20090116
3	Importing	IV_AMOUNT	Call by reference	☐	Type reference (TYPE)	I		Maximum Number of Columns	20090116

Method XML_PDF_GET_FIELD_CATALOG on class /BCV/CL_UIF_PDF_PRINT has no exception.

Method XML_PDF_GET_FIELD_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_FIELD_LIST	Call by reference	☐	Type reference (TYPE)	/BCV/T_UIF_PDF_FIELD_LIST		Field Catalog	20090116
2	Importing	IT_ANY_TABLE	Call by reference	☐	Type reference (TYPE)	ANY TABLE		Table	20081204
3	Importing	IV_AMOUNT	Call by reference	☐	Type reference (TYPE)	I		Maximum Number of Columns	20081204

Method XML_PDF_GET_FIELD_LIST on class /BCV/CL_UIF_PDF_PRINT has no exception.

Method XML_PDF_QUERY_VIEW_ADD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_XML	Call by reference	☐	Type reference (TYPE)	STRING		XML Data Stream	20081205
2	Importing	IS_HEAD_DATA	Call by reference	☐	Type reference (TYPE)	/BCV/S_UIF_QVIEW_HEAD		Structure for Query Views	20090220
3	Importing	IT_QUERY_INPUT	Call by reference	☑	Type reference (TYPE)	STANDARD TABLE		Query Input Table	20081205
4	Importing	IT_QUERY_RESULT	Call by reference	☑	Type reference (TYPE)	STANDARD TABLE		Query Result Table	20081205
5	Importing	IT_QUERY_RESULT_FIELD_CATALOG	Call by reference	☑	Type reference (TYPE)	LVC_T_FCAT		Field Catalog for Query Result	20090116
6	Importing	IT_QUERY_RESULT_FIELD_LIST	Call by reference	☑	Type reference (TYPE)	/BCV/T_UIF_PDF_FIELD_LIST		Field List for Query Result	20081205
7	Importing	IV_BUSINESS_PIC	Call by reference	☑	Type reference (TYPE)	XSTRING		Business Graphic	20081205
8	Importing	IV_BUSINESS_PIC_DESCR	Call by reference	☑	Type reference (TYPE)	STRING		Business Graphic Description	20081205
9	Importing	IV_CHAR_AMOUNT	Call by reference	☑	Type reference (TYPE)	I		Maximum Number of Characters per Row	20090204
10	Importing	IV_COL_AMOUNT	Call by reference	☑	Type reference (TYPE)	I		Maximum Number of Columns	20081205
11	Importing	IV_ROW_AMOUNT	Call by reference	☑	Type reference (TYPE)	I		Maximum Number of Rows	20081205

Method XML_PDF_QUERY_VIEW_ADD on class /BCV/CL_UIF_PDF_PRINT has no exception.

Method _TEXTCELL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_TEXT	Call by reference	☐	Type reference (TYPE)	STRING		Text to be Converted	20081204
2	Exporting	EV_LINES	Call by reference	☐	Type reference (TYPE)	I		Number of Lines in Result	20081204
3	Exporting	EV_MAX_WIDTH	Call by reference	☐	Type reference (TYPE)	I		Actual Column Width	20081204
4	Importing	IV_DATA_TYPE	Call by reference	☐	Type reference (TYPE)	INTTYPE		ABAP Data Type (C,D,N,...)	20081204
5	Importing	IV_FROM_BEGIN	Call by reference	☐	Type reference (TYPE)	INT1		Number of Lines to be Adopted from Beginning	20081204
6	Importing	IV_TO_END	Call by reference	☐	Type reference (TYPE)	INT1		Number of Lines to be Adopted from End	20081204
7	Importing	IV_WIDTH	Call by reference	☐	Type reference (TYPE)	I		Column Width	20081204

Method _TEXTCELL on class /BCV/CL_UIF_PDF_PRINT has no exception.

Method _VAL2STR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_LEN	Call by reference	☐	Type reference (TYPE)	INT4		Natural number	20081204
2	Exporting	EV_LINES	Call by reference	☐	Type reference (TYPE)	INT4		Natural number	20081204
3	Exporting	EV_VAL	Call by reference	☐	Type reference (TYPE)	STRING			20081204
4	Importing	IS_DATA	Call by reference	☐	Type reference (TYPE)	ANY			20081204
5	Importing	IS_FCAT	Call by reference	☐	Type reference (TYPE)	/BCV/S_UIF_PDF_FIELD_LIST		Field Catalog	20081204
6	Importing	IV_NO_INITIALS	Call by reference	☐	Type reference (TYPE)	XFELD		Checkbox	20081204

Method _VAL2STR on class /BCV/CL_UIF_PDF_PRINT has no exception.

History

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