SAP ABAP Class CL_FONT_SELECTOR (Font Selector)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-CCM-PRN (Application Component) Print and Output Management
⤷
S_FONT_SERVICES_API (Package) Font Services API
⤷
⤷
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_TFR_FONT_SELECTOR | Select fonts according to constraints | 20090527 |
Properties
| Class | CL_FONT_SELECTOR | |
| Short Description | Font Selector | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | S_FONT_SERVICES_API | Font Services API |
| Created | 20090527 | SAP |
| Last change | 20130531 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) | |
| 2 | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) | |
| 3 | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
Interfaces
Class CL_FONT_SELECTOR has no interface implemented.
Friends
Class CL_FONT_SELECTOR has no friend class.
Attributes
Class CL_FONT_SELECTOR has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Get all Instances of fonts by supported codepoints | 20100219 | |
| 2 | Instance method | Public | Method | Get instances of fonts by IDs | 20100219 | |
| 3 | Instance method | Public | Method | Get installed fonts | 20100219 | |
| 4 | Instance method | Public | Method | Select fonts by supported codepoints | 20090527 | |
| 5 | Instance method | Public | Method | Select font by families, style, variant, weight and stretch | 20090529 | |
| 6 | Instance method | Public | Method | Select font by families, italic flag and bold flag | 20090527 | |
| 7 | Instance method | Public | Method | Select font by family, style, variant, weight and stretch | 20090529 | |
| 8 | Instance method | Public | Method | Select font by family, italic flag and bold flag | 20090527 |
Events
Class CL_FONT_SELECTOR has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TY_CODEPOINT_TAB | Public | See coding | 20090527 | TY_CODEPOINT_TAB type standard table of i with DEFAULT KEY
|
||
| 2 | TY_CODEPOINT_TO_FONT | Public | See coding | 20090527 | begin of ty_codepoint_to_font,
codepoint TYPE i,
font TYPE REF TO cl_font_instance,
end of ty_codepoint_to_font
|
||
| 3 | TY_CODEPOINT_TO_FONT_TAB | Public | See coding | 20090527 | ty_codepoint_to_font_tab type standard table of ty_codepoint_to_font with default key
|
||
| 4 | TY_FONT_TAB | Public | See coding | 20100219 | TY_FONT_TAB TYPE STANDARD TABLE OF REF TO cl_font_instance WITH DEFAULT KEY
|
||
| 5 | TY_HEX_CODEPOINT_TAB | Public | See coding | 20100219 | TY_HEX_CODEPOINT_TAB TYPE STANDARD TABLE OF scpuchar WITH DEFAULT KEY
|
Method Signatures
Method GET_FONTS_BY_HEX_CODEPOINTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_HEX_CODEPOINT | Call by reference | Type reference (TYPE) | TY_HEX_CODEPOINT_TAB | 20100219 | ||||
| 2 | RT_FONT | Value transfer | Type reference (TYPE) | TY_FONT_TAB | 20100219 |
Method GET_FONTS_BY_HEX_CODEPOINTS on class CL_FONT_SELECTOR has no exception.
Method GET_FONT_BY_IDS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_LOGIDX | Call by reference | Type reference (TYPE) | TFR_INDEX | Typeface Repo - Logical Index into Font Binary | 20100219 | |||
| 2 | IV_PHYSID | Call by reference | Type reference (TYPE) | TFR_PHYSFONTID | Typeface Repo - Physical Font ID | 20100219 | |||
| 3 | RO_FONT | Value transfer | Object reference (TYPE REF TO) | CL_FONT_INSTANCE | Instance of font returned through font selector | 20100219 |
Method GET_FONT_BY_IDS on class CL_FONT_SELECTOR has no exception.
Method GET_INSTALLED_FONTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_ACTIVE | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20100219 | ||||
| 2 | IV_INACTIVE | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20100219 | ||||
| 3 | RT_FONT | Value transfer | Type reference (TYPE) | TY_FONT_TAB | 20100219 |
Method GET_INSTALLED_FONTS on class CL_FONT_SELECTOR has no exception.
Method SELECT_BY_CODEPOINTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_CODEPOINTS | Call by reference | Type reference (TYPE) | TY_CODEPOINT_TAB | 20090527 | ||||
| 2 | IV_ALL_FONT | Call by reference | Type reference (TYPE) | ABAP_BOOL | True: it returnn all fonts else only a font | 20100219 | |||
| 3 | IV_PREFER_SANS | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20090527 | |||
| 4 | IV_PREFER_SERIF | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20090527 | |||
| 5 | RT_CODEPOINTS_TO_FONT | Value transfer | Type reference (TYPE) | TY_CODEPOINT_TO_FONT_TAB | 20090527 |
Method SELECT_BY_CODEPOINTS on class CL_FONT_SELECTOR has no exception.
Method SELECT_BY_FAMILIES_EXTENDED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_FAMILIES | Call by reference | Type reference (TYPE) | STRING_TABLE | 20090529 | ||||
| 2 | IV_OPTSIZE | Call by reference | Type reference (TYPE) | DFONT_OPTSIZE | '' | 20090602 | |||
| 3 | IV_STRETCH | Call by reference | Type reference (TYPE) | DFONT_STRETCH | 5 | 20090529 | |||
| 4 | IV_STYLE | Call by reference | Type reference (TYPE) | DFONT_STYLE | '' | 20090529 | |||
| 5 | IV_VARIANT | Call by reference | Type reference (TYPE) | DFONT_VARIANT | '' | 20090529 | |||
| 6 | IV_WEIGHT | Call by reference | Type reference (TYPE) | DFONT_WEIGHT | 400 | 20090529 | |||
| 7 | RO_FONT | Value transfer | Object reference (TYPE REF TO) | CL_FONT_INSTANCE | 20090529 |
Method SELECT_BY_FAMILIES_EXTENDED on class CL_FONT_SELECTOR has no exception.
Method SELECT_BY_FAMILIES_ITALIC_BOLD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_FAMILIES | Call by reference | Type reference (TYPE) | STRING_TABLE | 20090527 | ||||
| 2 | IV_BOLD | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20090527 | ||||
| 3 | IV_ITALIC | Call by reference | Type reference (TYPE) | ABAP_BOOL | 20090527 | ||||
| 4 | RO_FONT | Value transfer | Object reference (TYPE REF TO) | CL_FONT_INSTANCE | 20090527 |
Method SELECT_BY_FAMILIES_ITALIC_BOLD on class CL_FONT_SELECTOR has no exception.
Method SELECT_BY_FAMILY_EXTENDED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_FAMILY | Call by reference | Type reference (TYPE) | STRING | 20090529 | ||||
| 2 | IV_OPTSIZE | Call by reference | Type reference (TYPE) | DFONT_OPTSIZE | '' | Font Optical Size | 20090602 | ||
| 3 | IV_STRETCH | Call by reference | Type reference (TYPE) | DFONT_STRETCH | 5 | Font Stretch | 20090529 | ||
| 4 | IV_STYLE | Call by reference | Type reference (TYPE) | DFONT_STYLE | '' | Font Style | 20090529 | ||
| 5 | IV_VARIANT | Call by reference | Type reference (TYPE) | DFONT_VARIANT | '' | Font Variant | 20090529 | ||
| 6 | IV_WEIGHT | Call by reference | Type reference (TYPE) | DFONT_WEIGHT | 400 | Font Weight | 20090529 | ||
| 7 | RO_FONT | Value transfer | Object reference (TYPE REF TO) | CL_FONT_INSTANCE | Instance of font returned through font selector | 20090529 |
Method SELECT_BY_FAMILY_EXTENDED on class CL_FONT_SELECTOR has no exception.
Method SELECT_BY_FAMILY_ITALIC_BOLD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_BOLD | Call by reference | Type reference (TYPE) | ABAP_BOOL | Bold | 20090527 | |||
| 2 | IV_FAMILY | Call by reference | Type reference (TYPE) | STRING | One font family to try | 20090527 | |||
| 3 | IV_ITALIC | Call by reference | Type reference (TYPE) | ABAP_BOOL | Italic | 20090527 | |||
| 4 | RO_FONT | Value transfer | Object reference (TYPE REF TO) | CL_FONT_INSTANCE | Null or instance of font returned through font selector | 20090527 |
Method SELECT_BY_FAMILY_ITALIC_BOLD on class CL_FONT_SELECTOR has no exception.
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 800 |