SAP ABAP Class CL_GUI_ECL_2DVIEWER (Engineering Client 2D Viewer)
Hierarchy
SAP_BASIS (Software Component) SAP Basis Component
   BC-CI (Application Component) Component Integration / Installation Windows Components
     SECLVIEWER (Package) Engineering Client Viewer for 2D/3D objects
Meta Relationship - Using
# Relationship type Using Short Description Created on
1 Inheritance (c INHERITING FROM c_ref)  CL_GUI_ECL_PRIMARYVIEWER Basis Class for ECL Viewers (2D und 3D) 19990504
Properties
Class CL_GUI_ECL_2DVIEWER  
Short Description Engineering Client 2D Viewer    
Super Class CL_GUI_ECL_PRIMARYVIEWER Basis Class for ECL Viewers (2D und 3D) 
Instantiability of a Class 2  Public 
Final    
General Data
Message Class    
Program status     
Category 0   
Package SECLVIEWER   Engineering Client Viewer for 2D/3D objects 
Created 19990504   SAP 
Last change 20110908   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
Class CL_GUI_ECL_2DVIEWER has no forward declaration.
Interfaces
Class CL_GUI_ECL_2DVIEWER has no interface implemented.
Friends
Class CL_GUI_ECL_2DVIEWER has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 ACTUAL_META_DATA Instance attribute Public Type reference (TYPE) DOC_META_DATA Meta Data of Current Document 20000720
2 ALL_REG_VALUES Instance attribute Protected See coding All Registry Entries for the Viewer 20001009
3 BMP_1 Constant Public Type reference (TYPE) I 3 Save: Bitmap, Monochrome 19991207
4 BMP_24 Constant Public Type reference (TYPE) I 1 Save: Bitmap, Color 19991207
5 BMP_8 Constant Public Type reference (TYPE) I 2 Save: Bitmap, Greyscale 19991207
6 DND_DO_NOTHING Constant Public Type reference (TYPE) I 0 DND Policy: No Event Handling 19991011
7 DND_FIRE_EVENT Constant Public Type reference (TYPE) I 2 DND Policy: FileDroppedEvent is Triggered During Drop Action 19991011
8 DND_OPEN_FILE Constant Public Type reference (TYPE) I 1 DND Policy: Open the file dropped 19991011
9 EVENT_CALIBRATION_REQUEST Constant Public Type reference (TYPE) I 3 Event: Annotation Manager Requests Calibration 19990826
10 EVENT_CLOSE_DIRTY_DOC Constant Public Type reference (TYPE) I 1 Event: Unsaved Documents 19990826
11 EVENT_FILE_DROPPED Constant Public Type reference (TYPE) I 4 Event: File was dropped 19991011
12 EVENT_TEXT_REQUEST Constant Public Type reference (TYPE) I 2 Event: Annotation Manager Requests Text 19990826
13 JPEG_24 Constant Public Type reference (TYPE) I 4 Save: JPEG, Color 19991207
14 LOCAL_EVENT_HANDLER Instance attribute Private Object reference (TYPE REF TO) LCL_EVENT_HANDLER Local Class for Event Handling 20000229
15 MARKUP_TOOL Instance attribute Public Object reference (TYPE REF TO) CL_GUI_ECL_MARKUP Class Instance for Redlining/Meta Data 20000822
16 MEASURE_TOOL Instance attribute Public Object reference (TYPE REF TO) CL_GUI_ECL_MARKUP Class Instance for Measurement Functions 19991129
17 NO_PDF_REDLINE Instance attribute Public Type reference (TYPE) CHAR01 20030906
18 TIFF_1 Constant Public Type reference (TYPE) I 14 Save: Tiff, Monochrome 19991207
19 TIFF_24 Constant Public Type reference (TYPE) I 12 Save: Tiff, Color 19991207
20 TIFF_8 Constant Public Type reference (TYPE) I 13 Save: Tiff, Greyscale 19991207
21 TOOLSACTIVE Instance attribute Public Type reference (TYPE) CHAR01 Tools Active in Toolbar 20000719
22 TOOL_STAMP Instance attribute Private Type reference (TYPE) CHAR01 'X' = Stamp Function Activated 20010716
23 USER_DEFINED_BUTTONS Instance attribute Protected Type reference (TYPE) TTB_BUTTON User-Defined Buttons 20001016
Methods
# Method Level Visibility Method type Description Created on
1 CONSTRUCTOR Instance method Public Constructor Constructor 19990504
2 CREATE_TOOLBAR Instance method Public Method Creates a Toolbar in the Control 19990610
3 CURRENT_PAGE Instance method Public Method Returns the Page Number of the Current Page 19990505
4 FIRST_PAGE Instance method Public Method Displays the First Page of a Multiple-Page File 19990505
5 GET_2DCOMPARE_SECONDARY Instance method Public Method Returns a 2D Compare Object 20000515
6 GET_ALL_REG_VALUES Instance method Protected Method Internal in Class! Determines all Registry Keys of Viewer 20001009
7 GET_CURRENT_FILE Instance method Public Method Returns the URL of the Loaded File 19991108
8 GET_NUMBER_OF_PAGES Instance method Public Method Returns the Number of Pages of a Document 19990505
9 GET_VIEWERTYPE Instance method Public Method 20030623
10 LAST_PAGE Instance method Public Method Displays the Last Page of a Multiple-Page File 19990505
11 MIRROR_HORIZONTAL Instance method Public Method Mirrors a 2D Picture Horizontally 19990505
12 MIRROR_VERTICAL Instance method Public Method Mirrors a 2D Picture Vertically 19990505
13 NEXT_PAGE Instance method Public Method Displays the Next Page of a Multiple-Page File 19990505
14 PASS_EVENT Instance method Public Method Internal: Passes Events from the Local Classes 19990715
15 PREVIOUS_PAGE Instance method Public Method Displays the Previous Page of a Multiple-Page File 19990505
16 REGISTER_TOOLBAR_EVENTS Instance method Protected Method Class-Specific! Registers the Toolbar Events 19990610
17 ROTATE_CLOCKWISE Instance method Public Method Rotates the 2D Picture Clockwise 19990505
18 ROTATE_COUNTERCLOCKWISE Instance method Public Method Rotates the 2D Picture Anticlockwise 19990505
19 ROTATE_PDF Instance method Public Method 20030707
20 SET_CONTEXTMENU_MODE Instance method Public Method Sets the Context Menu Mode 19990505
21 SET_DND_POLICY Instance method Public Method Defines Control Behaviour During Drop Event 19991011
22 SET_DOC_META_DATA Instance method Public Method Pass Meta Data of Document Currently Loaded 20000720
23 SET_FOREGROUNDCOLOR Instance method Public Method Sets the Foreground Color 19990505
24 SET_GREYSCALE_COLOR Instance method Public Method Document Colors Are Grey-Scaled 20000524
25 SET_INVERSE_COLOR Instance method Public Method Sets 2D Picture to Inverse Colors 19990505
26 SET_JAVA_VIEWER_SETTINGS Instance method Public Method Define User Settings (explicitly for Platin) 20001211
27 SET_MONO_COLOR Instance method Public Method Sets 2D Picture to Monochrome 19990505
28 SET_PAGE Instance method Public Method Sets the Page in a Multiple-Page Document 19990505
29 SET_VIEWERFOCUS Instance method Public Method 20020411
30 SHOW_DOC_META_DATA Instance method Public Method Visualize Meta Data on Document 20000822
Events
# Event Type Visibility Description Created on
1 ANNOTATION_CALIBRATION_REQUEST Instance Event
(0)
Public
(2)
Annotation Manager Requires a Calibration 19990826
2 MARKUP_ACTIVATED Instance Event
(0)
Public
(2)
Markup Secondary Activated 20000224
3 META_DATA_REQUEST Instance Event
(0)
Public
(2)
User Wants To Create New Stamp 20000720
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 REG_VALUE Protected See coding Registry Entries for the Viewer 20001009
Method Signatures

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing AUTOALIGN Call by reference Type reference (TYPE) C 'X' AUTOALIGN 19990504
2 Importing LIFETIME Call by reference Type reference (TYPE) I LIFETIME 19990504
3 Importing PARENT Call by reference Object reference (TYPE REF TO) CL_GUI_CONTAINER Parent container of control 19990504
4 Importing SHELLSTYLE Value transfer Type reference (TYPE) I SHELLSTYLE 19990504
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19990504
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 19990608
3 CREATE_ERROR CREATE_ERROR 19990624
4 LIFETIME_ERROR LIFETIME_ERROR 19990624

Method CREATE_TOOLBAR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CLOSE_BUTTON Call by reference Type reference (TYPE) C Mit ('X') oder ohne (' ') Beenden-Button 19990816
2 Importing NAVIGATION Call by reference Type reference (TYPE) C 'X' Mit ('X') oder ohne (' ') Navigation-Menu 19990909
3 Importing OPTIONS Call by reference Type reference (TYPE) C 'X' Mit ('X') oder ohne (' ') Optionen-Menu 19990909
4 Importing REMOVE_DOCUMENT Call by reference Type reference (TYPE) C 'X' = mit Lösch-Button, ' ' = ohne 20000104
5 Importing TOOLS Call by reference Type reference (TYPE) C Mit ('X') oder ohne (' ') Werkzeuge-Menu 19990826
6 Importing TOOL_COMPARE Call by reference Type reference (TYPE) C 'X' 'X' = Mit Compare Untermenu 20000515
7 Importing TOOL_MEASUREMENT Call by reference Type reference (TYPE) C 'X' 'X' = mit Untermenu für Bemaßungsfunktionen 19991208
8 Importing TOOL_STAMP Call by reference Type reference (TYPE) C '' 'X' = Mit Stempel-Untermenu 20010716
9 Importing VIEWER Call by reference Type reference (TYPE) C 'X' Mit ('X') oder ohne (' ') Viewer-Menu 19990909
10 Importing VIEWER_CLOSEFILE Call by reference Type reference (TYPE) C 'X' ' ' = Datei schließen ist deaktiviert 20000204
11 Importing VIEWER_OPENFILE Call by reference Type reference (TYPE) C 'X' ' ' = Datei öffnen ist deaktiviert 19990909
12 Importing VIEWER_SAVEFILE Call by reference Type reference (TYPE) C 'X' ' ' = Datei speichern ist deaktiviert 19990909
# Exception Resumable Description Created on
1 CNTB_BTYPE_ERROR CNTB_BTYPE_ERROR 19990630
2 CNTL_ERROR CNTL_ERROR 19990624
3 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 19990629
4 DP_ERROR DP_ERROR 19990630
5 WRONG_FCODE_ERROR WRONG_FCODE_ERROR 19991015

Method CURRENT_PAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting NROFCURRENTPAGE Call by reference Type reference (TYPE) I Zahl der aktuell aktiven Seite 19990505
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19990505
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 19990624

Method FIRST_PAGE Signature

Method FIRST_PAGE on class CL_GUI_ECL_2DVIEWER has no parameter.
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19990505
2 CNTL_SYSTEM_ERROR CTNL_SYSTEM_ERROR 19990624

Method GET_2DCOMPARE_SECONDARY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing COMPARE_OBJECT Call by reference Object reference (TYPE REF TO) CL_GUI_OBJECT Compare Objekt 20000515
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 20000515
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 20000515

Method GET_ALL_REG_VALUES Signature

Method GET_ALL_REG_VALUES on class CL_GUI_ECL_2DVIEWER has no parameter.
Method GET_ALL_REG_VALUES on class CL_GUI_ECL_2DVIEWER has no exception.

Method GET_CURRENT_FILE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting FILE_NAME Call by reference Type reference (TYPE) CHAR255 URL der geladenen Datei 19991108
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19991108
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 19991108

Method GET_NUMBER_OF_PAGES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting NROFPAGES Call by reference Type reference (TYPE) I Anzahl der Seiten in einer mehrseitigen 2D-Datei 19990505
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19990505
2 CNTL_SYSTEM_ERROR CTNL_SYSTEM_ERROR 19990624

Method GET_VIEWERTYPE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting VIEWERTYPE Call by reference Type reference (TYPE) C 20030623
# Exception Resumable Description Created on
1 CNTL_ERROR 20030625
2 CNTL_SYSTEM_ERROR 20030625

Method LAST_PAGE Signature

Method LAST_PAGE on class CL_GUI_ECL_2DVIEWER has no parameter.
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19990505
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 19990624

Method MIRROR_HORIZONTAL Signature

Method MIRROR_HORIZONTAL on class CL_GUI_ECL_2DVIEWER has no parameter.
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19990505
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 19990624

Method MIRROR_VERTICAL Signature

Method MIRROR_VERTICAL on class CL_GUI_ECL_2DVIEWER has no parameter.
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19990505
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 19990624

Method NEXT_PAGE Signature

Method NEXT_PAGE on class CL_GUI_ECL_2DVIEWER has no parameter.
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19990505
2 CNTL_SYSTEM_ERROR CTNL_SYSTEM_ERROR 19990624

Method PASS_EVENT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing EVENT_TYPE Call by reference Type reference (TYPE) I Event Typ 19990715
2 Importing LAYER_NAME Call by reference Type reference (TYPE) CHAR40 Layer Name 19990827
3 Importing MARKUP_SECONDARY_OBJECT Call by reference Object reference (TYPE REF TO) CL_GUI_ECL_MARKUP Secondary Referenz 19990715
4 Importing TEMP_DIR Call by reference Type reference (TYPE) CHAR255 Temporäre Datei 19991207

Method PASS_EVENT on class CL_GUI_ECL_2DVIEWER has no exception.

Method PREVIOUS_PAGE Signature

Method PREVIOUS_PAGE on class CL_GUI_ECL_2DVIEWER has no parameter.
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19990505
2 CNTL_SYSTEM_ERROR CTNL_SYSTEM_ERROR 19990624

Method REGISTER_TOOLBAR_EVENTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing MY_TOOLBAR Call by reference Object reference (TYPE REF TO) CL_GUI_TOOLBAR Toolbar 19990610
2 Importing TOOL_COMPARE Call by reference Type reference (TYPE) C 'X' 'X' = mit Compare Untermenü 20000515
3 Importing TOOL_MEASUREMENT Call by reference Type reference (TYPE) C 'X' 'X' = mit Untermenu für Bemaßungsfunktionen 19991208
4 Importing TOOL_STAMP Call by reference Type reference (TYPE) C '' 'X' = mit Stempel-Tool 20010507
5 Importing VIEWER_CLOSEFILE Call by reference Type reference (TYPE) C 'X' Datei schließen Menu-Item ausschalten 20000204
6 Importing VIEWER_OPENFILE Call by reference Type reference (TYPE) C 'X' Datei öffen Menu-Item ausschalten = ' ' 19990909
7 Importing VIEWER_SAVEFILE Call by reference Type reference (TYPE) C 'X' Datei speichern Menu-Item ausschalten = ' ' 19990909
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19990624
2 CTNL_SYSTEM_ERROR CTNL_SYSTEM_ERROR 19990624
3 ILLEGAL_EVENT_COMBINATION ILLEGAL_EVENT_COMBINATION 19990624

Method ROTATE_CLOCKWISE Signature

Method ROTATE_CLOCKWISE on class CL_GUI_ECL_2DVIEWER has no parameter.
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19990505
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 19990624

Method ROTATE_COUNTERCLOCKWISE Signature

Method ROTATE_COUNTERCLOCKWISE on class CL_GUI_ECL_2DVIEWER has no parameter.
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19990505
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 19990624

Method ROTATE_PDF Signature

Method ROTATE_PDF on class CL_GUI_ECL_2DVIEWER has no parameter.
# Exception Resumable Description Created on
1 CNTL_ERROR 20030708
2 CNTL_SYSTEM_ERROR 20030708

Method SET_CONTEXTMENU_MODE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CONTEXTMENUMODE Call by reference Type reference (TYPE) I 2 0 für Kontextmenü aus, 1 für Kontextmenü an 19990505
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19990505
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 19990624
3 ILLEGAL_EVENT_COMBINATION ILLEGAL_EVENT_COMBINATION 19990624

Method SET_DND_POLICY Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing DND_POLICY Call by reference Type reference (TYPE) I 1 Drag and Drop Policy 19991011
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19991011
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 19991011

Method SET_DOC_META_DATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing META_DATA_TAB Call by reference Type reference (TYPE) DOC_META_DATA Tabelle mit Attributnamen, -werten 20000720

Method SET_DOC_META_DATA on class CL_GUI_ECL_2DVIEWER has no exception.

Method SET_FOREGROUNDCOLOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing COLOR Call by reference Type reference (TYPE) C '0' Farbe für Vordergrund 19990505
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19990505
2 CNTL_SYSTEM_ERROR CTNL_SYSTEM_ERROR 19990624

Method SET_GREYSCALE_COLOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing GREYSCALE_QUALITY Call by reference Type reference (TYPE) I 3 3 = hoch, 2 = mittel, 1 = niedrig 20000524
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 20000524
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 20000524

Method SET_INVERSE_COLOR Signature

Method SET_INVERSE_COLOR on class CL_GUI_ECL_2DVIEWER has no parameter.
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19990505
2 CNTL_SYSTEM_ERROR CTNL_SYSTEM_ERROR 19990624

Method SET_JAVA_VIEWER_SETTINGS Signature

Method SET_JAVA_VIEWER_SETTINGS on class CL_GUI_ECL_2DVIEWER has no parameter.
Method SET_JAVA_VIEWER_SETTINGS on class CL_GUI_ECL_2DVIEWER has no exception.

Method SET_MONO_COLOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing MONO_COLOR Call by reference Type reference (TYPE) C 'X' = Monocolor ein 19991207
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19990505
2 CNTL_SYSTEM_ERROR CTNL_SYSTEM_ERROR 19990624

Method SET_PAGE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing PAGE Call by reference Type reference (TYPE) I Zu setzende Seitenzahl für mehrseitiges 2D-Dokument 19990505
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19990505
2 CNTL_SYSTEM_ERROR CTNL_SYSTEM_ERROR 19990624

Method SET_VIEWERFOCUS Signature

Method SET_VIEWERFOCUS on class CL_GUI_ECL_2DVIEWER has no parameter.
Method SET_VIEWERFOCUS on class CL_GUI_ECL_2DVIEWER has no exception.

Method SHOW_DOC_META_DATA Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing COLOR Call by reference Type reference (TYPE) I 0 0 = schwarz, 255 = rot, etc. 20000822
2 Importing FONT Call by reference Type reference (TYPE) CHAR20 Font-Name 20000822
3 Importing INITIAL_TEXT Call by reference Type reference (TYPE) STRING Starttext 20000822
4 Importing SIZE Call by reference Type reference (TYPE) I 2 Größe (1=klein, 3 = groß) 20000822
5 Importing TRANSPARENT Call by reference Type reference (TYPE) CHAR01 'X' 1 = transparent, 0 = nicht transparent 20000822
6 Importing X_POSITION Call by reference Type reference (TYPE) I 10 x-Position 20000822
7 Importing Y_POSITION Call by reference Type reference (TYPE) I 10 y-Position 20000822

Method SHOW_DOC_META_DATA on class CL_GUI_ECL_2DVIEWER has no exception.
Event Signatures

Event ANNOTATION_CALIBRATION_REQUEST Signature
# Parameter Type Pass Value Optional Typing Method Associated Type Default value Description Created on
1 CALIBRATION_DISTANCE Exporting Value transfer Type reference (TYPE) F Kalibrierungsabstand 19990913
2 CALIBRATION_UNIT Exporting Value transfer Type reference (TYPE) I Kalibrierungseinheit 19990913

Event MARKUP_ACTIVATED Signature
# Parameter Type Pass Value Optional Typing Method Associated Type Default value Description Created on
1 MARKUP_SECONDARY_OBJECT Exporting Value transfer Object reference (TYPE REF TO) CL_GUI_ECL_MARKUP Markup-Objekt 20000224

Event META_DATA_REQUEST Signature
Event META_DATA_REQUEST on class CL_GUI_ECL_2DVIEWER has no parameter.
History
Last changed by/on SAP  20110908 
SAP Release Created in