SAP ABAP Class CL_UPE_OUTPUTDEV (Model for UPE-enhanced output device)
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_OUTPUTDEV | |
| Short Description | Model for UPE-enhanced output device | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | UPE | |
| Program status | ||
| Category | 0 | |
| Package | SPOO | Spool |
| Created | 20120524 | 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_FIT_LANGINFO |
Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
Interfaces
Class CL_UPE_OUTPUTDEV has no interface implemented.
Friends
Class CL_UPE_OUTPUTDEV has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | C_TSP03A_LINE_UPEINFO |
Constant | Public | Type reference (TYPE) | NUM8 | 1 | Eight-digit numeric value | 20120524 | |
| 2 | C_TSP03A_PARAM_UPEINFO |
Constant | Public | Type reference (TYPE) | RSPOPARAM | 'UPEINFO' | Parameter name for spool settings | 20120524 | |
| 3 | DEVTYPE |
Instance attribute | Public | Type reference (TYPE) | RSPOPTYPE | Spool: Device type name | 20120524 | ||
| 4 | NO_UPE_FOR_ABAPLISTS |
Instance attribute | Public | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Do not use UPE for ABAP list printing? | 20120524 | |
| 5 | OUTPUTDEST |
Instance attribute | Public | Type reference (TYPE) | RSPOPNAME | Spool: Output device | 20120524 | ||
| 6 | OUTPUTDEVICE |
Instance attribute | Public | Type reference (TYPE) | RSPOLNAME | Spool: Long device names | 20120524 | ||
| 7 | PCL5_USE_TYPE15_FONTDOWNLOAD |
Instance attribute | Public | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Use "extended type-15" format for TrueType Font download | 20120524 | |
| 8 | STATUS_CHANGED |
Instance attribute | Public | Type reference (TYPE) | ABAP_BOOL | Has status changed? | 20120524 | ||
| 9 | UPE_DEVTYPE |
Instance attribute | Public | Object reference (TYPE REF TO) | CL_UPE_DEVTYPE | Model for UPE-enhanced device type | 20120524 | ||
| 10 | UPE_ENABLED |
Instance attribute | Public | Type reference (TYPE) | ABAP_BOOL | Is outputdev UPE-enabled? | 20120524 | ||
| 11 | UPE_POSSIBLE |
Instance attribute | Public | Type reference (TYPE) | ABAP_BOOL | Is UPE possible? | 20120524 | ||
| 12 | UPE_STATUS_TEXT |
Instance attribute | Public | Type reference (TYPE) | STRING | nfo for SPAD: is enabled, can be enabled, cannot, ... | 20120524 | ||
| 13 | URDT |
Instance attribute | Public | Type reference (TYPE) | RSPOPTYPE | Spool: Device type name | 20120524 | ||
| 14 | USE_ONLY_TTFONTS |
Instance attribute | Public | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | gnore resident fonts, print only via URDT TTfonts | 20120524 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CONSTRUCTOR |
Instance method | Public | Constructor | Constructor | 20120524 |
| 2 | CREATE_FROM_DB |
Static method | Public | Method | Create from saved outputdev data | 20120524 |
| 3 | GET_SUP_LANGUAGES |
Instance method | Public | Method | Get list of supported languages/charsets | 20130114 |
| 4 | GET_URDT_USAGE |
Static method | Public | Method | Get list of all output devices using a certain URDT | 20120613 |
| 5 | GET_USED_URDTS |
Static method | Public | Method | Get list of all URDTs used with output devices | 20120612 |
| 6 | SAVE_TO_DB |
Instance method | Public | Method | Save data to DB | 20120524 |
| 7 | SHOW_SUP_LANGUAGES |
Instance method | Public | Method | Show list of supported languages/charsets | 20120719 |
| 8 | UPDATE_STATUSTEXT |
Instance method | Private | Method | Update info text for SPAD | 20120524 |
| 9 | UPE_DISABLE |
Instance method | Public | Method | UPE-disable | 20120524 |
| 10 | UPE_ENABLE |
Instance method | Public | Method | UPE-enable | 20120524 |
| 11 | UPE_ENABLE_DIALOG |
Instance method | Public | Method | UPE-enable a printer via dialog popup | 20120524 |
Events
Class CL_UPE_OUTPUTDEV has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | T_OUTPUTDEVTAB | Public | See coding | Table of output device names | 20120613 | T_OUTPUTDEVTAB type standard table of rspolname with default key
|
|
| 2 | T_URDTINFOTAB | Public | See coding | Table of URDT names and printers using a URDT | 20120612 | T_URDTINFOTAB type sorted table of T_URDT_OUTPUTDEV with unique key urdtname
|
|
| 3 | T_URDT_OUTPUTDEV | Public | See coding | Structure of URDT plus printer name | 20120612 | begin of T_URDT_OUTPUTDEV,
urdtname type rspoptype,
outputdev type rspolname,
end of T_URDT_OUTPUTDEV
|
Method Signatures
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IM_DEVTYPE | Call by reference | Type reference (TYPE) | RSPOPTYPE | Spool: Device type name | 20120524 | ||
| 2 | Importing |
IM_OUTPUTDEST | Call by reference | Type reference (TYPE) | RSPOPNAME | SPACE | Spool: Output device short name | 20120524 | |
| 3 | Importing |
IM_OUTPUTDEVICE | Call by reference | Type reference (TYPE) | RSPOLNAME | Spool: Long device names | 20120524 | ||
| 4 | Importing |
IM_URDT | Call by reference | Type reference (TYPE) | RSPOPTYPE | SPACE | URDT | 20120524 |
Method CONSTRUCTOR on class CL_UPE_OUTPUTDEV has no exception.
Method CREATE_FROM_DB Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_OUTPUTDEVICE | Call by reference | Type reference (TYPE) | RSPOLNAME | Spool: Long device names | 20120524 | ||
| 2 |  Returning |
RT_UPEOUTPDEV | Value transfer | Object reference (TYPE REF TO) | CL_UPE_OUTPUTDEV | Model for UPE-enhanced output device | 20120524 |
Method CREATE_FROM_DB on class CL_UPE_OUTPUTDEV has no exception.
Method GET_SUP_LANGUAGES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RT_LANGOBJTAB | Value transfer | Type reference (TYPE) | CL_UPE_FIT_LANGINFO=>T_LANGOBJLIST | Table of language objects | 20130114 |
Method GET_SUP_LANGUAGES on class CL_UPE_OUTPUTDEV has no exception.
Method GET_URDT_USAGE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_URDT | Call by reference | Type reference (TYPE) | RSPOPTYPE | Name of URDT | 20120613 | ||
| 2 | Returning |
RT_OUTPUTDEVTAB | Value transfer | Type reference (TYPE) | T_OUTPUTDEVTAB | List of output devices which use URDT | 20120613 |
Method GET_URDT_USAGE on class CL_UPE_OUTPUTDEV has no exception.
Method GET_USED_URDTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RT_URDTS | Value transfer | Type reference (TYPE) | T_URDTINFOTAB | Table of URDTs and output device using it | 20120612 |
Method GET_USED_URDTS on class CL_UPE_OUTPUTDEV has no exception.
Method SAVE_TO_DB Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
RT_ERRMSG | Value transfer | Type reference (TYPE) | STRING | error msg | 20120524 |
Method SAVE_TO_DB on class CL_UPE_OUTPUTDEV has no exception.
Method SHOW_SUP_LANGUAGES Signature
Method SHOW_SUP_LANGUAGES on class CL_UPE_OUTPUTDEV has no parameter.
Method SHOW_SUP_LANGUAGES on class CL_UPE_OUTPUTDEV has no exception.
Method UPDATE_STATUSTEXT Signature
Method UPDATE_STATUSTEXT on class CL_UPE_OUTPUTDEV has no parameter.
Method UPDATE_STATUSTEXT on class CL_UPE_OUTPUTDEV has no exception.
Method UPE_DISABLE Signature
Method UPE_DISABLE on class CL_UPE_OUTPUTDEV has no parameter.
Method UPE_DISABLE on class CL_UPE_OUTPUTDEV has no exception.
Method UPE_ENABLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_NO_UPE_FOR_ABAPLISTS | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Do not use UPE for list printing | 20120524 | |
| 2 | Importing |
IM_PCL5_USE_TYPE15_DOWNLOAD | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Use extended type-15 format for TrueType font download | 20120524 | |
| 3 | Importing |
IM_URDT | Call by reference | Type reference (TYPE) | RSPOPTYPE | Spool: Device type name | 20120524 | ||
| 4 | Importing |
IM_USE_ONLY_TTFONTS | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | Ignore all resident fonts, use only TTFonts from URDT | 20120524 |
Method UPE_ENABLE on class CL_UPE_OUTPUTDEV has no exception.
Method UPE_ENABLE_DIALOG Signature
Method UPE_ENABLE_DIALOG on class CL_UPE_OUTPUTDEV has no parameter.
Method UPE_ENABLE_DIALOG on class CL_UPE_OUTPUTDEV has no exception.
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in | 732 |
