SAP ABAP Interface IF_XSLFO_TEXT_OUTPUT (Output interface for text output)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-I18 (Application Component) Internationalization (I18N)
⤷
S_XSLFO_API (Package) XSL Formatter API and objects visible externally
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-I18 (Application Component) Internationalization (I18N)⤷
S_XSLFO_API (Package) XSL Formatter API and objects visible externally
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_XSLFO_OUTPUT_ADAPTER | Output adapter base class for XSL formatter | 20081015 |
Properties
| Interface | IF_XSLFO_TEXT_OUTPUT | |
| Short Description | Output interface for text output |
General Data
| Package | S_XSLFO_API | XSL Formatter API and objects visible externally |
| Created | 20081014 | SAP |
| Last changed | 20110908 | SAP |
| 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) |
Interfaces
Interface IF_XSLFO_TEXT_OUTPUT has no interface.
Friends
Interface IF_XSLFO_TEXT_OUTPUT has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CO_FONT_STRETCH_COND | Constant | Public | Type reference (TYPE) | I | -2 | 20081014 | ||
| 2 | CO_FONT_STRETCH_EXP | Constant | Public | Type reference (TYPE) | I | 2 | 20081014 | ||
| 3 | CO_FONT_STRETCH_EXTRA_COND | Constant | Public | Type reference (TYPE) | I | -3 | 20081014 | ||
| 4 | CO_FONT_STRETCH_EXTRA_EXP | Constant | Public | Type reference (TYPE) | I | 3 | 20081014 | ||
| 5 | CO_FONT_STRETCH_NORMAL | Constant | Public | Type reference (TYPE) | I | 0 | 20081014 | ||
| 6 | CO_FONT_STRETCH_SEMI_COND | Constant | Public | Type reference (TYPE) | I | -1 | 20081014 | ||
| 7 | CO_FONT_STRETCH_SEMI_EXP | Constant | Public | Type reference (TYPE) | I | 1 | 20081014 | ||
| 8 | CO_FONT_STRETCH_ULTRA_COND | Constant | Public | Type reference (TYPE) | I | -4 | 20081014 | ||
| 9 | CO_FONT_STRETCH_ULTRA_EXP | Constant | Public | Type reference (TYPE) | I | 4 | 20081014 | ||
| 10 | CO_FONT_STYLE_BACKSLANT | Constant | Public | Type reference (TYPE) | I | 3 | 20081014 | ||
| 11 | CO_FONT_STYLE_ITALIC | Constant | Public | Type reference (TYPE) | I | 1 | 20081014 | ||
| 12 | CO_FONT_STYLE_NORMAL | Constant | Public | Type reference (TYPE) | I | 0 | 20081014 | ||
| 13 | CO_FONT_STYLE_OBLIQUE | Constant | Public | Type reference (TYPE) | I | 2 | 20081014 | ||
| 14 | CO_FONT_VARIANT_NORMAL | Constant | Public | Type reference (TYPE) | I | 0 | 20081014 | ||
| 15 | CO_FONT_VARIANT_SMALLCAPS | Constant | Public | Type reference (TYPE) | I | 1 | 20081014 | ||
| 16 | CO_FONT_WEIGHT_100 | Constant | Public | Type reference (TYPE) | I | -4 | 20081014 | ||
| 17 | CO_FONT_WEIGHT_200 | Constant | Public | Type reference (TYPE) | I | -3 | 20081014 | ||
| 18 | CO_FONT_WEIGHT_300 | Constant | Public | Type reference (TYPE) | I | -2 | 20081014 | ||
| 19 | CO_FONT_WEIGHT_400 | Constant | Public | Type reference (TYPE) | I | -1 | 20081014 | ||
| 20 | CO_FONT_WEIGHT_500 | Constant | Public | Type reference (TYPE) | I | 0 | 20081014 | ||
| 21 | CO_FONT_WEIGHT_600 | Constant | Public | Type reference (TYPE) | I | 1 | 20081014 | ||
| 22 | CO_FONT_WEIGHT_700 | Constant | Public | Type reference (TYPE) | I | 2 | 20081014 | ||
| 23 | CO_FONT_WEIGHT_800 | Constant | Public | Type reference (TYPE) | I | 3 | 20081014 | ||
| 24 | CO_FONT_WEIGHT_900 | Constant | Public | Type reference (TYPE) | I | 4 | 20081014 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | BEGIN_HYPERLINK |
Instance method | Public | Method | Starts a section which represents a hyperlink | 20090929 |
| 2 | END_HYPERLINK |
Instance method | Public | Method | Ends a section which represents a hyperlink | 20090929 |
| 3 | GET_ACTUAL_FONT |
Instance method | Public | Method | Get data about the actual font | 20081014 |
| 4 | GET_ACTUAL_FONT_SIZE |
Instance method | Public | Method | Get the actual font size of a selected font | 20081014 |
| 5 | GET_FONT_ASCENDER |
Instance method | Public | Method | Get ascender of a selected font (text-altitude) | 20081014 |
| 6 | GET_FONT_DESCENDER |
Instance method | Public | Method | Get descender of a selected font (text-depth) | 20081014 |
| 7 | GET_GLYPHS_FOR_STRING |
Instance method | Public | Method | Get font glyphs string for unicode string | 20081014 |
| 8 | GET_GLYPHS_WIDTH |
Instance method | Public | Method | Get width of glyphs string using a selected font | 20081014 |
| 9 | OUTPUT_TEXT |
Instance method | Public | Method | Output some text on the rendering surface | 20081014 |
| 10 | SELECT_FONT |
Instance method | Public | Method | Select a font of the output device from several traits | 20081014 |
Events
Interface IF_XSLFO_TEXT_OUTPUT has no event.
Types
Interface IF_XSLFO_TEXT_OUTPUT has no local type.
Method Signatures
Method BEGIN_HYPERLINK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
EXTERNAL_DESTINATION | Call by reference | Type reference (TYPE) | STRING | URL string | 20090929 | ||
| 2 | Importing |
INTERNAL_DESTINATION | Call by reference | Type reference (TYPE) | STRING | Internal hyperlink | 20090929 | ||
| 3 | Importing |
SHOW_DESTINATION | Call by reference | Type reference (TYPE) | STRING | "new" or "replace" | 20090929 |
Method BEGIN_HYPERLINK on Interface IF_XSLFO_TEXT_OUTPUT has no exception.
Method END_HYPERLINK Signature
Method END_HYPERLINK on Interface IF_XSLFO_TEXT_OUTPUT has no parameter.
Method END_HYPERLINK on Interface IF_XSLFO_TEXT_OUTPUT has no exception.
Method GET_ACTUAL_FONT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
EV_FAMILY | Call by reference | Type reference (TYPE) | STRING | 20081014 | |||
| 2 | Exporting |
EV_SIZE | Call by reference | Type reference (TYPE) | XSLFO_LENGTH | XSL-FO length in thousandth part of a point (at 72dpi) | 20081014 | ||
| 3 | Exporting |
EV_STRETCH | Call by reference | Type reference (TYPE) | XSLFO_ENUM | XSL-FO enumerated data type | 20081014 | ||
| 4 | Exporting |
EV_STYLE | Call by reference | Type reference (TYPE) | XSLFO_ENUM | XSL-FO enumerated data type | 20081014 | ||
| 5 | Exporting |
EV_VARIANT | Call by reference | Type reference (TYPE) | XSLFO_ENUM | XSL-FO enumerated data type | 20081014 | ||
| 6 | Exporting |
EV_WEIGHT | Call by reference | Type reference (TYPE) | XSLFO_ENUM | XSL-FO enumerated data type | 20081014 | ||
| 7 | Importing |
IV_FONTID | Call by reference | Type reference (TYPE) | XSLFO_FONTID | XSL-FO font identifier for renderer | 20081014 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_XSLFO_OUTPUT_ERROR |
20081014 |
Method GET_ACTUAL_FONT_SIZE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_FONTID | Call by reference | Type reference (TYPE) | XSLFO_FONTID | XSL-FO font identifier for renderer | 20081014 | ||
| 2 |  Returning |
RV_SIZE | Value transfer | Type reference (TYPE) | XSLFO_LENGTH | XSL-FO length in thousandth part of a point (at 72dpi) | 20081014 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_XSLFO_OUTPUT_ERROR |
20081014 |
Method GET_FONT_ASCENDER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_FONTID | Call by reference | Type reference (TYPE) | XSLFO_FONTID | XSL-FO font identifier for renderer | 20081014 | ||
| 2 | Returning |
RV_ASCENDER | Value transfer | Type reference (TYPE) | XSLFO_LENGTH | XSL-FO length in thousandth part of a point (at 72dpi) | 20081014 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_XSLFO_OUTPUT_ERROR |
20081014 |
Method GET_FONT_DESCENDER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_FONTID | Call by reference | Type reference (TYPE) | XSLFO_FONTID | 20081014 | |||
| 2 | Returning |
RV_DESCENDER | Value transfer | Type reference (TYPE) | XSLFO_LENGTH | 20081014 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_XSLFO_OUTPUT_ERROR |
20081014 |
Method GET_GLYPHS_FOR_STRING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_FONTID | Call by reference | Type reference (TYPE) | XSLFO_FONTID | 20081014 | |||
| 2 | Importing |
IV_STRING | Call by reference | Type reference (TYPE) | STRING | 20081014 | |||
| 3 | Returning |
RV_GLYPHS | Value transfer | Type reference (TYPE) | STRING | 20081014 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_XSLFO_OUTPUT_ERROR |
20081014 |
Method GET_GLYPHS_WIDTH Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_FONTID | Call by reference | Type reference (TYPE) | XSLFO_FONTID | 20081014 | |||
| 2 | Importing |
IV_GLYPHS | Call by reference | Type reference (TYPE) | STRING | 20081014 | |||
| 3 | Returning |
RV_WIDTH | Value transfer | Type reference (TYPE) | XSLFO_LENGTH | 20081014 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_XSLFO_OUTPUT_ERROR |
20081014 |
Method OUTPUT_TEXT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_COLOR | Call by reference | Type reference (TYPE) | XSLFO_COLOR | '#000000' | XSL-FO color containing 6 hex char preceded by # | 20081014 | |
| 2 | Importing |
IV_FONTID | Call by reference | Type reference (TYPE) | XSLFO_FONTID | XSL-FO font identifier for renderer | 20081014 | ||
| 3 | Importing |
IV_GLYPHS | Call by reference | Type reference (TYPE) | STRING | 20081014 | |||
| 4 | Importing |
IV_GLYPHS_WIDTH | Call by reference | Type reference (TYPE) | XSLFO_LENGTH | XSL-FO length in thousandth part of a point (at 72dpi) | 20081014 | ||
| 5 | Importing |
IV_OVERLINE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20081014 | ||
| 6 | Importing |
IV_STRIKETHROUGH | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20081014 | ||
| 7 | Importing |
IV_UNDERLINE | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | 20081014 | ||
| 8 | Importing |
IV_X | Call by reference | Type reference (TYPE) | XSLFO_LENGTH | XSL-FO length in thousandth part of a point (at 72dpi) | 20081014 | ||
| 9 | Importing |
IV_Y | Call by reference | Type reference (TYPE) | XSLFO_LENGTH | XSL-FO length in thousandth part of a point (at 72dpi) | 20081014 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_XSLFO_OUTPUT_ERROR |
20081014 |
Method SELECT_FONT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_COUNTRY | Call by reference | Type reference (TYPE) | XSLFO_ISOCOUNTRY | '' | XSL-FO ISO 3166-1 Country Code | 20081014 | |
| 2 | Importing |
IV_FAMILY | Call by reference | Type reference (TYPE) | STRING | Font name or font family name | 20081014 | ||
| 3 | Importing |
IV_LANGUAGE | Call by reference | Type reference (TYPE) | XSLFO_ISOLANG | '' | XSL-FO ISO 639-2 Language | 20081014 | |
| 4 | Importing |
IV_SCRIPT | Call by reference | Type reference (TYPE) | XSLFO_ISOSCRIPT | '' | XSL-FO ISO 15924 Script Code | 20081014 | |
| 5 | Importing |
IV_SIZE | Call by reference | Type reference (TYPE) | XSLFO_LENGTH | XSL-FO length in thousandth part of a point (at 72dpi) | 20081014 | ||
| 6 | Importing |
IV_STRETCH | Call by reference | Type reference (TYPE) | XSLFO_ENUM | CO_FONT_STRETCH_NORMAL | XSL-FO enumerated data type | 20081014 | |
| 7 | Importing |
IV_STYLE | Call by reference | Type reference (TYPE) | XSLFO_ENUM | CO_FONT_STYLE_NORMAL | XSL-FO enumerated data type | 20081014 | |
| 8 | Importing |
IV_VARIANT | Call by reference | Type reference (TYPE) | XSLFO_ENUM | CO_FONT_VARIANT_NORMAL | XSL-FO enumerated data type | 20081014 | |
| 9 | Importing |
IV_WEIGHT | Call by reference | Type reference (TYPE) | XSLFO_ENUM | CO_FONT_WEIGHT_500 | XSL-FO enumerated data type | 20081014 | |
| 10 | Returning |
RV_FONTID | Value transfer | Type reference (TYPE) | XSLFO_FONTID | XSL-FO font identifier for renderer | 20081014 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_XSLFO_OUTPUT_ERROR |
20081014 |
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 720 |
