SAP CL_GUI_ECL_2DVIEWER OO Class - Engineering Client 2D Viewer
CL_GUI_ECL_2DVIEWER 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_ECL_2DVIEWER 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_ECL_2DVIEWER is CL_GUI_ECL_PRIMARYVIEWERMethod list of CL_GUI_ECL_2DVIEWER 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 |
| CONSTRUCTOR | Constructor | Public |
| CALL METHOD cl_gui_ecl_2dviewer=>CONSTRUCTOR...more details | ||
| CREATE_TOOLBAR | Creates a Toolbar in the Control | Public |
| CALL METHOD cl_gui_ecl_2dviewer=>CREATE_TOOLBAR...more details | ||
| CURRENT_PAGE | Returns the Page Number of the Current Page | Public |
| CALL METHOD cl_gui_ecl_2dviewer=>CURRENT_PAGE...more details | ||
| FIRST_PAGE | Displays the First Page of a Multiple-Page File | Public |
| CALL METHOD cl_gui_ecl_2dviewer=>FIRST_PAGE...more details | ||
| GET_2DCOMPARE_SECONDARY | Returns a 2D Compare Object | Public |
| CALL METHOD cl_gui_ecl_2dviewer=>GET_2DCOMPARE_SECONDARY...more details | ||
| GET_ALL_REG_VALUES | Internal in Class! Determines all Registry Keys of Viewer | Protected |
| CALL METHOD cl_gui_ecl_2dviewer=>GET_ALL_REG_VALUES...more details | ||
|
| ||
| GET_CURRENT_FILE | Returns the URL of the Loaded File | Public |
| CALL METHOD cl_gui_ecl_2dviewer=>GET_CURRENT_FILE...more details | ||
| GET_NUMBER_OF_PAGES | Returns the Number of Pages of a Document | Public |
| CALL METHOD cl_gui_ecl_2dviewer=>GET_NUMBER_OF_PAGES...more details | ||
| GET_VIEWERTYPE | Private | |
| CALL METHOD cl_gui_ecl_2dviewer=>GET_VIEWERTYPE...more details | ||
| LAST_PAGE | Displays the Last Page of a Multiple-Page File | Public |
| CALL METHOD cl_gui_ecl_2dviewer=>LAST_PAGE...more details | ||
| MIRROR_HORIZONTAL | Mirrors a 2D Picture Horizontally | Public |
| CALL METHOD cl_gui_ecl_2dviewer=>MIRROR_HORIZONTAL...more details | ||
| MIRROR_VERTICAL | Mirrors a 2D Picture Vertically | Public |
| CALL METHOD cl_gui_ecl_2dviewer=>MIRROR_VERTICAL...more details | ||
| NEXT_PAGE | Displays the Next Page of a Multiple-Page File | Public |
| CALL METHOD cl_gui_ecl_2dviewer=>NEXT_PAGE...more details | ||
| PASS_EVENT | Internal: Passes Events from the Local Classes | Public |
| CALL METHOD cl_gui_ecl_2dviewer=>PASS_EVENT...more details | ||
| PREVIOUS_PAGE | Displays the Previous Page of a Multiple-Page File | Public |
| CALL METHOD cl_gui_ecl_2dviewer=>PREVIOUS_PAGE...more details | ||
| REGISTER_TOOLBAR_EVENTS | Class-Specific! Registers the Toolbar Events | Protected |
| CALL METHOD cl_gui_ecl_2dviewer=>REGISTER_TOOLBAR_EVENTS...more details | ||
| ROTATE_CLOCKWISE | Rotates the 2D Picture Clockwise | Public |
| CALL METHOD cl_gui_ecl_2dviewer=>ROTATE_CLOCKWISE...more details | ||
| ROTATE_COUNTERCLOCKWISE | Rotates the 2D Picture Anticlockwise | Public |
| CALL METHOD cl_gui_ecl_2dviewer=>ROTATE_COUNTERCLOCKWISE...more details | ||
| ROTATE_PDF | Private | |
| CALL METHOD cl_gui_ecl_2dviewer=>ROTATE_PDF...more details | ||
| SET_CONTEXTMENU_MODE | Sets the Context Menu Mode | Public |
| CALL METHOD cl_gui_ecl_2dviewer=>SET_CONTEXTMENU_MODE...more details | ||
| SET_DND_POLICY | Defines Control Behaviour During Drop Event | Public |
| CALL METHOD cl_gui_ecl_2dviewer=>SET_DND_POLICY...more details | ||
| SET_DOC_META_DATA | Pass Meta Data of Document Currently Loaded | Public |
| CALL METHOD cl_gui_ecl_2dviewer=>SET_DOC_META_DATA...more details | ||
| SET_FOREGROUNDCOLOR | Sets the Foreground Color | Public |
| CALL METHOD cl_gui_ecl_2dviewer=>SET_FOREGROUNDCOLOR...more details | ||
| SET_GREYSCALE_COLOR | Document Colors Are Grey-Scaled | Public |
| CALL METHOD cl_gui_ecl_2dviewer=>SET_GREYSCALE_COLOR...more details | ||
| SET_INVERSE_COLOR | Sets 2D Picture to Inverse Colors | Public |
| CALL METHOD cl_gui_ecl_2dviewer=>SET_INVERSE_COLOR...more details | ||
| SET_JAVA_VIEWER_SETTINGS | Define User Settings (explicitly for Platin) | Public |
| CALL METHOD cl_gui_ecl_2dviewer=>SET_JAVA_VIEWER_SETTINGS...more details | ||
| SET_MONO_COLOR | Sets 2D Picture to Monochrome | Public |
| CALL METHOD cl_gui_ecl_2dviewer=>SET_MONO_COLOR...more details | ||
| SET_PAGE | Sets the Page in a Multiple-Page Document | Public |
| CALL METHOD cl_gui_ecl_2dviewer=>SET_PAGE...more details | ||
| SET_VIEWERFOCUS | Private | |
| CALL METHOD cl_gui_ecl_2dviewer=>SET_VIEWERFOCUS...more details | ||
| SHOW_DOC_META_DATA | Visualize Meta Data on Document | Public |
| CALL METHOD cl_gui_ecl_2dviewer=>SHOW_DOC_META_DATA...more details | ||
CL_GUI_ECL_2DVIEWER 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 |
| ACTUAL_META_DATA | Instance Attribute | Meta Data of Current Document | LIKE DOC_META_DATA | Public | |
| ALL_REG_VALUES | Instance Attribute | All Registry Entries for the Viewer | LIKE | Protected | |
| BMP_1 | Constant | Save: Bitmap, Monochrome | 3 | LIKE I | Public |
| BMP_24 | Constant | Save: Bitmap, Color | 1 | LIKE I | Public |
| BMP_8 | Constant | Save: Bitmap, Greyscale | 2 | LIKE I | Public |
| DND_DO_NOTHING | Constant | DND Policy: No Event Handling | 0 | LIKE I | Public |
| DND_FIRE_EVENT | Constant | DND Policy: FileDroppedEvent is Triggered During Drop Action | 2 | LIKE I | Public |
| DND_OPEN_FILE | Constant | DND Policy: Open the file dropped | 1 | LIKE I | Public |
| EVENT_CALIBRATION_REQUEST | Constant | Event: Annotation Manager Requests Calibration | 3 | LIKE I | Public |
| EVENT_CLOSE_DIRTY_DOC | Constant | Event: Unsaved Documents | 1 | LIKE I | Public |
| EVENT_FILE_DROPPED | Constant | Event: File was dropped | 4 | LIKE I | Public |
| EVENT_TEXT_REQUEST | Constant | Event: Annotation Manager Requests Text | 2 | LIKE I | Public |
| JPEG_24 | Constant | Save: JPEG, Color | 4 | LIKE I | Public |
| LOCAL_EVENT_HANDLER | Instance Attribute | Local Class for Event Handling | LIKE LCL_EVENT_HANDLER | Private | |
| MARKUP_TOOL | Instance Attribute | Class Instance for Redlining/Meta Data | LIKE CL_GUI_ECL_MARKUP | Public | |
| MEASURE_TOOL | Instance Attribute | Class Instance for Measurement Functions | LIKE CL_GUI_ECL_MARKUP | Public | |
| NO_PDF_REDLINE | Instance Attribute | LIKE | Private | ||
| TIFF_1 | Constant | Save: Tiff, Monochrome | 14 | LIKE I | Public |
| TIFF_24 | Constant | Save: Tiff, Color | 12 | LIKE I | Public |
| TIFF_8 | Constant | Save: Tiff, Greyscale | 13 | LIKE I | Public |
| TOOLSACTIVE | Instance Attribute | Tools Active in Toolbar | LIKE CHAR01 | Public | |
| TOOL_STAMP | Instance Attribute | 'X' = Stamp Function Activated | LIKE CHAR01 | Private | |
| USER_DEFINED_BUTTONS | Instance Attribute | User-Defined Buttons | LIKE TTB_BUTTON | Protected |
Events of Class CL_GUI_ECL_2DVIEWER
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... ANNOTATION_CALIBRATION_REQUEST - Annotation Manager Requires a CalibrationMARKUP_ACTIVATED - Markup Secondary Activated
META_DATA_REQUEST - User Wants To Create New Stamp
CL_GUI_ECL_2DVIEWER types
REG_VALUE - Registry Entries for the ViewerLinks to Related Class(s)
CL_GUI_E...Full list of available SAP object classes
Search for further information about these or an SAP related objects