SAP ABAP Class CL_GUI_ECL_MARKUP (Markup (Redlining) Component)
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_CONTROL Proxy Class for Control in GUI 19990709
Properties
Class CL_GUI_ECL_MARKUP  
Short Description Markup (Redlining) Component    
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 19990709   SAP 
Last change 20110908   SAP 
Shared Memory-enabled    
Fixed point arithmetic    
Unicode checks active    
Forward declarations
Class CL_GUI_ECL_MARKUP has no forward declaration.
Interfaces
Class CL_GUI_ECL_MARKUP has no interface implemented.
Friends
Class CL_GUI_ECL_MARKUP has no friend class.
Attributes
# Attribute Level Visibility Read only Typing Associated Type Initial Value Description Created on
1 ACTUAL_DELETING_FORBIDDEN Instance attribute Public Type reference (TYPE) CHAR01 'X' = Toolbar in 'Delete Not Permitted' State 20000512
2 ACTUAL_MARKUP_FORBIDDEN Instance attribute Public Type reference (TYPE) CHAR01 'X' = Toolbar in 'Redlining Not Permitted' State 20000526
3 ACTUAL_MARKUP_SETTINGS Instance attribute Private Type reference (TYPE) ACTUAL_SETTINGS Current Redlining Settings 20000510
4 ASSIGNED_VIEWER Instance attribute Public Object reference (TYPE REF TO) CL_GUI_ECL_PRIMARYVIEWER Associated Viewer 19990910
5 ASSIGNED_VIEWER_2D Instance attribute Public Object reference (TYPE REF TO) CL_GUI_ECL_2DVIEWER Associated 2D Viewer 19990910
6 ASSIGNED_VIEWER_3D Instance attribute Public Object reference (TYPE REF TO) CL_GUI_ECL_3DVIEWER Associated 3D Viewer 19990817
7 CALIBRATION_REGISTERED Instance attribute Public Type reference (TYPE) CHAR01 'X' = Calibration Event was Registered 20000526
8 DASH Constant Public Type reference (TYPE) I 1 Dash 19990730
9 DASHDOT Constant Public Type reference (TYPE) I 3 Dash-Dot 19990730
10 DASHDOTDOT Constant Public Type reference (TYPE) I 4 Dash-Dot-Dot 19990730
11 DVS_MARKUP_CATEGORIES Instance attribute Private See coding DVS Markup Categories 19990713
12 LEADER_HEAD_STYLE Constant Public Type reference (TYPE) I 1 Guideline Type 19990730
13 LEADER_HEAD_TAIL_STYLE Constant Public Type reference (TYPE) I 3 Guideline Type 19990730
14 LEADER_TAIL_STYLE Constant Public Type reference (TYPE) I 2 Guideline Type 19990730
15 MEASURE_TOOL_ACTIVATED Instance attribute Public Type reference (TYPE) CHAR01 Measurement = 'X'; Redlining = '' 20001211
16 MODE Instance attribute Public Type reference (TYPE) I 2 2D or 3D 19990818
17 SOLID Constant Public Type reference (TYPE) I 0 Solid 19990730
18 THIS_TOOLBAR Instance attribute Public Object reference (TYPE REF TO) CL_GUI_TOOLBAR Associated Toolbar 19990709
19 TOOLBARTYPE Instance attribute Public Type reference (TYPE) I 20030623
Methods
# Method Level Visibility Method type Description Created on
1 ADD_3DMETA_INFO Instance method Public Method Meta Information as Notes 20000526
2 CONSTRUCTOR Instance method Public Constructor Constructor 19990709
3 CREATE_STAMP Instance method Public Method Generates a Stamp 20000518
4 CREATE_TOOLBAR Instance method Public Method Generates a Toolbar for Controlling the Markup Component 19990709
5 DELETE_SELECTED_MARKUPS Instance method Public Method Deletes Single Markup Object 19991028
6 DVS_SET_MARKUP_CATEGORIES Instance method Public Method Especially for DVS Link: Defines Markup Categories 19990713
7 GET_MARKUP_MODE Instance method Public Method Returns the Active Interaction Mode 19990709
8 GET_SETTINGS Instance method Public Method Returns the Settings 19990727
9 HANDLE_EVENT Instance method Public Method Class-Specific! Event Handler 19990714
10 REDO Instance method Public Method Restore the Last Step Reversed 19990901
11 REGISTER_TOOLBAR_EVENTS Instance method Public Method Class-Specific! Registers the Toolbar Events 19990709
12 SAVE_ACTIVE_LAYER Instance method Public Method Saves Markup Layers in a Temporary File 19990720
13 SET_ANNOTATION_MODE Instance method Public Method Enable/Disable Annotation Mode 19990909
14 SET_ANNOTATION_TEXT Instance method Public Method Sets the Markup Text 19990901
15 SET_CALIBRATION Instance method Public Method Calibrate 19991028
16 SET_MARKUP_MODE Instance method Public Method Sets the Markup Mode for the Relevant User Interaction 19990709
17 SET_SETTINGS Instance method Public Method Defines the Settings 19990727
18 UNDO Instance method Public Method Reverse the Last Step 19990901
Events
# Event Type Visibility Description Created on
1 CATEGORY_SELECTED Instance Event
(0)
Public
(2)
DVS Markup Category was Selected 19990719
2 DELETE_MARKUP_REQUEST Instance Event
(0)
Public
(2)
Event is Triggered by the Delete Button in the Toolbar 19990831
3 REDLINING_FINISHED Instance Event
(0)
Public
(2)
Redlining Mode was Exited Through 'Back' Button 20000113
4 SAVE_MARKUP_LAYER Instance Event
(0)
Public
(2)
Markup was Saved 19990831
Types
# Type Visibility Typing Associated Type Description Created on Type Source
1 ACTUAL_SETTINGS Protected See coding ACTUAL_SETTINGS 20000510
2 DVS_MARKUP_CATEGORY Protected See coding 19990713
Method Signatures

Method ADD_3DMETA_INFO Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing PART_HERITAGE Call by reference Type reference (TYPE) CHAR01 Elternknoten des Teils 20000526
2 Importing PART_NAME Call by reference Type reference (TYPE) CHAR01 Name des Teils 20000526
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 20000526
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 20000526

Method CONSTRUCTOR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ASSIGNED_VIEWER Call by reference Object reference (TYPE REF TO) CL_GUI_ECL_PRIMARYVIEWER Zugehöriger 2D oder 3D Viewer 20000127
2 Importing AUTOALIGN Call by reference Type reference (TYPE) C 'X' AUTOALIGN 19990709
3 Importing LIFETIME Call by reference Type reference (TYPE) I LIFETIME 19990709
4 Importing PARENT Call by reference Object reference (TYPE REF TO) CL_GUI_CONTAINER Parent container of control 19990709
5 Importing SHELLSTYLE Value transfer Type reference (TYPE) I SHELLSTYLE 19990709
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19990709
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 19990709
3 CREATE_ERROR CREATE_ERROR 19990709
4 LIFETIME_ERROR LIFETIME_ERROR 19990709
5 NO_ASSIGNED_VIEWER NO_ASSIGNED_VIEWER 19990817

Method CREATE_STAMP Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing STAMP_COLOR Call by reference Type reference (TYPE) I 255 Hintergrundfarbe 20000619
2 Importing STAMP_FONT Call by reference Type reference (TYPE) CHAR20 Font 20000620
3 Importing STAMP_SIZE Call by reference Type reference (TYPE) I 1 = klein, 2 = mittel, 3 = gross 20000518
4 Importing STAMP_TEXT Call by reference Type reference (TYPE) STRING Stempel-Text 20000518
5 Importing STAMP_TRANS Call by reference Type reference (TYPE) CHAR01 'X' = transparent 20000619
6 Importing STAMP_X_POSITION Call by reference Type reference (TYPE) I 10 X-Koordinate des Stempels 20000526
7 Importing STAMP_Y_POSITION Call by reference Type reference (TYPE) I 10 Y-Koordinate des Stempels 20000526
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 20000518
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 20000518

Method CREATE_TOOLBAR Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ARROW Call by reference Type reference (TYPE) C 'X' 'X' = mit Pfeil-Button, ' ' = ohne 19991108
2 Importing DELETE Call by reference Type reference (TYPE) C 'X' 'X' = mit Löschen-Button, ' ' = ohne 19990914
3 Importing ELLIPSE Call by reference Type reference (TYPE) C 'X' 'X' = mit Ellipse, ' ' = ohne 19991108
4 Importing FREEHAND Call by reference Type reference (TYPE) C 'X' 'X' = mit Freihandlinie, ' ' = ohne 19991108
5 Importing IMAGE Call by reference Type reference (TYPE) C 'X' 'X' = mit Bild-Button, ' ' = ohne 20000726
6 Importing LINE Call by reference Type reference (TYPE) C 'X' 'X' = mit Linienbutton, ' ' = ohne 19991108
7 Importing MEASUREMENT Call by reference Type reference (TYPE) C 'X' = mit Meßbuttons, ' ' = ohne 19990914
8 Importing NEW Call by reference Type reference (TYPE) C 'X' 'X' = mit Anlegen-Button, ' ' = ohne 19990914
9 Importing POLYGON Call by reference Type reference (TYPE) C 'X' 'X' = mit Polygon, ' ' = ohne 19991108
10 Importing POLYLINE Call by reference Type reference (TYPE) C 'X' 'X' = mit Polylinie, ' ' = ohne 19991108
11 Importing RECTANGLE Call by reference Type reference (TYPE) C 'X' 'X' = mit Rechteck, ' ' = ohne 19991108
12 Importing REDO Call by reference Type reference (TYPE) C 'X' 'X' = mit Wiederherstellen-Button, ' ' = ohne 19990914
13 Importing SAVE Call by reference Type reference (TYPE) C 'X' 'X' = mit Speichernbutton, ' ' = ohne 19990914
14 Importing SAVE_MEASUREMENT Call by reference Type reference (TYPE) C 'X' = mit Button zum Speichern von Bemaßungen 19991108
15 Importing SETTINGS Call by reference Type reference (TYPE) C 'X' 'X' = mit Button für die Einstellungen 19991129
16 Importing STAMP Call by reference Type reference (TYPE) C 'X' 'X' = mit Stempel-Button, ' ' = ohne 20000518
17 Importing TEXT Call by reference Type reference (TYPE) C 'X' 'X' = mit Text-Button, ' ' = ohne 19991108
18 Importing UNDO Call by reference Type reference (TYPE) C 'X' 'X' = mit Rückgängig-Button, ' ' = ohne 19990914
19 Importing VECTOR_RASTER Call by reference Type reference (TYPE) C 'X' = mit Button-Gruppe zum Umschalten Vektor/Raster Messung 19991130
# Exception Resumable Description Created on
1 CNTB_BTYPE_ERROR CNTB_BTYPE_ERROR 19990709
2 CNTL_ERROR CNTL_ERROR 19990709
3 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 19990709
4 DP_ERROR DP_ERROR 19990709

Method DELETE_SELECTED_MARKUPS Signature

Method DELETE_SELECTED_MARKUPS on class CL_GUI_ECL_MARKUP has no parameter.
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19991028
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 19991028

Method DVS_SET_MARKUP_CATEGORIES Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CATEGORY_DESCRIPTION Call by reference Type reference (TYPE) C Kategorienbeschreibung 19990716
2 Importing CATEGORY_NAME Call by reference Type reference (TYPE) C Markup Kategory 19990713

Method DVS_SET_MARKUP_CATEGORIES on class CL_GUI_ECL_MARKUP has no exception.

Method GET_MARKUP_MODE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting MARKUPMODE Call by reference Type reference (TYPE) I Interaktionsmodus 19990709
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19990709
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 19990709

Method GET_SETTINGS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Exporting ARROW_TYPE Call by reference Type reference (TYPE) I Pfeilart 19990920
2 Exporting CALIBRATION_DISTANCE Call by reference Type reference (TYPE) I Kalibrierungsabstand 19990902
3 Exporting CALIBRATION_UNITS Call by reference Type reference (TYPE) I Kalibrierungseinheiten 19990902
4 Exporting EDGE_COLOR Call by reference Type reference (TYPE) I Eckenfarbe 19990730
5 Exporting EDGE_STYLE Call by reference Type reference (TYPE) I Eckenart 19990727
6 Exporting EDGE_THICKNESS Call by reference Type reference (TYPE) F Eckenstärke 19990730
7 Exporting FILL_COLOR Call by reference Type reference (TYPE) I Füllfarbe 19990727
8 Exporting FILL_STYLE Call by reference Type reference (TYPE) I 20030602
9 Exporting FONT Call by reference Type reference (TYPE) CHAR50 Font 19990730
10 Exporting FONT_COLOR Call by reference Type reference (TYPE) I Textfarbe 19990730
11 Exporting FONT_FORMAT Call by reference Type reference (TYPE) CHAR40 Schriftformatierung 19990902
12 Exporting FONT_SIZE Call by reference Type reference (TYPE) I Schriftgröße 19990902
13 Exporting LINE_COLOR Call by reference Type reference (TYPE) I Linienfarbe 19990727
14 Exporting LINE_STYLE Call by reference Type reference (TYPE) I Linienart 19990727
15 Exporting LINE_THICKNESS Call by reference Type reference (TYPE) F Linienstärke 19990727
16 Exporting TRANSPARENCY Call by reference Type reference (TYPE) I Transparenz 19990917
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19990728
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 19990728
3 INVALID_SETTING INVALID_SETTING 19991011

Method HANDLE_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 19990714
2 Importing FILE_NAME Call by reference Type reference (TYPE) CHAR255 Dateipfad für Markup-Layer 19990915
3 Importing LAYER_NAME Call by reference Type reference (TYPE) C Layer Name 19990714
4 Importing ROW_INDEX Call by reference Type reference (TYPE) N Index der Markupkategorie 19990716

Method HANDLE_EVENT on class CL_GUI_ECL_MARKUP has no exception.

Method REDO Signature

Method REDO on class CL_GUI_ECL_MARKUP has no parameter.
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19990901
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 19990901

Method REGISTER_TOOLBAR_EVENTS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CALIBRATION Call by reference Type reference (TYPE) C '' 'X' = Registrierung des Kalibrierungsevents 19991213
2 Importing DIRTY_LAYER_SAVED Call by reference Type reference (TYPE) C 'X' 'X' = Registrierung auf Sichern von Layern 19991130
3 Importing LAYER_ADDED Call by reference Type reference (TYPE) C 'X' 'X' = Registrierung auf das Laden neuer Layer 19991130
4 Importing MY_TOOLBAR Call by reference Object reference (TYPE REF TO) CL_GUI_TOOLBAR Toolbar Objekt 19990709
5 Importing TEXT_REQUEST Call by reference Type reference (TYPE) C 'X' 'X' = Registrierung auf Textanfragen 19991130
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19990709
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 19990709

Method SAVE_ACTIVE_LAYER 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) C Dateiname 19990720
2 Importing MODE Call by reference Type reference (TYPE) I 2 3D Modus = 3 19990907
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19990720
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 19990720
3 COULD_NOT_SAVE_FILE COULD_NOT_SAVE_FILE 19990720
4 NO_ACTIVE_LAYER_FOUND NO_ACTIVE_LAYER_FOUND 19990720
5 NO_TEMP_DIR_FOUND NO_TEMP_DIR_FOUND 19990720

Method SET_ANNOTATION_MODE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ANNOTATION_MODE Call by reference Type reference (TYPE) C 'X' Annotation Modus an = 'X' oder aus = '' 19990909
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19990909
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 19990909

Method SET_ANNOTATION_TEXT Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing ANNOTATION_TEXT Call by reference Type reference (TYPE) CHAR255 Annotation Text 19990901
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19990901
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 19990901

Method SET_CALIBRATION Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing CALIBRATION_DISTANCE Call by reference Type reference (TYPE) CALIB-DISTANCE Kalibrierungsabstand 19991028
2 Importing CALIBRATION_UNITS Call by reference Type reference (TYPE) I 0 Kalibrierungseinheiten 19991028
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19991028
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 19991028

Method SET_MARKUP_MODE Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Importing MARKUPMODE Call by reference Type reference (TYPE) I 1 Markup-Interaktionsmodus 19990709
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19990709
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 19990709

Method SET_SETTINGS Signature

# Type Parameter Pass Value Optional Typing Method Associated Type Default value Description Created on
1 Changing ARROW_TYPE Call by reference Type reference (TYPE) I Pfeilart 19990920
2 Changing EDGE_COLOR Call by reference Type reference (TYPE) I Eckenfarbe 19990730
3 Changing EDGE_STYLE Call by reference Type reference (TYPE) I Eckenart 19990728
4 Changing EDGE_THICKNESS Call by reference Type reference (TYPE) F Eckendicke 19990730
5 Changing FILL_COLOR Call by reference Type reference (TYPE) I Füllfarbe 19990728
6 Changing FILL_STYLE Call by reference Type reference (TYPE) I Füllart 20000608
7 Changing FONT Call by reference Type reference (TYPE) CHAR50 Font 19990730
8 Changing FONT_COLOR Call by reference Type reference (TYPE) I Textfarbe 19990730
9 Changing FONT_FORMAT Call by reference Type reference (TYPE) CHAR40 Schriftformatierung 19990902
10 Changing FONT_SIZE Call by reference Type reference (TYPE) I Schriftgröße 19990902
11 Changing LINE_COLOR Call by reference Type reference (TYPE) I Linienfarbe 19990728
12 Changing LINE_STYLE Call by reference Type reference (TYPE) I Linienart 19990728
13 Changing LINE_THICKNESS Call by reference Type reference (TYPE) F Linienstärke 19990728
14 Changing TRANSPARENCY Call by reference Type reference (TYPE) I Transparenz 19990917
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19990728
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 19990728
3 INVALID_SETTING INVALID_SETTING 19991011

Method UNDO Signature

Method UNDO on class CL_GUI_ECL_MARKUP has no parameter.
# Exception Resumable Description Created on
1 CNTL_ERROR CNTL_ERROR 19990901
2 CNTL_SYSTEM_ERROR CNTL_SYSTEM_ERROR 19990901
Event Signatures

Event CATEGORY_SELECTED Signature
# Parameter Type Pass Value Optional Typing Method Associated Type Default value Description Created on
1 CATEGORY_NAME Exporting Value transfer Type reference (TYPE) C DVS Markup Kategorie 19990719
2 LAYER_NAME Exporting Value transfer Type reference (TYPE) CHAR40 Markup Layer-Name 20000104

Event DELETE_MARKUP_REQUEST Signature
# Parameter Type Pass Value Optional Typing Method Associated Type Default value Description Created on
1 MARKUP_NAME Exporting Value transfer Type reference (TYPE) C Benennung des zu löschenden Markups 19990831

Event REDLINING_FINISHED Signature
Event REDLINING_FINISHED on class CL_GUI_ECL_MARKUP has no parameter.
Event SAVE_MARKUP_LAYER Signature
# Parameter Type Pass Value Optional Typing Method Associated Type Default value Description Created on
1 GENERATED_FILE Exporting Value transfer Type reference (TYPE) C Generierter temporärer Dateiname 19990831
2 MARKUP_NAME Exporting Value transfer Type reference (TYPE) C Markup-Name 19990831
History
Last changed by/on SAP  20110908 
SAP Release Created in