SAP CL_GUI_SAPSCRIPT_EDITOR OO Class - SAP SAPscript Editor Control
CL_GUI_SAPSCRIPT_EDITOR 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_SAPSCRIPT_EDITOR 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_SAPSCRIPT_EDITOR is CL_GUI_RTF_EDITORMethod list of CL_GUI_SAPSCRIPT_EDITOR 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_BUTTON | Add new button to toolbar | Public |
| CALL METHOD cl_gui_sapscript_editor=>ADD_BUTTON...more details | ||
| ADD_FORMATBAR_ENTRY | Adds format to formatbar | Private |
| CALL METHOD cl_gui_sapscript_editor=>ADD_FORMATBAR_ENTRY...more details | ||
| CHANGE_FORMAT | Change formats of text | Private |
| CALL METHOD cl_gui_sapscript_editor=>CHANGE_FORMAT...more details | ||
| CHECK_SYMBOL_NAME | Check the syntax of a symbol field name | Private |
| CALL METHOD cl_gui_sapscript_editor=>CHECK_SYMBOL_NAME...more details | ||
| CHECK_USER_ATTR | Check user attributes | Private |
| CALL METHOD cl_gui_sapscript_editor=>CHECK_USER_ATTR...more details | ||
| COMMAND_COPY | Copy selected text into clipboard | Private |
| CALL METHOD cl_gui_sapscript_editor=>COMMAND_COPY...more details | ||
|
| ||
| COMMAND_CUT | Cut selected text into clipboard | Private |
| CALL METHOD cl_gui_sapscript_editor=>COMMAND_CUT...more details | ||
| COMMAND_INSERT_URL | Insert URL at current position | Private |
| CALL METHOD cl_gui_sapscript_editor=>COMMAND_INSERT_URL...more details | ||
| COMMAND_PASTE | Paste text from clipboard into editor control | Private |
| CALL METHOD cl_gui_sapscript_editor=>COMMAND_PASTE...more details | ||
| COMMAND_RESET_FORMATS | Reset character formats at current position | Private |
| CALL METHOD cl_gui_sapscript_editor=>COMMAND_RESET_FORMATS...more details | ||
| COMMAND_SEARCH | Search text key in editor control | Private |
| CALL METHOD cl_gui_sapscript_editor=>COMMAND_SEARCH...more details | ||
| COMMAND_SEARCH_NEXT | Search next text key in editor control | Private |
| CALL METHOD cl_gui_sapscript_editor=>COMMAND_SEARCH_NEXT...more details | ||
| COMMAND_SHOW_BREAKS | Show line and paragraph breaks | Private |
| CALL METHOD cl_gui_sapscript_editor=>COMMAND_SHOW_BREAKS...more details | ||
| COMMAND_SHOW_FORMATS | Show character and paragraph formats at current position | Private |
| CALL METHOD cl_gui_sapscript_editor=>COMMAND_SHOW_FORMATS...more details | ||
| COMMAND_SYMBOL_CHANGE | Change field symbol at current position | Private |
| CALL METHOD cl_gui_sapscript_editor=>COMMAND_SYMBOL_CHANGE...more details | ||
| COMMAND_SYMBOL_DELETE | Delete selected field symbol in text | Private |
| CALL METHOD cl_gui_sapscript_editor=>COMMAND_SYMBOL_DELETE...more details | ||
| COMMAND_SYMBOL_INSERT | Insert field symbol at current position | Private |
| CALL METHOD cl_gui_sapscript_editor=>COMMAND_SYMBOL_INSERT...more details | ||
| COMPL_STYLETAB_CHAR | Complete internal style attribute table | Private |
| CALL METHOD cl_gui_sapscript_editor=>COMPL_STYLETAB_CHAR...more details | ||
| COMPL_STYLETAB_PAR | Complete internal paragraph attribute table | Private |
| CALL METHOD cl_gui_sapscript_editor=>COMPL_STYLETAB_PAR...more details | ||
| COMPL_STYLETAB_RESET_CHAR | Complete internal style attribute table for reset formats | Private |
| CALL METHOD cl_gui_sapscript_editor=>COMPL_STYLETAB_RESET_CHAR...more details | ||
| COMPL_STYLETAB_XPAS | Complete internal style attribute table for text paste | Private |
| CALL METHOD cl_gui_sapscript_editor=>COMPL_STYLETAB_XPAS...more details | ||
| COMPUTE_TEMPFORMAT | Create a new temporary format for text | Private |
| CALL METHOD cl_gui_sapscript_editor=>COMPUTE_TEMPFORMAT...more details | ||
| CONSTRUCTOR | Creates and links SAPscript editor control | Public |
| CALL METHOD cl_gui_sapscript_editor=>CONSTRUCTOR...more details | ||
| CREATE_STYLETAB | Create internal style attribute table | Private |
| CALL METHOD cl_gui_sapscript_editor=>CREATE_STYLETAB...more details | ||
| CREATE_TOOLBAR | Create all buttons of the editor toolbar | Private |
| CALL METHOD cl_gui_sapscript_editor=>CREATE_TOOLBAR...more details | ||
| DELETE_BUTTON | Delete a specified button from toolbar | Public |
| CALL METHOD cl_gui_sapscript_editor=>DELETE_BUTTON...more details | ||
| EVENT_PARAGRAPH_DELETED | Processing paragraph deleted event on combobox items | Private |
| CALL METHOD cl_gui_sapscript_editor=>EVENT_PARAGRAPH_DELETED...more details | ||
| EVENT_PASTE_REQUESTED | Processing paste text event in text editor (control-v) | Private |
| CALL METHOD cl_gui_sapscript_editor=>EVENT_PASTE_REQUESTED...more details | ||
| EVENT_SINGLE_CLICK | Processing single click event on combobox items | Private |
| CALL METHOD cl_gui_sapscript_editor=>EVENT_SINGLE_CLICK...more details | ||
| GET_SYMBOL_VALUE | Get attributes of the selected field symbol in text | Public |
| CALL METHOD cl_gui_sapscript_editor=>GET_SYMBOL_VALUE...more details | ||
| GET_TEXT_FROM_EDITOR | Get RTF text from the control and convert it into ITF text | Public |
| CALL METHOD cl_gui_sapscript_editor=>GET_TEXT_FROM_EDITOR...more details | ||
| INITIALIZE | Initialization of SAPscript editor control | Private |
| CALL METHOD cl_gui_sapscript_editor=>INITIALIZE...more details | ||
| ON_TOOLBAR_FUNCTION_SELECTED | Processing button events on toolbar object | Private |
| CALL METHOD cl_gui_sapscript_editor=>ON_TOOLBAR_FUNCTION_SELECTED...more details | ||
| READ_FIELD | Read the text field at current cursor position | Private |
| CALL METHOD cl_gui_sapscript_editor=>READ_FIELD...more details | ||
| RENAME_FIELDS | Rename field names for text paste | Private |
| CALL METHOD cl_gui_sapscript_editor=>RENAME_FIELDS...more details | ||
| SET_BUTTON_STATE | Set display mode of toolbar buttons (enabled or disabled) | Public |
| CALL METHOD cl_gui_sapscript_editor=>SET_BUTTON_STATE...more details | ||
| SET_CHARACTER_FORMAT | Set character format | Private |
| CALL METHOD cl_gui_sapscript_editor=>SET_CHARACTER_FORMAT...more details | ||
| SET_CHARFORMAT_NO_SEL | Set character format (no text selection) | Private |
| CALL METHOD cl_gui_sapscript_editor=>SET_CHARFORMAT_NO_SEL...more details | ||
| SET_CHARFORMAT_SEL | Set character format (text selection) | Private |
| CALL METHOD cl_gui_sapscript_editor=>SET_CHARFORMAT_SEL...more details | ||
| SET_FIXED_FIELD_LENGTH | Set fields to fixed length (window size) | Private |
| CALL METHOD cl_gui_sapscript_editor=>SET_FIXED_FIELD_LENGTH...more details | ||
| SET_FORMATBAR_TABLE | Sets the correct formatbar table | Private |
| CALL METHOD cl_gui_sapscript_editor=>SET_FORMATBAR_TABLE...more details | ||
| SET_PARAGRAPH_FORMAT | Set paragraph format | Private |
| CALL METHOD cl_gui_sapscript_editor=>SET_PARAGRAPH_FORMAT...more details | ||
| SET_PARFORMAT_EMPTY_TEXT | Set paragraph format for empty text | Private |
| CALL METHOD cl_gui_sapscript_editor=>SET_PARFORMAT_EMPTY_TEXT...more details | ||
| SET_TEXT_BY_HEADER | Put text into editor control using text header | Public |
| CALL METHOD cl_gui_sapscript_editor=>SET_TEXT_BY_HEADER...more details | ||
| SET_TEXT_BY_STYLE | Put text into editor control using Smart Style | Public |
| CALL METHOD cl_gui_sapscript_editor=>SET_TEXT_BY_STYLE...more details | ||
| SYMBOL_INSERT | Insert field symbol at current position | Public |
| CALL METHOD cl_gui_sapscript_editor=>SYMBOL_INSERT...more details | ||
CL_GUI_SAPSCRIPT_EDITOR 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 |
| CHARFORMTAB | Instance Attribute | Character format | LIKE SEDCFORM | Private | |
| C_FORMAT_BOLD | Constant | Fixed format: bold | '%B' | LIKE CHAR2 | Private |
| C_FORMAT_ITALIC | Constant | Fixed format: italic | '%I' | LIKE CHAR2 | Private |
| C_FORMAT_UNDERLINE | Constant | Fixed format: italic | '%U' | LIKE CHAR2 | Private |
| C_FORMAT_URL | Constant | Fixed format: URL | '%W' | LIKE CHAR2 | Private |
| C_VARIABLE_LENGTH | Constant | C_VARIABLE_LENGTH | -1 | LIKE I | Private |
| FIELDTAB | Instance Attribute | Field attributes | LIKE SEDFIELD | Private | |
| M_CAPTION_LIST | Instance Attribute | List of logical field names (captions) in editor control | LIKE TEDCAPLIST | Private | |
| M_COMBOBOX1_ID | Instance Attribute | ID of first combobox | LIKE I | Private | |
| M_COMBOBOX2_ID | Instance Attribute | ID of second combobox | LIKE I | Private | |
| M_CONVERTER | Instance Attribute | Object for text conversion | LIKE LCL_CONVERT | Private | |
| M_FIX_FIELD_LENGTH | Instance Attribute | Fixed length of fields | LIKE I | Private | |
| M_FORMATS | Instance Attribute | Combined formats in editor | LIKE TRTFFRMT | Private | |
| M_FRAME_ID | Instance Attribute | ID of frame object | LIKE I | Private | |
| M_ORG_CURSOR | Instance Attribute | Restore original cursor | C_TRUE | LIKE I | Private |
| M_STATUSBAR1_ID | Instance Attribute | ID of first status bar | LIKE I | Private | |
| M_STATUSBAR2_ID | Instance Attribute | ID of second status bar | LIKE I | Private | |
| M_STATUSBAR3_ID | Instance Attribute | ID of dummy status bar | LIKE I | Private | |
| M_STYLE_NAME | Instance Attribute | Current style name | LIKE TDSSNAME | Private | |
| M_STYLE_VARIANT | Instance Attribute | Current style variant | LIKE TDVARIANT | Private | |
| M_TOOLBAR | Instance Attribute | Toolbar object | LIKE CL_GUI_TOOLBAR | Private | |
| M_USE_CAPTION | Instance Attribute | Display logical field names (captions) in editor control | FALSE | LIKE BOOLEAN | Private |
| PARFORMTAB | Instance Attribute | Paragraph format | LIKE SEDPFORM | Private | |
| STYLETAB | Instance Attribute | Style attributes | LIKE S_STYLETAB | Private | |
| TAB_FIELDTAB | Instance Attribute | Table of field attributes | LIKE TEDFIELD | Private | |
| TAB_STYLETAB | Instance Attribute | Table of style attributes | LIKE T_STYLETAB | Private | |
| TEMPFORMTAB | Instance Attribute | Tempory format | LIKE SEDTFORM | Private |
Events of Class CL_GUI_SAPSCRIPT_EDITOR
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... FUNCTION_SELECTED - Button or menu entry selectedCL_GUI_SAPSCRIPT_EDITOR types
S_STYLETAB - S_STYLETABT_STYLETAB - T_STYLETAB
Links to Related Class(s)
CL_GUI_S...Full list of available SAP object classes
Search for further information about these or an SAP related objects