Hierarchy
⤷ 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_CONTROL | Proxy Class for Control in GUI | 19990126 |
Properties
Class | CL_GUI_ECL_VIEWER | |
Short Description | Proxy Class for Engineering Client Viewer | |
Super Class | CL_GUI_CONTROL | Proxy Class for Control in GUI |
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 | 19990126 | SAP |
Last change | 00000000 | SAP |
Shared Memory-enabled | ||
Fixed point arithmetic | ||
Unicode checks active |
Forward declarations
# | Type group / Object type | Type | Type Description |
---|---|---|---|
1 | CNDD | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_GUI_ECL_VIEWER has no interface implemented.
Friends
Class CL_GUI_ECL_VIEWER has no friend class.
Attributes
# | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | INIT_CTX | Instance attribute | Private | Type reference (TYPE) | I | 0 | Indicates whether the ctx menu handler is already created | 19990224 | |
2 | MODE | Instance attribute | Private | Type reference (TYPE) | I | 2 | Indicates whether the control is in 2D or in 3D mode | 19990215 | |
3 | NO_ACTION_MODE | Constant | Public | Type reference (TYPE) | I | 0 | Interaction Mode: No Action | 19990224 | |
4 | PAN_MODE | Constant | Public | Type reference (TYPE) | I | 1 | 3D interaction mode for panning | 19990217 | |
5 | ROTATE_MODE | Constant | Public | Type reference (TYPE) | I | 6 | 3D interaction mode for rotating | 19990217 | |
6 | SEEK_MODE | Constant | Public | Type reference (TYPE) | I | 4 | 2D interaction mode for seeking | 19990217 | |
7 | VIEW_ALL_MODE | Constant | Public | Type reference (TYPE) | I | 5 | 2D interaction mode arranging the image according to fit all | 19990224 | |
8 | X_AXIS_ROTATE_MODE | Constant | Public | Type reference (TYPE) | I | 7 | 3D interaction mode for rotating around an axis | 19990224 | |
9 | Y_AXIS_ROTATE_MODE | Constant | Public | Type reference (TYPE) | I | 8 | 3D interaction mode for rotating around y-axis | 19990224 | |
10 | ZOOM_AREA_MODE | Constant | Public | Type reference (TYPE) | I | 3 | 2D & 3D interaction mode for zooming an image area | 19990217 | |
11 | ZOOM_MODE | Constant | Public | Type reference (TYPE) | I | 2 | 3D interaction mode for zooming | 19990217 | |
12 | Z_AXIS_ROTATE_MODE | Constant | Public | Type reference (TYPE) | I | 9 | 3D interaction mode for rotating around z-axis | 19990224 |
Methods
# | Method | Level | Visibility | Method type | Description | Created on |
---|---|---|---|---|---|---|
1 | CLOSE_DOCUMENT | Instance method | Public | Method | Closes the document in the control | 19990126 |
2 | CONSTRUCTOR | Instance method | Public | Constructor | Constructor | 19990126 |
3 | CURRENT_PAGE | Instance method | Public | Method | 19990217 | |
4 | DISPLAY_COPYRIGHT | Instance method | Public | Method | Displays copyright panel of EAI. | 19990225 |
5 | DRAW | Instance method | Public | Method | Performs a draw operation in the viewer | 19990217 |
6 | FIRST_PAGE | Instance method | Public | Method | Displays the first page of a multi-page 2D file | 19990215 |
7 | GET_NUMBER_OF_PAGES | Instance method | Public | Method | Gives back the number of pages of a 2D file | 19990215 |
8 | IMPORT_DOCUMENT | Instance method | Public | Method | Imports a 3D file to an already existing part or assembly | 19990217 |
9 | LAST_PAGE | Instance method | Public | Method | Displays the last page of a multi-page 2D file | 19990215 |
10 | MIRROR_HORIZONTAL | Instance method | Public | Method | Mirrors a 2D image horizontal | 19990215 |
11 | MIRROR_VERTICAL | Instance method | Public | Method | Mirrors a 2D image vertical | 19990215 |
12 | NEXT_PAGE | Instance method | Public | Method | Displays the next page of a multi-page 2D file | 19990215 |
13 | OPEN_DOCUMENT | Instance method | Public | Method | Opens the document in the control | 19990126 |
14 | PREVIOUS_PAGE | Instance method | Public | Method | Displays the previous page of a multi-page 2D file | 19990215 |
15 | Instance method | Public | Method | Sends the file to standard printer | 19990215 | |
16 | ROTATE_CLOCKWISE | Instance method | Public | Method | Rotates the 2D image clockwise | 19990215 |
17 | ROTATE_COUNTERCLOCKWISE | Instance method | Public | Method | Rotates the 2D image counter clockwise | 19990215 |
18 | SET_AMBIENT_BACKGROUND | Instance method | Public | Method | Sets background color depending on the container's backgroun | 19990224 |
19 | SET_BACKFACEREMOVALMODE | Instance method | Public | Method | Sets the backface-removalmode of the 3D control | 19990215 |
20 | SET_BACKGROUNDCOLOR | Instance method | Public | Method | Sets the background color | 19990215 |
21 | SET_CONTEXTMENU_MODE | Instance method | Public | Method | Sets whether context is enabled or not | 19990217 |
22 | SET_FOREGROUNDCOLOR | Instance method | Public | Method | Sets the foreground color | 19990215 |
23 | SET_INTERACTION_MODE | Instance method | Public | Method | Sets the interaction mode for the control: pan,rotate,zoom,. | 19990217 |
24 | SET_INVERSE_COLOR | Instance method | Public | Method | Sets 2D image to inverse colors | 19990215 |
25 | SET_MONO_COLOR | Instance method | Public | Method | Sets 2D image to mono color mode | 19990215 |
26 | SET_PAGE | Instance method | Public | Method | Sets the page of a multi-page 2D file to be displayed | 19990215 |
Events
# | Event | Type | Visibility | Description | Created on |
---|---|---|---|---|---|
1 | CONTEXT_MENU_REQUEST | Instance Event (0) |
Public (2) |
Context Menu | 19990302 |
2 | CONTEXT_MENU_SELECTED | Instance Event (0) |
Public (2) |
Context Menu Item has been selected | 19990302 |
3 | ON_DRAG | Instance Event (0) |
Public (2) |
Drag Event occured | 19990223 |
4 | ON_DROP | Instance Event (0) |
Public (2) |
Drop Event occured | 19990223 |
5 | ON_DROP_COMPLETE | Instance Event (0) |
Public (2) |
Complete drag and drop operation | 19990223 |
6 | ON_GET_FLAVOR | Instance Event (0) |
Public (2) |
Determine desired flavor | 19990223 |
Types
Class CL_GUI_ECL_VIEWER has no local type.
Method Signatures
Method CLOSE_DOCUMENT Signature
Method CLOSE_DOCUMENT on class CL_GUI_ECL_VIEWER has no parameter.
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | CNTL_ERROR | 19990126 |
Method CONSTRUCTOR Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | AUTOALIGN | Value transfer | Type reference (TYPE) | C | 'x' | Automatische Ausrichtung benutzen? | 19990126 | |
2 | Importing | LIFETIME | Value transfer | Type reference (TYPE) | I | lifetime_default | Lebensdauer | 19990126 | |
3 | Importing | MODE | Value transfer | Type reference (TYPE) | I | 2 | Modus | 19990126 | |
4 | Importing | PARENT | Call by reference | Object reference (TYPE REF TO) | CL_GUI_CONTAINER | Parent-Container | 19990126 | ||
5 | Importing | SHELLSTYLE | Value transfer | Type reference (TYPE) | I | ShellStyle | 19990126 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | Control-Fehler | 19990126 | |
2 | CNTL_INSTALL_ERROR | Fehler bei Control-Installation | 19990126 |
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 | 19990217 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | 19990217 |
Method DISPLAY_COPYRIGHT Signature
Method DISPLAY_COPYRIGHT on class CL_GUI_ECL_VIEWER has no parameter.
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | CNTL_ERROR | 19990225 |
Method DRAW Signature
Method DRAW on class CL_GUI_ECL_VIEWER has no parameter.
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | 19990217 |
Method FIRST_PAGE Signature
Method FIRST_PAGE on class CL_GUI_ECL_VIEWER has no parameter.
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | CNTL_ERROR | 19990215 |
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 | 19990216 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | CNTL_ERROR | 19990215 |
Method IMPORT_DOCUMENT Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Exporting | ERROR_CODE | Call by reference | Type reference (TYPE) | I | Fehlercode | 19990222 | ||
2 | Importing | FILE | Call by reference | Type reference (TYPE) | C | 19990217 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | BAD_FILE_NAME | BAD_FILE_NAME | 19990222 | |
2 | CNTL_ERROR | 19990217 | ||
3 | CNTL_INSTALL_ERROR | CNTL_INSTALL_ERROR | 19990222 | |
4 | FILE_NOT_FOUND | FILE_NOT_FOUND | 19990222 | |
5 | INVALID_DATA | INVALID_DATA | 19990222 | |
6 | INVALID_FILE_FORMAT | INVALID_FILE_FORMAT | 19990222 | |
7 | PERMISSION_DENIED | PERMISSION_DENIED | 19990222 |
Method LAST_PAGE Signature
Method LAST_PAGE on class CL_GUI_ECL_VIEWER has no parameter.
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | CNTL_ERROR | 19990215 |
Method MIRROR_HORIZONTAL Signature
Method MIRROR_HORIZONTAL on class CL_GUI_ECL_VIEWER has no parameter.
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | CNTL_ERROR | 19990215 |
Method MIRROR_VERTICAL Signature
Method MIRROR_VERTICAL on class CL_GUI_ECL_VIEWER has no parameter.
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | CNTL_ERROR | 19990215 |
Method NEXT_PAGE Signature
Method NEXT_PAGE on class CL_GUI_ECL_VIEWER has no parameter.
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | CNTL_ERROR | 19990215 |
Method OPEN_DOCUMENT Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Exporting | ERROR_CODE | Call by reference | Type reference (TYPE) | I | Fehlercode | 19990126 | ||
2 | Importing | FILE | Call by reference | Type reference (TYPE) | C | Datei | 19990126 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | BAD_FILE_NAME | Unzulässiger Dateiname | 19990126 | |
2 | CNTL_ERROR | Control-Fehler | 19990126 | |
3 | CNTL_INSTALL_ERROR | Fehler bei Control-Installation | 19990126 | |
4 | FILE_NOT_FOUND | Datei nicht gefunden | 19990126 | |
5 | INVALID_DATA | Ungültige Daten | 19990126 | |
6 | INVALID_FILE_FORMAT | Ungültige Datei | 19990126 | |
7 | PERMISSION_DENIED | Berechtigung verweigert | 19990126 |
Method PREVIOUS_PAGE Signature
Method PREVIOUS_PAGE on class CL_GUI_ECL_VIEWER has no parameter.
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | CNTL_ERROR | 19990215 |
Method PRINT Signature
Method PRINT on class CL_GUI_ECL_VIEWER has no parameter.
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | CNTL_ERROR | 19990215 |
Method ROTATE_CLOCKWISE Signature
Method ROTATE_CLOCKWISE on class CL_GUI_ECL_VIEWER has no parameter.
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | CNTL_ERROR | 19990215 |
Method ROTATE_COUNTERCLOCKWISE Signature
Method ROTATE_COUNTERCLOCKWISE on class CL_GUI_ECL_VIEWER has no parameter.
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | CNTL_ERROR | 19990215 |
Method SET_AMBIENT_BACKGROUND Signature
Method SET_AMBIENT_BACKGROUND on class CL_GUI_ECL_VIEWER has no parameter.
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | CNTL_ERROR | 19990224 |
Method SET_BACKFACEREMOVALMODE Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | BACKFACEREMOVALMODE | Call by reference | Type reference (TYPE) | I | 0 | Backface-Deaktivierungsmodus für 3D-Control | 19990215 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | CNTL_ERROR | 19990215 |
Method SET_BACKGROUNDCOLOR Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | COLOR | Value transfer | Type reference (TYPE) | C | '16777215' | Farbe für Hintergrund | 19990215 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | CNTL_ERROR | 19990215 |
Method SET_CONTEXTMENU_MODE Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | CONTEXTMENUMODE | Value transfer | Type reference (TYPE) | I | 2 | 0=Kontextmenü aus, 1=Kontextmenü an, 2=SAP-Kontextmenü | 19990217 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | 19990217 |
Method SET_FOREGROUNDCOLOR Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | COLOR | Value transfer | Type reference (TYPE) | C | '0' | Farbe für Vordergrund | 19990215 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | CNTL_ERROR | 19990215 |
Method SET_INTERACTION_MODE Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | INTERACTIONMODE | Call by reference | Type reference (TYPE) | I | 0 | 19990217 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | 19990217 |
Method SET_INVERSE_COLOR Signature
Method SET_INVERSE_COLOR on class CL_GUI_ECL_VIEWER has no parameter.
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | CNTL_ERROR | 19990215 |
Method SET_MONO_COLOR Signature
Method SET_MONO_COLOR on class CL_GUI_ECL_VIEWER has no parameter.
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | CNTL_ERROR | 19990215 |
Method SET_PAGE Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | PAGE | Value transfer | Type reference (TYPE) | I | 1 | Zu setzende Seitenzahl für mehrseitiges 2D-Dokument | 19990215 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | CNTL_ERROR | 19990215 |
Event Signatures
Event CONTEXT_MENU_REQUEST Signature
# | Parameter | Type | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | MENU | Exporting | Value transfer | Object reference (TYPE REF TO) | CL_CTMENU | 19990302 |
Event CONTEXT_MENU_SELECTED Signature
# | Parameter | Type | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | FCODE | Exporting | Value transfer | Type reference (TYPE) | C | 19990302 |
Event ON_DRAG Signature
# | Parameter | Type | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | DRAGDROP_OBJECT | Exporting | Value transfer | Object reference (TYPE REF TO) | CL_DRAGDROPOBJECT | Drag&Drop-Objekt | 19990223 | ||
2 | FILE | Exporting | Value transfer | Type reference (TYPE) | C | Dateiname | 19990223 |
Event ON_DROP Signature
# | Parameter | Type | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | DRAGDROP_OBJECT | Exporting | Value transfer | Object reference (TYPE REF TO) | CL_DRAGDROPOBJECT | Drag&Drop-Objekt | 19990223 | ||
2 | FILE | Exporting | Value transfer | Type reference (TYPE) | C | Dateiname | 19990223 |
Event ON_DROP_COMPLETE Signature
# | Parameter | Type | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | DRAGDROP_OBJECT | Exporting | Value transfer | Object reference (TYPE REF TO) | CL_DRAGDROPOBJECT | Drag&Drop-Objekt | 19990223 | ||
2 | FILE | Exporting | Value transfer | Type reference (TYPE) | C | Dateiname | 19990223 |
Event ON_GET_FLAVOR Signature
# | Parameter | Type | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | DRAGDROP_OBJECT | Exporting | Value transfer | Object reference (TYPE REF TO) | CL_DRAGDROPOBJECT | Drag&Drop-Objekt, dem ein Flavor zugeordnet werden soll | 19990223 | ||
2 | FILE | Exporting | Value transfer | Type reference (TYPE) | C | Dateiname | 19990223 | ||
3 | FLAVORS | Exporting | Value transfer | Type reference (TYPE) | CNDD_FLAVORS | Verfügbare Flavors: Wählen Sie eines aus | 19990223 |
History
Last changed by/on | SAP | 00000000 |
SAP Release Created in |