SAP ABAP Class CL_UPE_SERVICES (Utilities for UPE)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-CCM-PRN (Application Component) Print and Output Management
⤷
SPOO (Package) Spool
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-CCM-PRN (Application Component) Print and Output Management⤷
SPOO (Package) SpoolProperties
| Class | CL_UPE_SERVICES | |
| Short Description | Utilities for UPE | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SPOO | Spool |
| Created | 20100503 | 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) |
| 2 | CL_UPE_FONTMETRIC |
Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
Interfaces
Class CL_UPE_SERVICES has no interface implemented.
Friends
Class CL_UPE_SERVICES has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | C_LANGKEY_CHINESE_SIMPL |
Constant | Public | Type reference (TYPE) | C | '1' | Simplified Chinese | 20120801 | |
| 2 | C_LANGKEY_CHINESE_TRAD |
Constant | Public | Type reference (TYPE) | C | 'M' | Traditional Chinese | 20120801 | |
| 3 | C_LANGKEY_JAPANESE |
Constant | Public | Type reference (TYPE) | C | 'J' | Japanese | 20120801 | |
| 4 | C_LANGKEY_KOREAN |
Constant | Public | Type reference (TYPE) | C | 'K' | Korean | 20120801 | |
| 5 | C_OTF_CONTROL_UPE_VERSION1 |
Constant | Public | Type reference (TYPE) | STRING | 'UPE1' | Marker for UPE in OTF //X cmd | 20120719 | |
| 6 | C_TSP06NAME_FONTMAP |
Constant | Private | Type reference (TYPE) | RSPOPAPACT | 'FMAP0001' | Spool: Action to paper (header, start of line...) | 20100503 | |
| 7 | C_TSP06NAME_GLOBAL |
Constant | Private | Type reference (TYPE) | RSPOPAPACT | 'GLOBAL01' | Spool: Action to paper (header, start of line...) | 20100503 | |
| 8 | C_TSP06NAME_RANGES |
Constant | Private | Type reference (TYPE) | RSPOPAPACT | 'RANG0001' | Spool: Action to paper (header, start of line...) | 20100503 | |
| 9 | C_TSP06NAME_SINGLES |
Constant | Private | Type reference (TYPE) | RSPOPAPACT | 'SING0001' | Spool: Action to paper (header, start of line...) | 20100503 | |
| 10 | C_TSP06PAPER_PREFIX |
Constant | Private | Type reference (TYPE) | RSPOPAPART | 'URDTFN' | Spool: Format | 20100503 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CREATE_UPE_FONTMETRIC |
Static method | Public | Method | Create fontmetric for Legacy-DT, resident+UPE chars | 20100510 |
| 2 | CREATE_UPE_FONTMETRIC_RESIDENT |
Static method | Public | Method | Create fontmetric for Legacy-DT, resident font chars | 20100507 |
| 3 | DATA_TO_FONTMAP |
Static method | Public | Method | Convert TSP06 data to font map | 20100503 |
| 4 | DATA_TO_METRICS |
Static method | Public | Method | Convert TSP06 data to font metrics | 20100503 |
| 5 | ENUM_REPOSITORY_FONTS |
Static method | Public | Method | Return list of fonts from repository | 20100503 |
| 6 | FONTMAP_TO_DATA |
Static method | Public | Method | Convert fontmap to TSP06 data | 20100503 |
| 7 | GET_FONTS_FROM_CACHE |
Static method | Public | Method | Get UPE fontmetric objects from UCFMET cache | 20100519 |
| 8 | GET_METRIC_FROM_REPOFONT |
Static method | Public | Method | Create fontmetric object from repo font | 20100503 |
| 9 | GET_PHYSID_FROM_FC_CMD |
Static method | Public | Method | Extract repo font PHYSID+LOGIDX from UPE FC cmd | 20100616 |
| 10 | GET_UPE_FC_CMD |
Static method | Private | Method | Get OTF FC command for UPE font | 20100609 |
| 11 | METRICS_TO_DATA |
Static method | Public | Method | Convert font metrics to TSP06 data | 20100503 |
| 12 | POST_PROCESS_OTF |
Static method | Public | Method | Post-processing for OTF, insert FC cmds for UPE fonts | 20100503 |
| 13 | PROCESS_OTFSTRING |
Static method | Private | Method | Post-Process an OTF ST cmd and produce FC+ST cmds | 20100608 |
| 14 | REMAP_SAPFONT_CJK |
Static method | Private | Method | For CJK documents, map to "correct" SAPfont in URDT | 20120731 |
| 15 | STRINGINFO2STCMD |
Static method | Private | Method | Stringinfo to ST cmd | 20100609 |
| 16 | STRINGINFO_ADDCHAR |
Static method | Private | Method | Add char to stringinfo | 20100609 |
| 17 | STRINGINFO_ADDSUPPCHAR |
Static method | Private | Method | Add supplementary char (surrogate) to stringinfo | 20120824 |
Events
Class CL_UPE_SERVICES has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | T_OTFFONTMAP | Private | See coding | Table which holds OTF FC cmds and UPE font index | 20100609 | T_OTFFONTMAP type sorted table of T_OTFFONTREC with unique key fontindex family fontsize bold italic
|
|
| 2 | T_OTFFONTREC | Private | See coding | Maps font index to OTF FC cmds | 20100609 | begin of T_OTFFONTREC,
fontindex(1) type x,
family type tdfamily,
fontsize type tdfontsize,
bold type tdbold,
italic type tditalic,
fc_cmd type itcoo,
sw_cmd type itcoo,
end of T_OTFFONTREC
|
|
| 3 | T_OTFSTRINGINFO | Private | See coding | Info on collected chars for ST cmd | 20100609 | begin of T_OTFSTRINGINFO,
numchars type i,
chardata(63) type c,
width_tw type i,
end of T_OTFSTRINGINFO
|
|
| 4 | T_TSP06TAB | Public | See coding | Table of TSP06 entries | 20100503 | T_TSP06TAB type standard table of TSP06 with default key
|
|
| 5 | T_UPEFONTREC | Public | See coding | Font key from UCFMET cache | 20100519 | begin of T_UPEFONTREC,
sapfont type tdfamily,
fontsize type tdfontsize,
bold type tdbold,
italic type tditalic,
fontmet_obj type ref to CL_UPE_FONTMETRIC,
is_upefont type ABAP_BOOL,
end of T_UPEFONTREC
|
|
| 6 | T_UPEFONTTAB | Public | See coding | Table of UCFMET font keys | 20100519 | T_UPEFONTTAB type sorted table of T_UPEFONTREC with unique key sapfont fontsize bold italic
|
Method Signatures
Method CREATE_UPE_FONTMETRIC Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
EX_ERRMSG | Call by reference | Type reference (TYPE) | STRING | Error msg | 20100510 | ||
| 2 | Exporting |
EX_METRIC | Value transfer | Object reference (TYPE REF TO) | CL_UPE_FONTMETRIC | Fontmetrics for UPE | 20100510 | ||
| 3 |  Importing |
IM_BOLD | Call by reference | Type reference (TYPE) | TDBOLD | Font attribute bold type | 20100510 | ||
| 4 | Importing |
IM_FONTSIZE | Call by reference | Type reference (TYPE) | TDFONTSIZE | Font attribute: font size in 1/10 point | 20100510 | ||
| 5 | Importing |
IM_ITALIC | Call by reference | Type reference (TYPE) | TDITALIC | Font attribute italic | 20100510 | ||
| 6 | Importing |
IM_SAPFONT | Call by reference | Type reference (TYPE) | TDFAMILY | Font attribute: Name of font family | 20100510 | ||
| 7 | Importing |
IM_UPE_DEVTYPE | Call by reference | Object reference (TYPE REF TO) | CL_UPE_DEVTYPE | Spool: Device type name | 20100510 |
Method CREATE_UPE_FONTMETRIC on class CL_UPE_SERVICES has no exception.
Method CREATE_UPE_FONTMETRIC_RESIDENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_BOLD | Call by reference | Type reference (TYPE) | TDBOLD | Font attribute bold type | 20100507 | ||
| 2 | Importing |
IM_DEVTYPE | Call by reference | Type reference (TYPE) | RSPOPTYPE | Legacy Device Type | 20100507 | ||
| 3 | Importing |
IM_FONTSIZE | Call by reference | Type reference (TYPE) | TDFONTSIZE | Font attribute: font size in 1/10 point | 20100507 | ||
| 4 | Importing |
IM_ITALIC | Call by reference | Type reference (TYPE) | TDITALIC | Font attribute italic | 20100507 | ||
| 5 | Importing |
IM_SAPFONT | Call by reference | Type reference (TYPE) | TDFAMILY | Font attribute: Name of font family | 20100507 | ||
| 6 | Importing |
IM_USE_ONLY_TTFONTS | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Use no resident fonts, only TTfonts? | 20120326 | |
| 7 |  Returning |
RT_METRIC | Value transfer | Object reference (TYPE REF TO) | CL_UPE_FONTMETRIC | Fontmetrics for UPE | 20100507 |
Method CREATE_UPE_FONTMETRIC_RESIDENT on class CL_UPE_SERVICES has no exception.
Method DATA_TO_FONTMAP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_BOLD | Call by reference | Type reference (TYPE) | TDBOLD | Font attribute bold type | 20100503 | ||
| 2 | Importing |
IM_ITALIC | Call by reference | Type reference (TYPE) | TDITALIC | Font attribute italic | 20100503 | ||
| 3 | Importing |
IM_SAPFONT | Call by reference | Type reference (TYPE) | TDFAMILY | Font attribute: Name of font family | 20100503 | ||
| 4 | Importing |
IM_TSP06TAB | Call by reference | Type reference (TYPE) | T_TSP06TAB | Table of TSP06 entries | 20100503 | ||
| 5 | Returning |
RT_FONTMAP | Value transfer | Type reference (TYPE) | CL_UPE_FONTMETRIC=>T_FONTMAPTAB | Table of font mappings | 20100503 |
Method DATA_TO_FONTMAP on class CL_UPE_SERVICES has no exception.
Method DATA_TO_METRICS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_BOLD | Call by reference | Type reference (TYPE) | TDBOLD | Font attribute bold type | 20100503 | ||
| 2 | Importing |
IM_DEVTYPE | Call by reference | Type reference (TYPE) | RSPOPTYPE | Spool: Device type name | 20100503 | ||
| 3 | Importing |
IM_FONTSIZE | Call by reference | Type reference (TYPE) | TDFONTSIZE | Font attribute: font size in 1/10 point | 20100503 | ||
| 4 | Importing |
IM_ITALIC | Call by reference | Type reference (TYPE) | TDITALIC | Font attribute italic | 20100503 | ||
| 5 | Importing |
IM_SAPFONT | Call by reference | Type reference (TYPE) | TDFAMILY | Font attribute: Name of font family | 20100503 | ||
| 6 | Importing |
IM_TSP06DATA | Call by reference | Type reference (TYPE) | T_TSP06TAB | Table of TSP06 entries | 20100503 | ||
| 7 | Returning |
RT_FONTMETRIC | Value transfer | Object reference (TYPE REF TO) | CL_UPE_FONTMETRIC | Fontmetrics for UPE | 20100503 |
Method DATA_TO_METRICS on class CL_UPE_SERVICES has no exception.
Method ENUM_REPOSITORY_FONTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RT_FONTMAP | Value transfer | Type reference (TYPE) | CL_UPE_FONTMETRIC=>T_FONTMAPTAB | Table of font mappings | 20100503 |
Method ENUM_REPOSITORY_FONTS on class CL_UPE_SERVICES has no exception.
Method FONTMAP_TO_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_FONTMETRIC | Call by reference | Object reference (TYPE REF TO) | CL_UPE_FONTMETRIC | Fontmetrics for UPE | 20100503 | ||
| 2 | Returning |
RT_TSP06TAB | Value transfer | Type reference (TYPE) | T_TSP06TAB | Table of TSP06 entries | 20100503 |
Method FONTMAP_TO_DATA on class CL_UPE_SERVICES has no exception.
Method GET_FONTS_FROM_CACHE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EX_CACHEFONTS | Value transfer | Type reference (TYPE) | T_UPEFONTTAB | Table of UCFMET font keys | 20100519 | ||
| 2 | Exporting |
EX_DEVTYPE | Call by reference | Type reference (TYPE) | RSPOPTYPE | Spool: Device type name | 20100519 |
Method GET_FONTS_FROM_CACHE on class CL_UPE_SERVICES has no exception.
Method GET_METRIC_FROM_REPOFONT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_BOLD | Call by reference | Type reference (TYPE) | TDBOLD | Font attribute bold type | 20100503 | ||
| 2 | Importing |
IM_DEVTYPE | Call by reference | Type reference (TYPE) | RSPOPTYPE | Spool: Device type name | 20100503 | ||
| 3 | Importing |
IM_ITALIC | Call by reference | Type reference (TYPE) | TDITALIC | Font attribute italic | 20100503 | ||
| 4 | Importing |
IM_LOGIDX | Call by reference | Type reference (TYPE) | TFR_INDEX | Typeface Repo - Logical Index into Font Binary | 20100503 | ||
| 5 | Importing |
IM_PHYSID | Call by reference | Type reference (TYPE) | TFR_PHYSFONTID | Typeface Repo - Physical Font ID | 20100503 | ||
| 6 | Importing |
IM_SAPFONT | Call by reference | Type reference (TYPE) | TDFAMILY | Font attribute: Name of font family | 20100503 | ||
| 7 | Returning |
RT_FONTMETRIC | Value transfer | Object reference (TYPE REF TO) | CL_UPE_FONTMETRIC | Fontmetrics for UPE | 20100503 |
Method GET_METRIC_FROM_REPOFONT on class CL_UPE_SERVICES has no exception.
Method GET_PHYSID_FROM_FC_CMD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EX_LOGIDX | Call by reference | Type reference (TYPE) | TFR_INDEX | Typeface Repo - Logical Index into Font Binary | 20100616 | ||
| 2 | Exporting |
EX_PHYSID | Value transfer | Type reference (TYPE) | TFR_PHYSFONTID | Typeface Repo - Physical Font ID | 20100616 | ||
| 3 | Importing |
IM_FC_CMD | Call by reference | Type reference (TYPE) | ITCOO | OTF Structure | 20100616 |
Method GET_PHYSID_FROM_FC_CMD on class CL_UPE_SERVICES has no exception.
Method GET_UPE_FC_CMD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_FC_RES | Call by reference | Type reference (TYPE) | ITCOO | OTF Structure | 20100609 | ||
| 2 | Importing |
IM_FONTINDEX | Call by reference | Type reference (TYPE) | X | Font index of UPE font | 20100609 | ||
| 3 | Importing |
IM_UPE_FONTMETRIC | Call by reference | Object reference (TYPE REF TO) | CL_UPE_FONTMETRIC | Fontmetrics for UPE | 20100609 | ||
| 4 | Returning |
RT_FC_UPE | Value transfer | Type reference (TYPE) | ITCOO | OTF Structure | 20100609 |
Method GET_UPE_FC_CMD on class CL_UPE_SERVICES has no exception.
Method METRICS_TO_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_FONTMETRIC | Call by reference | Object reference (TYPE REF TO) | CL_UPE_FONTMETRIC | Fontmetrics for UPE | 20100503 | ||
| 2 | Returning |
RT_TSP06TAB | Value transfer | Type reference (TYPE) | T_TSP06TAB | Table of TSP06 entries | 20100503 |
Method METRICS_TO_DATA on class CL_UPE_SERVICES has no exception.
Method POST_PROCESS_OTF Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EX_NO_CHANGE | Call by reference | Type reference (TYPE) | ABAP_BOOL | no change done to OTF | 20100503 | ||
| 2 | Exporting |
EX_OTFDATA | Call by reference | Type reference (TYPE) | RSPO_OTFTAB | output OTF commands | 20100503 | ||
| 3 | Importing |
IM_DEVTYPE | Call by reference | Type reference (TYPE) | RSPOPTYPE | Spool: Device type name | 20100608 | ||
| 4 | Importing |
IM_INSERT_IN_MARKS | Call by reference | Type reference (TYPE) | ABAP_BOOL | SPACE | Insert IN to mark end of modified block | 20100611 | |
| 5 | Importing |
IM_OTFDATA | Call by reference | Type reference (TYPE) | RSPO_OTFTAB | input OTF commands | 20100503 |
Method POST_PROCESS_OTF on class CL_UPE_SERVICES has no exception.
Method PROCESS_OTFSTRING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Changing |
CH_CUR_FCCMD | Call by reference | Type reference (TYPE) | ITCOO | Last set OTF FC | 20100609 | ||
| 2 | Changing |
CH_OTF_FONTMAP | Call by reference | Type reference (TYPE) | T_OTFFONTMAP | Table which maps font index to OTF FC cmds | 20100609 | ||
| 3 | Exporting |
EX_NO_CHANGE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ST cmd was not changed | 20100617 | ||
| 4 | Exporting |
EX_OTFTAB | Call by reference | Type reference (TYPE) | RSPO_OTFTAB | Table of OTF commands | 20100609 | ||
| 5 | Importing |
IM_RES_FCCMD | Call by reference | Type reference (TYPE) | ITCOO | Original FC cmd of resident font | 20100609 | ||
| 6 | Importing |
IM_RES_SPACEW | Call by reference | Type reference (TYPE) | ITCOO | OTF SW cmd | 20100609 | ||
| 7 | Importing |
IM_ST_CMD | Call by reference | Type reference (TYPE) | ITCOO | OTF String cmd | 20100608 | ||
| 8 | Importing |
IM_UPE_FONTMETRIC | Call by reference | Object reference (TYPE REF TO) | CL_UPE_FONTMETRIC | Fontmetrics for UPE | 20100608 |
Method PROCESS_OTFSTRING on class CL_UPE_SERVICES has no exception.
Method REMAP_SAPFONT_CJK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
EX_CJK_SAPFONT | Value transfer | Type reference (TYPE) | TDFAMILY | "correct" SAPfont from URDT core font set | 20120731 | ||
| 2 | Importing |
IM_LANGKEY | Call by reference | Type reference (TYPE) | TDSPRAS | Language Key | 20120731 | ||
| 3 | Importing |
IM_SAPFONT | Call by reference | Type reference (TYPE) | TDFAMILY | Font attribute: Name of font family | 20120731 |
Method REMAP_SAPFONT_CJK on class CL_UPE_SERVICES has no exception.
Method STRINGINFO2STCMD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_STRINGINFO | Call by reference | Type reference (TYPE) | T_OTFSTRINGINFO | Info on collected chars for ST cmd | 20100609 | ||
| 2 | Returning |
RT_ST_CMD | Value transfer | Type reference (TYPE) | ITCOO | OTF Structure | 20100609 |
Method STRINGINFO2STCMD on class CL_UPE_SERVICES has no exception.
Method STRINGINFO_ADDCHAR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Changing |
CH_STRINGINFO | Call by reference | Type reference (TYPE) | T_OTFSTRINGINFO | Info on collected chars for ST cmd | 20100609 | ||
| 2 | Importing |
IM_CHAR | Call by reference | Type reference (TYPE) | C | Char | 20100609 | ||
| 3 | Importing |
IM_WIDTH_TW | Call by reference | Type reference (TYPE) | I | width | 20100609 |
Method STRINGINFO_ADDCHAR on class CL_UPE_SERVICES has no exception.
Method STRINGINFO_ADDSUPPCHAR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Changing |
CH_STRINGINFO | Call by reference | Type reference (TYPE) | T_OTFSTRINGINFO | Info on collected chars for ST cmd | 20120824 | ||
| 2 | Importing |
IM_SUPPCHAR | Call by reference | Type reference (TYPE) | C | Supplementary char (=UTF16 surrogate codepoint pair) | 20120824 | ||
| 3 | Importing |
IM_WIDTH_TW | Call by reference | Type reference (TYPE) | I | width | 20120824 |
Method STRINGINFO_ADDSUPPCHAR on class CL_UPE_SERVICES has no exception.
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 703 |
