SAP ABAP Class CL_DD_DOCUMENT (Dynamic Documents: Document)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-CI-DYD (Application Component) Dynamic Documents
⤷
SDYNAMICDOCUMENTS (Package) Dynamic Documents
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-CI-DYD (Application Component) Dynamic Documents⤷
SDYNAMICDOCUMENTS (Package) Dynamic DocumentsMeta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_DD_AREA | Dynamic Documents: Document Area | 00000000 |
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_DD_DOCUMENT_FC | Item Detail Display | 20030821 |
| 2 | Inheritance (c INHERITING FROM c_ref) | CL_FCC_DD_DOCUMENT | Display Item Detail | 20121108 |
| 3 | Inheritance (c INHERITING FROM c_ref) | CL_IM_ISHMED_VD_VIEW_HTML | Imp. Class for BAdI Implementation ISHMED_VD_VIEW_HTML | 20020419 |
| 4 | Inheritance (c INHERITING FROM c_ref) | CL_ISHMED_HTML_STSMA | IS-H*MED: HTML Control for Status Profile/Field Types | 20030820 |
| 5 | Inheritance (c INHERITING FROM c_ref) | CL_RMST_DD_DOCUMENT | RMS-TLS: Dynamic Documents | 20020313 |
| 6 | Inheritance (c INHERITING FROM c_ref) | CL_RTM_UI__DETAIL_DOC | Runtime Monitor: Log Record Display | 20020916 |
| 7 | Inheritance (c INHERITING FROM c_ref) | CL_UMB_EBB_DOCUMENT_EX | Dynamic Documents: Document | 20030119 |
Properties
| Class | CL_DD_DOCUMENT | |
| Short Description | Dynamic Documents: Document | |
| Super Class | CL_DD_AREA | Dynamic Documents: Document Area |
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SDYNAMICDOCUMENTS | Dynamic Documents |
| Created | 19980924 | 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 | CNTL |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
| 3 | OLE2 |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
| 4 | SDYDO |
Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_DD_DOCUMENT has no interface implemented.
Friends
Class CL_DD_DOCUMENT has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | AREA_COUNT |
Instance attribute | Public | Type reference (TYPE) | I | Internal Use | 19980925 | ||
| 2 | CODEPAGE |
Instance attribute | Private | Type reference (TYPE) | TCP00-CPCODEPAGE | Internal Use | 20070209 | ||
| 3 | CUSTOM_CONTAINER |
Instance attribute | Public | Object reference (TYPE REF TO) | CL_GUI_CUSTOM_CONTAINER | Internal Use | 20000515 | ||
| 4 | DOCUMENT_ID |
Constant | Protected | Type reference (TYPE) | SDYDO_ELEMENT_NAME | 'A1' | Internal Use | 19991022 | |
| 5 | DOCUMENT_STYLE |
Instance attribute | Protected | Type reference (TYPE) | SDYDO_ATTRIBUTE | Internal Use | 19990226 | ||
| 6 | HTML_CONTROL |
Instance attribute | Public | Object reference (TYPE REF TO) | CL_GUI_HTML_VIEWER | Internal Use | 19990104 | ||
| 7 | MERGED |
Instance attribute | Protected | Type reference (TYPE) | SDYDO_FLAG | Internal Use | 19980929 | ||
| 8 | NO_OF_FRAMES |
Instance attribute | Protected | Type reference (TYPE) | I | Internal Use | 19990719 | ||
| 9 | TABLE_OF_AREAS |
Instance attribute | Protected | Type reference (TYPE) | SDYDO_OBJECT_TABLE | Internal Use | 19980924 | ||
| 10 | TABLE_OF_REGISTRATION |
Instance attribute | Private | Type reference (TYPE) | SDYDO_ELEMENT_IDS | Internal Use | 20080814 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | ADD_STYLE |
Instance method | Public | Method | Not in Release 99 | 19981028 |
| 2 | CONSTRUCTOR |
Instance method | Public | Constructor | Release 99: Internal Use | 19981016 |
| 3 | DISPLAY_DOCUMENT |
Instance method | Public | Method | Displaying Document | 19980925 |
| 4 | EXPORT_DOCUMENT |
Instance method | Public | Method | Export Document | 19990727 |
| 5 | GET_BDS_PICTURES |
Instance method | Protected | Method | Internal Use | 19991019 |
| 6 | GET_HTML_CHARSET |
Instance method | Private | Method | Get Correct HTML Character Set | 20000719 |
| 7 | HORIZONTAL_SPLIT |
Instance method | Public | Method | Horizontal Division of the Document into Two Areas | 19981022 |
| 8 | INITIALIZE_DOCUMENT |
Instance method | Public | Method | Initialize HTML Table | 19990122 |
| 9 | MERGE_AREA |
Instance method | Protected | Method | Release 99: Internal Use | 19980928 |
| 10 | MERGE_DOCUMENT |
Instance method | Public | Method | Merge Document | 19980925 |
| 11 | PRINT_DOCUMENT |
Instance method | Public | Method | Print Document (Instead of Displaying) | 19991123 |
| 12 | REGISTER_EVENTS |
Instance method | Private | Method | Register Events with HTML Control | 20030912 |
| 13 | SET_DOCUMENT_BACKGROUND |
Instance method | Public | Method | Release 99: Internal Use | 19981130 |
| 14 | VERTICAL_SPLIT |
Instance method | Public | Method | Vertical Division of the Document into Two Areas | 19980925 |
| 15 | WEBGUI_PRINT_DOCUMENT |
Instance method | Private | Method | Print Document in Web GUI | 20020419 |
Events
Class CL_DD_DOCUMENT has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | SDYDO_ELEMENT_ID | Private | See coding | Table Row with Element ID + Element | 20080814 | BEGIN OF sdydo_element_id,
html_control TYPE REF TO cl_gui_html_viewer,
id TYPE sdydo_element_name,
element TYPE REF TO object,
END OF sdydo_element_id
|
|
| 2 | SDYDO_ELEMENT_IDS | Private | See coding | Hash Table with Element ID + Element | 20080814 | sdydo_element_ids TYPE HASHED TABLE OF sdydo_element_id
WITH UNIQUE KEY html_control id
|
Method Signatures
Method ADD_STYLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
PROPERTY_TABLE | Call by reference | Type reference (TYPE) | SDYDO_STYLE_TABLE | Tabelle mit Eigenschaften und Werten | 19981028 | ||
| 2 | Importing |
STYLESHEET | Call by reference | Type reference (TYPE) | SDYDO_KEY | x | 19991117 | ||
| 3 |  Exporting |
STYLESHEET_INT | Call by reference | Type reference (TYPE) | STRING | x | 19991118 | ||
| 4 | Importing |
STYLE_CLASS | Call by reference | Type reference (TYPE) | SDYDO_C100 | x | 19981028 |
Method ADD_STYLE on class CL_DD_DOCUMENT has no exception.
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
BACKGROUND_COLOR | Call by reference | Type reference (TYPE) | I | Farb ID | 19990730 | ||
| 2 | Importing |
BDS_STYLESHEET | Call by reference | Type reference (TYPE) | SDYDO_KEY | Verwendung eines im BDS abgelegten Stylesheets | 19991118 | ||
| 3 | Importing |
NO_MARGINS | Call by reference | Type reference (TYPE) | SDYDO_FLAG | 'X': Dokument wird ohne freie Randbereiche erzeugt | 19991229 | ||
| 4 | Importing |
STYLE | Call by reference | Type reference (TYPE) | SDYDO_ATTRIBUTE | Anpassung an den Stil einer bestimmten GUI-Umgebung | 19990226 |
Method CONSTRUCTOR on class CL_DD_DOCUMENT has no exception.
Method DISPLAY_DOCUMENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
CONTAINER | Call by reference | Type reference (TYPE) | SDYDO_VALUE | Name des Containers (Container-Objekt wird neu erzeugt) | 19981030 | ||
| 2 | Importing |
PARENT | Call by reference | Object reference (TYPE REF TO) | CL_GUI_CONTAINER | Container-Objekt (ist schon vorhanden) | 19990129 | ||
| 3 | Importing |
REUSE_CONTROL | Call by reference | Type reference (TYPE) | SDYDO_FLAG | HTML_Control wird wiederverwendet | 19980929 | ||
| 4 | Importing |
REUSE_REGISTRATION | Call by reference | Type reference (TYPE) | SDYDO_FLAG | Registrierung auf Events wird übernommen | 19991201 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  HTML_DISPLAY_ERROR |
Fehler beim Anzeigen des Dokuments im HTML Control | 19990305 |
Method EXPORT_DOCUMENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
TO_FILESYSTEM | Call by reference | Type reference (TYPE) | SDYDO_FLAG | Do Not Use !!!!!!!!!!!!!! | 19990727 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | EXPORT_ERROR |
Fehler beim Export des Dokuments | 19990729 |
Method GET_BDS_PICTURES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
EXTERNAL_HTML_CONTROL | Call by reference | Object reference (TYPE REF TO) | CL_GUI_HTML_VIEWER | 20130503 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | PICTURE_FROM_BDS_ERROR |
Fehler beim Ansprechen eines Bildes aus der BDS-Ablage | 19991019 |
Method GET_HTML_CHARSET Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
HTML_CHARSET | Value transfer | Type reference (TYPE) | ABAP_ENCOD | HTML Character Set | 20000719 |
Method GET_HTML_CHARSET on class CL_DD_DOCUMENT has no exception.
Method HORIZONTAL_SPLIT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
BELOW_AREA | Call by reference | Object reference (TYPE REF TO) | CL_DD_AREA | unterer Bereich (neu erzeugt) | 19981022 | ||
| 2 | Importing |
SPLIT_AREA | Call by reference | Object reference (TYPE REF TO) | CL_DD_AREA | nach der Teilung: oberer Bereich | 19981022 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | BELOW_AREA_ALREADY_USED |
Referenzvariable für below_AREA wurde bereits verwendet | 19990317 | |
| 2 | INVALID_SPLIT_AREA |
SPLIT_AREA ist kein gültiger (im Dok. vorhandener) Bereich | 19990308 | |
| 3 | SPLIT_AREA_EQ_BELOW_AREA |
SPLIT_AREA ist identisch mit BELOW_AREA | 19990308 |
Method INITIALIZE_DOCUMENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
BACKGROUND_COLOR | Call by reference | Type reference (TYPE) | I | Farb ID | 19990802 | ||
| 2 | Importing |
BDS_STYLESHEET | Call by reference | Type reference (TYPE) | SDYDO_KEY | im BDS abgelegtes Stylesheet | 19991118 | ||
| 3 | Importing |
FIRST_TIME | Call by reference | Type reference (TYPE) | C | interner Gebrauch | 19990122 | ||
| 4 | Importing |
NO_MARGINS | Call by reference | Type reference (TYPE) | SDYDO_FLAG | Dokument wird ohne freie Randbereiche erzeugt | 19991229 | ||
| 5 | Importing |
STYLE | Call by reference | Type reference (TYPE) | SDYDO_ATTRIBUTE | Anpassung an den Stil einer bestimmten GUI-Umgebung | 19990226 |
Method INITIALIZE_DOCUMENT on class CL_DD_DOCUMENT has no exception.
Method MERGE_AREA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Changing |
AREA | Call by reference | Object reference (TYPE REF TO) | CL_DD_AREA | aktuelle Area | 19980928 |
Method MERGE_AREA on class CL_DD_DOCUMENT has no exception.
Method MERGE_DOCUMENT Signature
Method MERGE_DOCUMENT on class CL_DD_DOCUMENT has no parameter.
Method MERGE_DOCUMENT on class CL_DD_DOCUMENT has no exception.
Method PRINT_DOCUMENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
REUSE_CONTROL | Call by reference | Type reference (TYPE) | SDYDO_FLAG | HTML_Control wird wiederverwendet | 19991123 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | HTML_PRINT_ERROR |
Fehler beim Drucken des Dokuments | 19991123 |
Method REGISTER_EVENTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
AREA | Call by reference | Object reference (TYPE REF TO) | CL_DD_AREA | 20030915 |
Method REGISTER_EVENTS on class CL_DD_DOCUMENT has no exception.
Method SET_DOCUMENT_BACKGROUND Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
PICTURE_ID | Call by reference | Type reference (TYPE) | SDYDO_KEY | ObjektID des Bildes im BDS (TA OAOR) | 19990120 |
Method SET_DOCUMENT_BACKGROUND on class CL_DD_DOCUMENT has no exception.
Method VERTICAL_SPLIT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
RIGHT_AREA | Call by reference | Object reference (TYPE REF TO) | CL_DD_AREA | Bereich auf der rechten Seite (neu erzeugt) | 19980925 | ||
| 2 | Importing |
SPLIT_AREA | Call by reference | Object reference (TYPE REF TO) | CL_DD_AREA | nach der Teilung: Bereich auf der linken Seite | 19980925 | ||
| 3 | Importing |
SPLIT_WIDTH | Call by reference | Type reference (TYPE) | SDYDO_VALUE | '30%' | Breite des Bereichs auf der linken Seite (z.B. '40%' ) | 19981120 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | INVALID_SPLIT_AREA |
SPLIT_AREA ist kein gültiger (im Dok. vorhandener) Bereich | 19990308 | |
| 2 | RIGHT_AREA_ALREADY_USED |
Referenzvariable für RIGHT_AREA wurde bereits verwendet | 19990317 | |
| 3 | SPLIT_AREA_EQ_RIGHT_AREA |
SPLIT_AREA ist identisch mit RIGHT_AREA | 19990308 |
Method WEBGUI_PRINT_DOCUMENT Signature
Method WEBGUI_PRINT_DOCUMENT on class CL_DD_DOCUMENT has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | HTML_PRINT_ERROR |
Fehler beim Drucken des Dokuments | 20020419 | |
| 2 | PICTURE_FROM_BDS_ERROR |
Fehler beim Ansprechen eines Bildes aus der BDS-Ablage | 20020419 |
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in |
