SAP CL_GUI_DOCUMENT_COMPONENT OO Class - Document Component
CL_GUI_DOCUMENT_COMPONENT is a standard SAP object class available within R/3 SAP systems depending on your version and release level. You can view/maintain the class details by entering its name into the relevant SAP transactions such as SE24, SE80 or even SE84. Below is the documentation available for class CL_GUI_DOCUMENT_COMPONENT including details of:
- Interface class implementations
- Inheritance details
- Methods defined within class ( including link to full details )
- Attributes ( including initial values )
- Class Events
Inheritance
This OO class has a superclass assigned to it, which means it will inherit its objects and methods. The superclass for CL_GUI_DOCUMENT_COMPONENT is CL_ALINK_CONSTANTSMethod list of CL_GUI_DOCUMENT_COMPONENT SAP class
A method is a coding block that performs a certain procedure (i.e. ABAP functionality) on an object within the overall SAP class. In simple terms if the object is an SAP database table a method could be the procedure to add a record or to delete a record. If you are new to OO in many respects, the implementation of a method is similar to a function module and can be called in a very similar way using CALL METHOD.
Instead of "CALL FUNCTION", Methods are referenced using the following syntax: CALL METHOD =>methodname EXPORTING/IMPORTING...
| Method Name | Description | Visability |
| ADD_LAYER | Private | |
| CALL METHOD cl_gui_document_component=>ADD_LAYER...more details | ||
| CHECK_IF_LAYER_EXIST | Private | |
| CALL METHOD cl_gui_document_component=>CHECK_IF_LAYER_EXIST...more details | ||
| CONSTRUCTOR | Constructor | Public |
| CALL METHOD cl_gui_document_component=>CONSTRUCTOR...more details | ||
| CREATE_ECL | Private | |
| CALL METHOD cl_gui_document_component=>CREATE_ECL...more details | ||
| CREATE_LAYER | Private | |
| CALL METHOD cl_gui_document_component=>CREATE_LAYER...more details | ||
| DELETE_LAYER | Private | |
| CALL METHOD cl_gui_document_component=>DELETE_LAYER...more details | ||
|
| ||
| DELETE_LAYER_IN_TABLE | Private | |
| CALL METHOD cl_gui_document_component=>DELETE_LAYER_IN_TABLE...more details | ||
| DISPLAY | Display components | Public |
| CALL METHOD cl_gui_document_component=>DISPLAY...more details | ||
| DISPLAY_ECL | Display Component with ECL Control | Private |
| CALL METHOD cl_gui_document_component=>DISPLAY_ECL...more details | ||
| DISPLAY_HTML | Display Component with HTML Control | Private |
| CALL METHOD cl_gui_document_component=>DISPLAY_HTML...more details | ||
| DISPLAY_LAYER | Private | |
| CALL METHOD cl_gui_document_component=>DISPLAY_LAYER...more details | ||
| GET_COMPONENT | Get Component in DP | Public |
| CALL METHOD cl_gui_document_component=>GET_COMPONENT...more details | ||
| GET_COMPONENT_DESCRIPTION | Private | |
| CALL METHOD cl_gui_document_component=>GET_COMPONENT_DESCRIPTION...more details | ||
| GET_DCL_FROM_MT | Private | |
| CALL METHOD cl_gui_document_component=>GET_DCL_FROM_MT...more details | ||
| GET_DISPLAYSTATUS | Determine the Current Display Status | Public |
| CALL METHOD cl_gui_document_component=>GET_DISPLAYSTATUS...more details | ||
| GET_HOWTODISPLAY | Determine the Type of Display | Public |
| CALL METHOD cl_gui_document_component=>GET_HOWTODISPLAY...more details | ||
| GET_LAYER | Private | |
| CALL METHOD cl_gui_document_component=>GET_LAYER...more details | ||
| GET_MIMETYPE | Private | |
| CALL METHOD cl_gui_document_component=>GET_MIMETYPE...more details | ||
| GET_MIMETYPE_FROM_TABLE | Private | |
| CALL METHOD cl_gui_document_component=>GET_MIMETYPE_FROM_TABLE...more details | ||
| GET_URL | Determine the GET URL for Document Components | Private |
| CALL METHOD cl_gui_document_component=>GET_URL...more details | ||
| ON_DELETE_MARKUP | Private | |
| CALL METHOD cl_gui_document_component=>ON_DELETE_MARKUP...more details | ||
| ON_FILE_DROPPED | Private | |
| CALL METHOD cl_gui_document_component=>ON_FILE_DROPPED...more details | ||
| ON_MARKUP_ACTIVATED | Private | |
| CALL METHOD cl_gui_document_component=>ON_MARKUP_ACTIVATED...more details | ||
| ON_SAVE_LAYER | Private | |
| CALL METHOD cl_gui_document_component=>ON_SAVE_LAYER...more details | ||
| REGISTER_ECL_EVENTS | Private | |
| CALL METHOD cl_gui_document_component=>REGISTER_ECL_EVENTS...more details | ||
| SLEEP | Private | |
| CALL METHOD cl_gui_document_component=>SLEEP...more details | ||
| TRANSLATE_BLANK_TO_REAL | Private | |
| CALL METHOD cl_gui_document_component=>TRANSLATE_BLANK_TO_REAL...more details | ||
| TRANSLATE_REAL_TO_BLANK | Private | |
| CALL METHOD cl_gui_document_component=>TRANSLATE_REAL_TO_BLANK...more details | ||
| UNREGISTER_ECL_EVENTS | Private | |
| CALL METHOD cl_gui_document_component=>UNREGISTER_ECL_EVENTS...more details | ||
| UPDATE_LAYER | Private | |
| CALL METHOD cl_gui_document_component=>UPDATE_LAYER...more details | ||
| WAKEUP | Private | |
| CALL METHOD cl_gui_document_component=>WAKEUP...more details | ||
CL_GUI_DOCUMENT_COMPONENT attributes
List of attributes within class CL_ABAP_CHAR_UTILITIES. These can be referenced using the following syntax CL_ABAP_CHAR_UTILITIES=>. Although depending on where you are inserting the ABAP code you do need to check if the attribute is public or private.
| Name | Level | Description | Initial Value | Type | Visability |
| COMPONENT_URL | Instance Attribute | LIKE | Private | ||
| COM_COMPONENT | Instance Attribute | Components of Stored Documents | LIKE SCMS_COMPS | Private | |
| COM_CONTREP_ID | Instance Attribute | Content Repository Identification | LIKE TOAAR-ARCHIV_ID | Private | |
| COM_DOCUMENT_CLASS | Instance Attribute | SAP ArchiveLink: Document Class | LIKE TOAOM-DOC_TYPE | Private | |
| COM_DOCUMENT_ID | Instance Attribute | SAP ArchiveLink: Document ID | LIKE SAPB-SAPADOKID | Private | |
| COM_LAYER | Instance Attribute | Layer | LIKE AL_COMPONENTS | Private | |
| COM_LAYER_DOCUMENT_CLASS | Instance Attribute | SAP ArchiveLink: Document Class | 'CGM' | LIKE TOAOM-DOC_TYPE | Private |
| COM_MARKUP_OBJECT | Instance Attribute | Markup (Redlining) Component | LIKE CL_GUI_ECL_MARKUP | Private | |
| DISPLAY_STATUS | Instance Attribute | Display Status | LIKE ALINK_DISPLAY_STATUS | Private | |
| ECL_CONTROL | Static Attribute | Engineering Client 2D Viewer | LIKE CL_GUI_ECL_2DVIEWER | Private | |
| HTML_CONTROL | Static Attribute | HTML Control Proxy Class | LIKE CL_GUI_HTML_VIEWER | Private |
Events of Class CL_GUI_DOCUMENT_COMPONENT
Events are created within your class using special event handler methods. These must be registered at runtime for the event and can then be triggered using the ABAP syntax: RAISE EVENT EXPOTING... FILE_DROPPED -Links to Related Class(s)
CL_GUI_D...Full list of available SAP object classes
Search for further information about these or an SAP related objects