SAP CL_GUI_FORMPAINTER OO Class - SAP Form Painter Control Proxy Class
CL_GUI_FORMPAINTER 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_FORMPAINTER 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_FORMPAINTER is CL_GUI_CONTROLMethod list of CL_GUI_FORMPAINTER 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_KEY_STROKE | Add key stroke for event key_pressed | Public |
CALL METHOD cl_gui_formpainter=>ADD_KEY_STROKE...more details | ||
ADD_TOOLBAR_BUTTONS | Add buttons to toolbar | Protected |
CALL METHOD cl_gui_formpainter=>ADD_TOOLBAR_BUTTONS...more details | ||
CONSTRUCTOR | Constructor | Public |
CALL METHOD cl_gui_formpainter=>CONSTRUCTOR...more details | ||
CONVERT_INTERNAL_UNIT_TO_UNIT | Convert internal unit to unit | Protected |
CALL METHOD cl_gui_formpainter=>CONVERT_INTERNAL_UNIT_TO_UNIT...more details | ||
CONVERT_UNIT_TO_INTERNAL_UNIT | Convert unit to internal unit | Protected |
CALL METHOD cl_gui_formpainter=>CONVERT_UNIT_TO_INTERNAL_UNIT...more details | ||
CREATE_BITMAP_WINDOW | Create bitmap window | Public |
CALL METHOD cl_gui_formpainter=>CREATE_BITMAP_WINDOW...more details | ||
| ||
CREATE_TEXT_WINDOW | Create text window | Public |
CALL METHOD cl_gui_formpainter=>CREATE_TEXT_WINDOW...more details | ||
DELETE_WINDOW | Delete window | Public |
CALL METHOD cl_gui_formpainter=>DELETE_WINDOW...more details | ||
DESELECT_ALL | Deselect window | Public |
CALL METHOD cl_gui_formpainter=>DESELECT_ALL...more details | ||
GET_AUTO_ZOOM | Get auto zoom | Public |
CALL METHOD cl_gui_formpainter=>GET_AUTO_ZOOM...more details | ||
GET_BORDER | Get border | Public |
CALL METHOD cl_gui_formpainter=>GET_BORDER...more details | ||
GET_CROSS_HAIRS | Get crosshairs | Public |
CALL METHOD cl_gui_formpainter=>GET_CROSS_HAIRS...more details | ||
GET_DRAW_MODE | Get draw mode | Public |
CALL METHOD cl_gui_formpainter=>GET_DRAW_MODE...more details | ||
GET_GRID | Get grid | Public |
CALL METHOD cl_gui_formpainter=>GET_GRID...more details | ||
GET_MAJOR_GRID | Get major grid | Public |
CALL METHOD cl_gui_formpainter=>GET_MAJOR_GRID...more details | ||
GET_OPTIONS | Get options | Public |
CALL METHOD cl_gui_formpainter=>GET_OPTIONS...more details | ||
GET_RULER | Get ruler | Public |
CALL METHOD cl_gui_formpainter=>GET_RULER...more details | ||
GET_SNAP_TO_GRID | Get SnapToGrid | Public |
CALL METHOD cl_gui_formpainter=>GET_SNAP_TO_GRID...more details | ||
GET_TRACKER | Get tracker | Public |
CALL METHOD cl_gui_formpainter=>GET_TRACKER...more details | ||
GET_TRANSPARENT | Get transparent | Public |
CALL METHOD cl_gui_formpainter=>GET_TRANSPARENT...more details | ||
GET_WINDOW | Get a window from its name | Public |
CALL METHOD cl_gui_formpainter=>GET_WINDOW...more details | ||
GET_ZOOM | Get zoom | Public |
CALL METHOD cl_gui_formpainter=>GET_ZOOM...more details | ||
INIT | Initialization | Public |
CALL METHOD cl_gui_formpainter=>INIT...more details | ||
PROCESS_CONTEXT_MENU | Display and process a context menu | Public |
CALL METHOD cl_gui_formpainter=>PROCESS_CONTEXT_MENU...more details | ||
RAISE_PROPS_CHANGED | Props changed | Protected |
CALL METHOD cl_gui_formpainter=>RAISE_PROPS_CHANGED...more details | ||
REG_CONTEXT_MENU_REQUESTED | Register event context menu requested | Public |
CALL METHOD cl_gui_formpainter=>REG_CONTEXT_MENU_REQUESTED...more details | ||
REG_CONTEXT_MENU_SELECTED | Register event context menu selected | Public |
CALL METHOD cl_gui_formpainter=>REG_CONTEXT_MENU_SELECTED...more details | ||
REG_CONTEXT_MENU_TOOLBAR | Register event context menu toolbar | Protected |
CALL METHOD cl_gui_formpainter=>REG_CONTEXT_MENU_TOOLBAR...more details | ||
REG_OPTIONS_DIALOG_REQUESTED | Register event options dialog requested | Protected |
CALL METHOD cl_gui_formpainter=>REG_OPTIONS_DIALOG_REQUESTED...more details | ||
REG_WINDOWS_PROPS_CHANGED | Register event windows properties changed | Public |
CALL METHOD cl_gui_formpainter=>REG_WINDOWS_PROPS_CHANGED...more details | ||
REG_WINDOW_CREATE | Register event window create | Public |
CALL METHOD cl_gui_formpainter=>REG_WINDOW_CREATE...more details | ||
REG_WINDOW_DBLCLICK | Register event doubleclick on window | Public |
CALL METHOD cl_gui_formpainter=>REG_WINDOW_DBLCLICK...more details | ||
REG_WINDOW_KEY_PRESSED | Register event window key pressed | Public |
CALL METHOD cl_gui_formpainter=>REG_WINDOW_KEY_PRESSED...more details | ||
REG_WINDOW_PROPS_CHANGED | Register event window properties changed | Public |
CALL METHOD cl_gui_formpainter=>REG_WINDOW_PROPS_CHANGED...more details | ||
REG_WINDOW_SELECTED | Register event window selected | Public |
CALL METHOD cl_gui_formpainter=>REG_WINDOW_SELECTED...more details | ||
REMOVE_ALL_KEY_STROKES | Remove all key strokes for event key_pressed | Public |
CALL METHOD cl_gui_formpainter=>REMOVE_ALL_KEY_STROKES...more details | ||
SELECTED_WINDOW | Get selected window | Public |
CALL METHOD cl_gui_formpainter=>SELECTED_WINDOW...more details | ||
SET_AUTO_ZOOM | Set auto zoom | Public |
CALL METHOD cl_gui_formpainter=>SET_AUTO_ZOOM...more details | ||
SET_BORDER | Set border | Public |
CALL METHOD cl_gui_formpainter=>SET_BORDER...more details | ||
SET_CPI | Set CPI | Public |
CALL METHOD cl_gui_formpainter=>SET_CPI...more details | ||
SET_CROSS_HAIRS | Set crosshairs | Public |
CALL METHOD cl_gui_formpainter=>SET_CROSS_HAIRS...more details | ||
SET_DRAW_MODE | Set draw mode | Public |
CALL METHOD cl_gui_formpainter=>SET_DRAW_MODE...more details | ||
SET_FORMPAINTER_MODE | Toggle control between design mode and run mode | Public |
CALL METHOD cl_gui_formpainter=>SET_FORMPAINTER_MODE...more details | ||
SET_GRID | Set grid | Public |
CALL METHOD cl_gui_formpainter=>SET_GRID...more details | ||
SET_LPI | Set LPI | Public |
CALL METHOD cl_gui_formpainter=>SET_LPI...more details | ||
SET_MAJOR_GRID | Set major grid | Public |
CALL METHOD cl_gui_formpainter=>SET_MAJOR_GRID...more details | ||
SET_OPTIONS | Set options | Public |
CALL METHOD cl_gui_formpainter=>SET_OPTIONS...more details | ||
SET_PAGE_FORMAT | Set page format | Public |
CALL METHOD cl_gui_formpainter=>SET_PAGE_FORMAT...more details | ||
SET_RULER | Set Ruler | Public |
CALL METHOD cl_gui_formpainter=>SET_RULER...more details | ||
SET_SNAP_TO_GRID | Set SnapToGrid | Public |
CALL METHOD cl_gui_formpainter=>SET_SNAP_TO_GRID...more details | ||
SET_TOOLBAR | Set Toolbar | Public |
CALL METHOD cl_gui_formpainter=>SET_TOOLBAR...more details | ||
SET_TRACKER | Set tracker | Public |
CALL METHOD cl_gui_formpainter=>SET_TRACKER...more details | ||
SET_TRANSPARENT | Set Transparent | Public |
CALL METHOD cl_gui_formpainter=>SET_TRANSPARENT...more details | ||
SET_WALLPAPER | Set wallpaper | Public |
CALL METHOD cl_gui_formpainter=>SET_WALLPAPER...more details | ||
SET_ZOOM | Set zoom | Public |
CALL METHOD cl_gui_formpainter=>SET_ZOOM...more details | ||
SHOW_OPTIONS_DIALOG | Show options dialog | Public |
CALL METHOD cl_gui_formpainter=>SHOW_OPTIONS_DIALOG...more details | ||
UNREG_CONTEXT_MENU_REQUESTED | Deregister event context menu requested | Public |
CALL METHOD cl_gui_formpainter=>UNREG_CONTEXT_MENU_REQUESTED...more details | ||
UNREG_CONTEXT_MENU_SELECTED | Deregister event context menu selected | Public |
CALL METHOD cl_gui_formpainter=>UNREG_CONTEXT_MENU_SELECTED...more details | ||
UNREG_WINDOWS_PROPS_CHANGED | Unregister event windows properties changed | Public |
CALL METHOD cl_gui_formpainter=>UNREG_WINDOWS_PROPS_CHANGED...more details | ||
UNREG_WINDOW_CREATE | Deregister event window create | Public |
CALL METHOD cl_gui_formpainter=>UNREG_WINDOW_CREATE...more details | ||
UNREG_WINDOW_DBLCLICK | Unregister event doubleclick on window | Public |
CALL METHOD cl_gui_formpainter=>UNREG_WINDOW_DBLCLICK...more details | ||
UNREG_WINDOW_KEY_PRESSED | Unregister event window key pressed | Public |
CALL METHOD cl_gui_formpainter=>UNREG_WINDOW_KEY_PRESSED...more details | ||
UNREG_WINDOW_PROPS_CHANGED | Deregister event window properties changed | Public |
CALL METHOD cl_gui_formpainter=>UNREG_WINDOW_PROPS_CHANGED...more details | ||
UNREG_WINDOW_SELECTED | Deregister event window selected | Public |
CALL METHOD cl_gui_formpainter=>UNREG_WINDOW_SELECTED...more details |
CL_GUI_FORMPAINTER 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 |
CO_GRID_STYLE_CROSS | Constant | Crosses | 4 | LIKE I | Public |
CO_GRID_STYLE_DASHED | Constant | Dashed grid | 1 | LIKE I | Public |
CO_GRID_STYLE_DOT | Constant | Dots | 3 | LIKE I | Public |
CO_GRID_STYLE_DOTTED | Constant | Dotted grid | 2 | LIKE I | Public |
CO_GRID_STYLE_SOLID | Constant | Solid grid | 0 | LIKE I | Public |
CO_INTERNAL_UNIT_CH | Constant | Characters per Inch | 0 | LIKE I | Protected |
CO_INTERNAL_UNIT_CM | Constant | Centimeters | 1 | LIKE I | Protected |
CO_INTERNAL_UNIT_IN | Constant | Inches | 2 | LIKE I | Protected |
CO_INTERNAL_UNIT_LN | Constant | Lines per Inch | 3 | LIKE I | Protected |
CO_INTERNAL_UNIT_MM | Constant | Millimeters | 4 | LIKE I | Protected |
CO_INTERNAL_UNIT_PT | Constant | Points | 5 | LIKE I | Protected |
CO_INTERNAL_UNIT_TW | Constant | Twips | 6 | LIKE I | Protected |
CO_KEY_COPY | Constant | CTRL-C Key | 7 | LIKE I | Public |
CO_KEY_CUT | Constant | CTRL-X Key | 6 | LIKE I | Public |
CO_KEY_DELETE | Constant | Delete Key | 2 | LIKE I | Public |
CO_KEY_ENTER | Constant | Enter Key | 5 | LIKE I | Public |
CO_KEY_F1 | Constant | F1 Key | 1 | LIKE I | Public |
CO_KEY_F4 | Constant | F4 Key | 4 | LIKE I | Public |
CO_KEY_INSERT | Constant | Insert Key | 3 | LIKE I | Public |
CO_KEY_PASTE | Constant | CTRL-V Key | 8 | LIKE I | Public |
CO_MODE_DESIGN | Constant | Design mode | 1 | LIKE I | Public |
CO_MODE_RUN | Constant | Run mode | 0 | LIKE I | Public |
CO_TRACKER_STYLE_DOTTED_LINE | Constant | Dotted line for the border | 2 | LIKE I | Public |
CO_TRACKER_STYLE_HATCH_BORDER | Constant | Hatched pattern for the rectangle border | 4 | LIKE I | Public |
CO_TRACKER_STYLE_HATCH_INSIDE | Constant | Hatched pattern covers the rectangle | 32 | LIKE I | Public |
CO_TRACKER_STYLE_RESIZEINSIDE | Constant | Resize handles located inside | 8 | LIKE I | Public |
CO_TRACKER_STYLE_RESIZEOUTSIDE | Constant | Resize handles located outside | 16 | LIKE I | Public |
CO_TRACKER_STYLE_SOLID_LINE | Constant | Solid line for the border | 1 | LIKE I | Public |
CO_UNIT_CH | Constant | Characters per Inch | 'CH' | LIKE TDUNIT | Public |
CO_UNIT_CM | Constant | Centimeters | 'CM' | LIKE TDUNIT | Public |
CO_UNIT_IN | Constant | Inches | 'IN' | LIKE TDUNIT | Public |
CO_UNIT_LN | Constant | Lines per Inch | 'LN' | LIKE TDUNIT | Public |
CO_UNIT_MM | Constant | Millimeters | 'MM' | LIKE TDUNIT | Public |
CO_UNIT_PT | Constant | Points | 'PT' | LIKE TDUNIT | Public |
CO_UNIT_TW | Constant | Twips | 'TW' | LIKE TDUNIT | Public |
EVENTID_CONTEXT_MENU_REQUESTED | Constant | Event context menu requested | 1 | LIKE I | Public |
EVENTID_CONTEXT_MENU_SELECTED | Constant | Event context menu selected | 2 | LIKE I | Public |
EVENTID_CONTEXT_MENU_TOOLBAR | Constant | Event context menu toolbar | 6 | LIKE I | Protected |
EVENTID_OPTIONS_DIALOG_REQ | Constant | Event options dialog requested | 7 | LIKE I | Protected |
EVENTID_WINDOWS_PROPS_CHANGED | Constant | Event windows properties changed | 10 | LIKE I | Public |
EVENTID_WINDOW_CREATE | Constant | Event window create | 3 | LIKE I | Public |
EVENTID_WINDOW_DBLCLICK | Constant | Event doubleclick on window | 8 | LIKE I | Public |
EVENTID_WINDOW_KEY_PRESSED | Constant | Event window key pressed | 9 | LIKE I | Public |
EVENTID_WINDOW_PROPS_CHANGED | Constant | Event window properties changed | 5 | LIKE I | Public |
EVENTID_WINDOW_SELECTED | Constant | Event window selected | 4 | LIKE I | Public |
M_CPI | Instance Attribute | Characters per Inch | LIKE SSFFORMHD-CPI | Public | |
M_LPI | Instance Attribute | Lines per inch | LIKE SSFFORMHD-LPI | Public | |
M_MODE | Instance Attribute | Mode | LIKE I | Public | |
M_PAGE_HEIGHT | Instance Attribute | Page height | LIKE SSFDOCSTRC-WWIDTH | Public | |
M_PAGE_HEIGHT_UNIT | Instance Attribute | Page height unit | LIKE SSFDOCSTRC-U_WWIDTH | Public | |
M_PAGE_WIDTH | Instance Attribute | Page width | LIKE SSFDOCSTRC-WHEIGHT | Public | |
M_PAGE_WIDTH_UNIT | Instance Attribute | Page width unit | LIKE SSFDOCSTRC-U_WHEIGHT | Public | |
M_TOOLBAR | Instance Attribute | Toolbar | LIKE I | Public | |
M_VERSION | Instance Attribute | Form Painter Control version | LIKE I | Private | |
M_WALLPAPER_HEIGHT | Instance Attribute | Wallpaper height | LIKE SSFDOCSTRC-WHEIGHT | Public | |
M_WALLPAPER_HEIGHT_UNIT | Instance Attribute | Wallpaper height unit | LIKE SSFDOCSTRC-U_WHEIGHT | Public | |
M_WALLPAPER_LEFT | Instance Attribute | Wallpaper left position | LIKE SSFDOCSTRC-WLEFT | Public | |
M_WALLPAPER_LEFT_UNIT | Instance Attribute | Wallpaper left position unit | LIKE SSFDOCSTRC-U_WLEFT | Public | |
M_WALLPAPER_TOP | Instance Attribute | Wallpaper top position | LIKE SSFDOCSTRC-WTOP | Public | |
M_WALLPAPER_TOP_UNIT | Instance Attribute | Wallpaper top position unit | LIKE SSFDOCSTRC-U_WTOP | Public | |
M_WALLPAPER_URL | Instance Attribute | Wallpaper URL | LIKE SSFURL | Public | |
M_WALLPAPER_WIDTH | Instance Attribute | Wallpaper width | LIKE SSFDOCSTRC-WWIDTH | Public | |
M_WALLPAPER_WIDTH_UNIT | Instance Attribute | Wallpaper width unit | LIKE SSFDOCSTRC-U_WWIDTH | Public | |
M_WANTDBLCLICKEVENT | Instance Attribute | Want doubleclick event? | LIKE I | Public | |
M_WINDOWS | Instance Attribute | Screens | LIKE WINDOWS | Protected | |
WINDOW_DELETING | Instance Attribute | Window deleting in progress? | LIKE I | Private |
Events of Class CL_GUI_FORMPAINTER
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... CONTEXT_MENU_REQUESTED - Context menu requestedCONTEXT_MENU_SELECTED - Context menu selected
FORMPAINTER_CLICK - Click on the Form Painter (outside of any window)
FORMPAINTER_DBLCLICK - Doubleclick on the form painter (outside of any window)
FORMPAINTER_KEY_PRESSED - Key pressed on the form painter (outside of any window)
WINDOW_CREATE - Window create
CL_GUI_FORMPAINTER types
WINDOWS - WINDOWSLinks to Related Class(s)
CL_GUI_F...Full list of available SAP object classes
Search for further information about these or an SAP related objects