SAP ABAP Class CL_URDT_GENERATION_API (URDT Generation / Modifikation API)
Hierarchy
SAP_BASIS (Software Component) SAP Basis Component
   BC-CCM-PRN (Application Component) Print and Output Management
     SPOO (Package) Spool
Properties
Class CL_URDT_GENERATION_API  
Short Description URDT Generation / Modifikation API    
Super Class    
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package SPOO   Spool 
Created 20120924   SAP 
Last change 20140121   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)
2 CL_UPE_FONTMETRIC Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
3 CL_UPE_URDT Forward declaration class (CLASS c DEFINITION DEFERRED)  Forward declaration class (CLASS c DEFINITION DEFERRED)
Interfaces
Class CL_URDT_GENERATION_API has no interface implemented.
Friends
Class CL_URDT_GENERATION_API has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 ADD_CODEPOINT Constant Public Type reference (TYPE) I 2 20130503
2 ADD_TTF_CHARS Constant Public Type reference (TYPE) I 4 20130503
3 CHANGE_LISTFONT Constant Public Type reference (TYPE) I 5 20130503
4 MC_CANCEL_FONT_REPLACEMENT Constant Private Type reference (TYPE) CHAR1 '2' Single-Character Flag 20121122
5 MC_CONTINUE_FONT_REPLACEMENT Constant Private Type reference (TYPE) CHAR1 '1' Single-Character Flag 20121122
6 MC_MSG_ID Constant Public Type reference (TYPE) SY-MSGID 'UPE' Message Class 20121121
7 MO_GENERATION_UTIL Static Attribute Public Object reference (TYPE REF TO) IF_URDT_GENERATION_UTIL Help Methods 20121004
8 MO_LOGGER Static Attribute Public Object reference (TYPE REF TO) IF_URDT_GENERATION_LOGGER 20121129
9 MT_FONTMAPPING_REPO Static Attribute Public Type reference (TYPE) CL_UPE_FONTMETRIC=>T_FONTMAPTAB Table of font mappings 20120928
10 REPLACE_TTF Constant Public Type reference (TYPE) I 3 20130503
Methods
# Method Level Visibility Method type Description Created on
1 ADD_CODEPOINT_TO_URDT Static method Public Method Add a single codepoint to an existing URDT 20130111
2 ADD_TTFONT_CHARS_TO_URDT Static method Public Method Add all characters of a True Type Font to an existing URDT 20130114
3 AFTER_URDT_MODIFICATION Static method Private Method Finish copying URDT 20130115
4 CHANGE_ABAP_LISTFONT Static method Private Method 20130503
5 CHANGE_LISTFONT_OF_URDT Static method Public Method Change listfont of an existing URDT 20130114
6 CLASS_CONSTRUCTOR Static method Public Constructor CLASS_CONSTRUCTOR 20121004
7 COPY_URDT_AND_ADD_CODEPOINT Static method Public Method Copy URDT and add a single codepoint 20120924
8 COPY_URDT_AND_ADD_TTFONT_CHARS Static method Public Method Copy URDT and add all characters of a True Type Font 20121108
9 COPY_URDT_AND_CHANGE_LISTFONT Static method Public Method Copy URDT and change listfont 20121120
10 COPY_URDT_AND_REPLACE_TTFONT Static method Public Method Copy URDT and replace the True Type Font 20120927
11 CREATE_URDT_TARGET Static method Private Method Create new URDT target, add languages and copy listfont 20121121
12 GET_METRIC Static method Private Method Get metric of specified font 20121121
13 GET_URDT_DESCRIPTION Static method Private Method Returns description of given URDT 20130115
14 GUI_MESSAGE_SAPFONT_EDITING Static method Private Method Create a message in the GUI progress bar 20130117
15 LOCK_URDT Static method Private Method Lock an URDT 20130115
16 OPEN_REPLACEMENT_CHOICE_POPUP Static method Private Method Open popup to choose continue or cancel replacement 20121122
17 PREPARE_URDT_MODIFICATION Static method Private Method Prepare copy of URDT 20130115
18 PRINT_OUT_TRACE Static method Public Method Print out logging 20121108
19 REPLACE_TTFONT_IN_URDT Static method Public Method Replace a True Type Font in an existing URDT 20130114
20 TO_UCHAR Static method Private Method Converts an integer into an uchar 20121126
Events
Class CL_URDT_GENERATION_API has no event.
Types
Class CL_URDT_GENERATION_API has no local type.
Method Signatures

Method ADD_CODEPOINT_TO_URDT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_SELECTED_SAPFONTS Call by reference Type reference (TYPE) CL_UPE_URDT=>T_SAPFONTS Table of SAP fonts 20130111
2 Importing IV_FORCE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20130111
3 Importing IV_LOGGING Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20130111
4 Importing IV_PACKAGE Call by reference Type reference (TYPE) DEVCLASS SPACE Package 20130111
5 Importing IV_REQUEST Call by reference Type reference (TYPE) TRKORR SPACE Request/Task 20130111
6 Importing IV_TTFONT_INFO Call by reference Type reference (TYPE) TFRT_NAME Typeface Repo - Additional names of fonts 20130111
7 Importing IV_UCHAR Call by reference Type reference (TYPE) SCPUCHAR Unicode character 20130111
8 Importing IV_URDT Call by reference Type reference (TYPE) RSPOPTYPE Spool: Device type name 20130111
9 Returning RV_SUCCESSFUL Value transfer Type reference (TYPE) ABAP_BOOL 20130111
# Exception Resumable Description Created on
1 CX_URDT_GENERATION_ERROR URDT Geneartion / Modifkation Fehler 20130111

Method ADD_TTFONT_CHARS_TO_URDT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_SELECTED_SAPFONTS Call by reference Type reference (TYPE) CL_UPE_URDT=>T_SAPFONTS 20130114
2 Importing IV_FORCE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE If TRUE, existing codepoints are overwritten 20130114
3 Importing IV_LOGGING Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20130114
4 Importing IV_PACKAGE Call by reference Type reference (TYPE) DEVCLASS SPACE Package 20130114
5 Importing IV_REQUEST Call by reference Type reference (TYPE) TRKORR SPACE Request/Task 20130114
6 Importing IV_TTFONT_INFO Call by reference Type reference (TYPE) TFRT_NAME Typeface Repo - Font Family 20130114
7 Importing IV_URDT Call by reference Type reference (TYPE) RSPOPTYPE Spool: Device type name 20130114
8 Returning RV_SUCCESSFUL Value transfer Type reference (TYPE) ABAP_BOOL 20130114
# Exception Resumable Description Created on
1 CX_URDT_GENERATION_ERROR URDT Geneartion / Modifkation Fehler 20130114

Method AFTER_URDT_MODIFICATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_URDT_SOURCE Call by reference Object reference (TYPE REF TO) CL_UPE_URDT Utilities for Unicode Reference Devtypes 20130115
2 Importing IO_URDT_TARGET Call by reference Object reference (TYPE REF TO) CL_UPE_URDT Utilities for Unicode Reference Devtypes 20130115
# Exception Resumable Description Created on
1 CX_URDT_GENERATION_ERROR URDT Geneartion / Modifkation Fehler 20130115

Method CHANGE_ABAP_LISTFONT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_URDT Call by reference Object reference (TYPE REF TO) CL_UPE_URDT 20130503
2 Importing IV_TTFONT_INFO Call by reference Type reference (TYPE) TFRT_NAME 20130503
# Exception Resumable Description Created on
1 CX_URDT_GENERATION_ERROR 20130503

Method CHANGE_LISTFONT_OF_URDT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_LOGGING Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20130114
2 Importing IV_PACKAGE Call by reference Type reference (TYPE) DEVCLASS Package 20130114
3 Importing IV_REQUEST Call by reference Type reference (TYPE) TRKORR SPACE Request/Task 20130114
4 Importing IV_TTFONT_INFO Call by reference Type reference (TYPE) TFRT_NAME Typeface Repo - Font Family 20130114
5 Importing IV_URDT Call by reference Type reference (TYPE) RSPOPTYPE Spool: Device type name 20130114
6 Returning RV_SUCCESSFUL Value transfer Type reference (TYPE) ABAP_BOOL 20130114
# Exception Resumable Description Created on
1 CX_URDT_GENERATION_ERROR URDT Geneartion / Modifkation Fehler 20130114

Method CLASS_CONSTRUCTOR Signature

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

Method COPY_URDT_AND_ADD_CODEPOINT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_SELECTED_SAPFONTS Call by reference Type reference (TYPE) CL_UPE_URDT=>T_SAPFONTS Table of SAP fonts 20120925
2 Importing IV_FORCE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20120925
3 Importing IV_LOGGING Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20121023
4 Importing IV_PACKAGE Call by reference Type reference (TYPE) DEVCLASS SPACE Package 20121120
5 Importing IV_REQUEST Call by reference Type reference (TYPE) TRKORR SPACE Request/Task 20121119
6 Importing IV_TTFONT_INFO Call by reference Type reference (TYPE) TFRT_NAME Typeface Repo - Additional names of fonts 20120928
7 Importing IV_UCHAR Call by reference Type reference (TYPE) SCPUCHAR Unicode character 20120924
8 Importing IV_URDT_SOURCE Call by reference Type reference (TYPE) RSPOPTYPE Spool: Device type name 20120924
9 Importing IV_URDT_TARGET Call by reference Type reference (TYPE) RSPOPTYPE Spool: Device type name 20120924
10 Importing IV_URDT_TARGET_DESCRP Call by reference Type reference (TYPE) RSPONAME Spool: Name 20120924
11 Returning RV_SUCCESSFUL Value transfer Type reference (TYPE) ABAP_BOOL 20121123
# Exception Resumable Description Created on
1 CX_URDT_GENERATION_ERROR URDT Geneartion / Modifkation Fehler 20120925

Method COPY_URDT_AND_ADD_TTFONT_CHARS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IT_SELECTED_SAPFONTS Call by reference Type reference (TYPE) CL_UPE_URDT=>T_SAPFONTS 20121108
2 Importing IV_FORCE Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE If TRUE, existing codepoints are overwritten 20121129
3 Importing IV_LOGGING Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20121108
4 Importing IV_PACKAGE Call by reference Type reference (TYPE) DEVCLASS SPACE Package 20121120
5 Importing IV_REQUEST Call by reference Type reference (TYPE) TRKORR SPACE Request/Task 20121119
6 Importing IV_TTFONT_INFO Call by reference Type reference (TYPE) TFRT_NAME Typeface Repo - Font Family 20121108
7 Importing IV_URDT_SOURCE Call by reference Type reference (TYPE) RSPOPTYPE Spool: Device type name 20121108
8 Importing IV_URDT_TARGET Call by reference Type reference (TYPE) RSPOPTYPE Spool: Device type name 20121108
9 Importing IV_URDT_TARGET_DESCRP Call by reference Type reference (TYPE) RSPONAME Spool: Name 20121108
10 Returning RV_SUCCESSFUL Value transfer Type reference (TYPE) ABAP_BOOL 20121123
# Exception Resumable Description Created on
1 CX_URDT_GENERATION_ERROR URDT Geneartion / Modifkation Fehler 20121108

Method COPY_URDT_AND_CHANGE_LISTFONT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_LOGGING Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20121120
2 Importing IV_PACKAGE Call by reference Type reference (TYPE) DEVCLASS Package 20121127
3 Importing IV_REQUEST Call by reference Type reference (TYPE) TRKORR SPACE Request/Task 20121120
4 Importing IV_TTFONT_INFO Call by reference Type reference (TYPE) TFRT_NAME Typeface Repo - Font Family 20121120
5 Importing IV_URDT_SOURCE Call by reference Type reference (TYPE) RSPOPTYPE Spool: Device type name 20121120
6 Importing IV_URDT_TARGET Call by reference Type reference (TYPE) RSPOPTYPE Spool: Device type name 20121120
7 Importing IV_URDT_TARGET_DESCRP Call by reference Type reference (TYPE) RSPONAME Spool: Name 20121120
8 Returning RV_SUCCESSFUL Value transfer Type reference (TYPE) ABAP_BOOL 20121123
# Exception Resumable Description Created on
1 CX_URDT_GENERATION_ERROR URDT Geneartion / Modifkation Fehler 20121120

Method COPY_URDT_AND_REPLACE_TTFONT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_LOGGING Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20121025
2 Importing IV_MIN_HIT_PERCENTAGE Call by reference Type reference (TYPE) I 20121108
3 Importing IV_PACKAGE Call by reference Type reference (TYPE) DEVCLASS SPACE Package 20121120
4 Importing IV_REQUEST Call by reference Type reference (TYPE) TRKORR SPACE Request/Task 20121112
5 Importing IV_TTFONT_INFO_NEW Call by reference Type reference (TYPE) TFRT_NAME Typeface Repo - Font Family 20120928
6 Importing IV_TTFONT_INFO_OLD Call by reference Type reference (TYPE) TFRT_NAME Typeface Repo - Font Family 20120928
7 Importing IV_URDT_SOURCE Call by reference Type reference (TYPE) RSPOPTYPE Spool: Device type name 20120927
8 Importing IV_URDT_TARGET Call by reference Type reference (TYPE) RSPOPTYPE Spool: Device type name 20120927
9 Importing IV_URDT_TARGET_DESCRP Call by reference Type reference (TYPE) RSPONAME Spool: Name 20120927
10 Returning RV_SUCCESSFUL Value transfer Type reference (TYPE) ABAP_BOOL 20121123
# Exception Resumable Description Created on
1 CX_URDT_GENERATION_ERROR URDT Geneartion / Modifkation Fehler 20120927

Method CREATE_URDT_TARGET Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EO_URDT_TARGET Call by reference Object reference (TYPE REF TO) CL_UPE_URDT Utilities for Unicode Reference Devtypes 20121121
2 Importing IO_URDT_SOURCE Call by reference Object reference (TYPE REF TO) CL_UPE_URDT Utilities for Unicode Reference Devtypes 20121121
3 Importing IV_URDT_TARGET Call by reference Type reference (TYPE) RSPOPTYPE Spool: Device type name 20121121
4 Importing IV_URDT_TARGET_DESCRP Call by reference Type reference (TYPE) RSPONAME Spool: Name 20121121

Method CREATE_URDT_TARGET on class CL_URDT_GENERATION_API has no exception.

Method GET_METRIC Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IS_FONTMAP Call by reference Type reference (TYPE) CL_UPE_FONTMETRIC=>T_FONTMAPREC Mapping of OpenType font to 1-byte number 20121121
2 Importing IS_TTFONT_INFO Call by reference Type reference (TYPE) TFRT_NAME Typeface Repo - Additional names of fonts 20121121
3 Importing IV_CODEPOINT_INT Call by reference Type reference (TYPE) I 20121121
4 Returning RS_CHAR_METRIC Value transfer Type reference (TYPE) CL_UPE_FONTMETRIC=>T_CHARMETRIC Metric of single char 20121121
# Exception Resumable Description Created on
1 CX_URDT_GENERATION_ERROR URDT Geneartion / Modifkation Fehler 20121121

Method GET_URDT_DESCRIPTION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_URDT Call by reference Type reference (TYPE) RSPOPTYPE Spool data types 20130115
2 Returning RV_DESCRIPTION Value transfer Type reference (TYPE) RSPONAME Spool: Name 20130115
# Exception Resumable Description Created on
1 CX_URDT_GENERATION_ERROR 20130115

Method GUI_MESSAGE_SAPFONT_EDITING Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_CURRENT Call by reference Type reference (TYPE) I 20130117
2 Importing IV_MESSAGE Call by reference Type reference (TYPE) CHAR70 20130117
3 Importing IV_SAPFONT Call by reference Type reference (TYPE) TDFAMILY 20130117
4 Importing IV_TOTAL Call by reference Type reference (TYPE) I 20130117

Method GUI_MESSAGE_SAPFONT_EDITING on class CL_URDT_GENERATION_API has no exception.

Method LOCK_URDT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IO_URDT Call by reference Object reference (TYPE REF TO) CL_UPE_URDT Utilities for Unicode Reference Devtypes 20130115
# Exception Resumable Description Created on
1 CX_URDT_GENERATION_ERROR URDT Geneartion / Modifkation Fehler 20130115

Method OPEN_REPLACEMENT_CHOICE_POPUP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_ACTUAL_HIT_PERCENTAGE Call by reference Type reference (TYPE) I 20121122
2 Importing IV_FONT Call by reference Type reference (TYPE) STRING 20121122
3 Importing IV_SAPFONT Call by reference Type reference (TYPE) TDFAMILY Font attribute: Name of font family 20121122
4 Returning RV_ANSWER Value transfer Type reference (TYPE) CHAR1 Single-Character Flag 20121122
# Exception Resumable Description Created on
1 CX_URDT_GENERATION_ERROR 20130116

Method PREPARE_URDT_MODIFICATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting EO_URDT_SOURCE Call by reference Object reference (TYPE REF TO) CL_UPE_URDT Utilities for Unicode Reference Devtypes 20130115
2 Exporting EO_URDT_TARGET Call by reference Object reference (TYPE REF TO) CL_UPE_URDT Utilities for Unicode Reference Devtypes 20130115
3 Importing IV_PACKAGE Call by reference Type reference (TYPE) DEVCLASS SPACE Package 20130115
4 Importing IV_REQUEST Call by reference Type reference (TYPE) TRKORR SPACE Request/Task 20130115
5 Importing IV_URDT_SOURCE Call by reference Type reference (TYPE) RSPOPTYPE Spool: Device type name 20130115
6 Importing IV_URDT_TARGET Call by reference Type reference (TYPE) RSPOPTYPE Spool: Device type name 20130115
7 Importing IV_URDT_TARGET_DESCRP Call by reference Type reference (TYPE) RSPONAME Spool: Name 20130115
# Exception Resumable Description Created on
1 CX_URDT_GENERATION_ERROR URDT Geneartion / Modifkation Fehler 20130115

Method PRINT_OUT_TRACE Signature

Method PRINT_OUT_TRACE on class CL_URDT_GENERATION_API has no parameter.
Method PRINT_OUT_TRACE on class CL_URDT_GENERATION_API has no exception.

Method REPLACE_TTFONT_IN_URDT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_LOGGING Call by reference Type reference (TYPE) ABAP_BOOL ABAP_FALSE 20130114
2 Importing IV_MIN_HIT_PERCENTAGE Call by reference Type reference (TYPE) I 20130114
3 Importing IV_PACKAGE Call by reference Type reference (TYPE) DEVCLASS SPACE Package 20130114
4 Importing IV_REQUEST Call by reference Type reference (TYPE) TRKORR SPACE Request/Task 20130114
5 Importing IV_TTFONT_INFO_NEW Call by reference Type reference (TYPE) TFRT_NAME Typeface Repo - Font Family 20130114
6 Importing IV_TTFONT_INFO_OLD Call by reference Type reference (TYPE) TFRT_NAME Typeface Repo - Font Family 20130114
7 Importing IV_URDT Call by reference Type reference (TYPE) RSPOPTYPE Spool: Device type name 20130114
8 Returning RV_SUCCESSFUL Value transfer Type reference (TYPE) ABAP_BOOL 20130114
# Exception Resumable Description Created on
1 CX_URDT_GENERATION_ERROR URDT Geneartion / Modifkation Fehler 20130114

Method TO_UCHAR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing IV_INT Call by reference Type reference (TYPE) I 20121126
2 Returning RV_UCHAR Value transfer Type reference (TYPE) SCPUCHAR Unicode character 20121126

Method TO_UCHAR on class CL_URDT_GENERATION_API has no exception.
History
Last changed by/on SAP  20140121 
SAP Release Created in 740