SAP CL_GUI_ECL_MARKUP OO Class - Markup (Redlining) Component
CL_GUI_ECL_MARKUP 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_MARKUP 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_MARKUP is CL_GUI_CONTROLMethod list of CL_GUI_ECL_MARKUP 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_3DMETA_INFO | Meta Information as Notes | Public |
| CALL METHOD cl_gui_ecl_markup=>ADD_3DMETA_INFO...more details | ||
| CONSTRUCTOR | Constructor | Public |
| CALL METHOD cl_gui_ecl_markup=>CONSTRUCTOR...more details | ||
| CREATE_STAMP | Generates a Stamp | Public |
| CALL METHOD cl_gui_ecl_markup=>CREATE_STAMP...more details | ||
| CREATE_TOOLBAR | Generates a Toolbar for Controlling the Markup Component | Public |
| CALL METHOD cl_gui_ecl_markup=>CREATE_TOOLBAR...more details | ||
| DELETE_SELECTED_MARKUPS | Deletes Single Markup Object | Public |
| CALL METHOD cl_gui_ecl_markup=>DELETE_SELECTED_MARKUPS...more details | ||
| DVS_SET_MARKUP_CATEGORIES | Especially for DVS Link: Defines Markup Categories | Public |
| CALL METHOD cl_gui_ecl_markup=>DVS_SET_MARKUP_CATEGORIES...more details | ||
|
| ||
| GET_MARKUP_MODE | Returns the Active Interaction Mode | Public |
| CALL METHOD cl_gui_ecl_markup=>GET_MARKUP_MODE...more details | ||
| GET_SETTINGS | Returns the Settings | Public |
| CALL METHOD cl_gui_ecl_markup=>GET_SETTINGS...more details | ||
| HANDLE_EVENT | Class-Specific! Event Handler | Public |
| CALL METHOD cl_gui_ecl_markup=>HANDLE_EVENT...more details | ||
| REDO | Restore the Last Step Reversed | Public |
| CALL METHOD cl_gui_ecl_markup=>REDO...more details | ||
| REGISTER_TOOLBAR_EVENTS | Class-Specific! Registers the Toolbar Events | Public |
| CALL METHOD cl_gui_ecl_markup=>REGISTER_TOOLBAR_EVENTS...more details | ||
| SAVE_ACTIVE_LAYER | Saves Markup Layers in a Temporary File | Public |
| CALL METHOD cl_gui_ecl_markup=>SAVE_ACTIVE_LAYER...more details | ||
| SET_ANNOTATION_MODE | Enable/Disable Annotation Mode | Public |
| CALL METHOD cl_gui_ecl_markup=>SET_ANNOTATION_MODE...more details | ||
| SET_ANNOTATION_TEXT | Sets the Markup Text | Public |
| CALL METHOD cl_gui_ecl_markup=>SET_ANNOTATION_TEXT...more details | ||
| SET_CALIBRATION | Calibrate | Public |
| CALL METHOD cl_gui_ecl_markup=>SET_CALIBRATION...more details | ||
| SET_MARKUP_MODE | Sets the Markup Mode for the Relevant User Interaction | Public |
| CALL METHOD cl_gui_ecl_markup=>SET_MARKUP_MODE...more details | ||
| SET_SETTINGS | Defines the Settings | Public |
| CALL METHOD cl_gui_ecl_markup=>SET_SETTINGS...more details | ||
| UNDO | Reverse the Last Step | Public |
| CALL METHOD cl_gui_ecl_markup=>UNDO...more details | ||
CL_GUI_ECL_MARKUP 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_DELETING_FORBIDDEN | Instance Attribute | 'X' = Toolbar in 'Delete Not Permitted' State | LIKE CHAR01 | Public | |
| ACTUAL_MARKUP_FORBIDDEN | Instance Attribute | 'X' = Toolbar in 'Redlining Not Permitted' State | LIKE CHAR01 | Public | |
| ACTUAL_MARKUP_SETTINGS | Instance Attribute | Current Redlining Settings | LIKE ACTUAL_SETTINGS | Private | |
| ASSIGNED_VIEWER | Instance Attribute | Associated Viewer | LIKE CL_GUI_ECL_PRIMARYVIEWER | Public | |
| ASSIGNED_VIEWER_2D | Instance Attribute | Associated 2D Viewer | LIKE CL_GUI_ECL_2DVIEWER | Public | |
| ASSIGNED_VIEWER_3D | Instance Attribute | Associated 3D Viewer | LIKE CL_GUI_ECL_3DVIEWER | Public | |
| CALIBRATION_REGISTERED | Instance Attribute | 'X' = Calibration Event was Registered | LIKE CHAR01 | Public | |
| DASH | Constant | Dash | 1 | LIKE I | Public |
| DASHDOT | Constant | Dash-Dot | 3 | LIKE I | Public |
| DASHDOTDOT | Constant | Dash-Dot-Dot | 4 | LIKE I | Public |
| DVS_MARKUP_CATEGORIES | Instance Attribute | DVS Markup Categories | LIKE | Private | |
| LEADER_HEAD_STYLE | Constant | Guideline Type | 1 | LIKE I | Public |
| LEADER_HEAD_TAIL_STYLE | Constant | Guideline Type | 3 | LIKE I | Public |
| LEADER_TAIL_STYLE | Constant | Guideline Type | 2 | LIKE I | Public |
| MEASURE_TOOL_ACTIVATED | Instance Attribute | Measurement = 'X'; Redlining = '' | LIKE CHAR01 | Public | |
| MODE | Instance Attribute | 2D or 3D | 2 | LIKE I | Public |
| SOLID | Constant | Solid | 0 | LIKE I | Public |
| THIS_TOOLBAR | Instance Attribute | Associated Toolbar | LIKE CL_GUI_TOOLBAR | Public | |
| TOOLBARTYPE | Instance Attribute | LIKE | Private |
Events of Class CL_GUI_ECL_MARKUP
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... CATEGORY_SELECTED - DVS Markup Category was SelectedDELETE_MARKUP_REQUEST - Event is Triggered by the Delete Button in the Toolbar
REDLINING_FINISHED - Redlining Mode was Exited Through 'Back' Button
SAVE_MARKUP_LAYER - Markup was Saved
CL_GUI_ECL_MARKUP types
ACTUAL_SETTINGS - ACTUAL_SETTINGSDVS_MARKUP_CATEGORY -
Links 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