Hierarchy
⤷ BC-SRV-SSF (Application Component) Smart Forms
⤷ SMART (Package) SAP Smart Forms
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 | 20000619 |
Properties
Class | CL_GUI_BORDERPAINTER | |
Short Description | SAP Border Painter Control Proxy Class | |
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 | SMART | SAP Smart Forms |
Created | 20000619 | SAP |
Last change | 20000619 | SAP |
Shared Memory-enabled | ||
Fixed point arithmetic | ||
Unicode checks active |
Forward declarations
# | Type group / Object type | Type | Type Description |
---|---|---|---|
1 | CNDP | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
2 | CNTL | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
3 | ICON | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class CL_GUI_BORDERPAINTER has no interface implemented.
Friends
Class CL_GUI_BORDERPAINTER has no friend class.
Attributes
# | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | CO_BORDER_BOTTOM | Constant | Public | Type reference (TYPE) | I | 8 | Bottom border | 20000620 | |
2 | CO_BORDER_LEFT | Constant | Public | Type reference (TYPE) | I | 1 | Left border | 20000620 | |
3 | CO_BORDER_NO | Constant | Public | Type reference (TYPE) | I | 0 | No border | 20000620 | |
4 | CO_BORDER_OUTSIDE | Constant | Public | Type reference (TYPE) | I | 16 | Outer border | 20001006 | |
5 | CO_BORDER_RIGHT | Constant | Public | Type reference (TYPE) | I | 4 | Right border | 20000620 | |
6 | CO_BORDER_TOP | Constant | Public | Type reference (TYPE) | I | 2 | Top border | 20000620 | |
7 | CO_INTERNAL_UNIT_CH | Constant | Protected | Type reference (TYPE) | I | 0 | Characters per Inch | 20000720 | |
8 | CO_INTERNAL_UNIT_CM | Constant | Protected | Type reference (TYPE) | I | 1 | Centimeters | 20000720 | |
9 | CO_INTERNAL_UNIT_IN | Constant | Protected | Type reference (TYPE) | I | 2 | Inches | 20000720 | |
10 | CO_INTERNAL_UNIT_LN | Constant | Protected | Type reference (TYPE) | I | 3 | Lines per Inch | 20000720 | |
11 | CO_INTERNAL_UNIT_MM | Constant | Protected | Type reference (TYPE) | I | 4 | Millimeters | 20000720 | |
12 | CO_INTERNAL_UNIT_NONE | Constant | Protected | Type reference (TYPE) | I | -1 | Characters per Inch | 20000725 | |
13 | CO_INTERNAL_UNIT_PT | Constant | Protected | Type reference (TYPE) | I | 5 | Points | 20000720 | |
14 | CO_INTERNAL_UNIT_TW | Constant | Protected | Type reference (TYPE) | I | 6 | Twips | 20000720 | |
15 | CO_KEY_COPY | Constant | Public | Type reference (TYPE) | I | 7 | CTRL-C Key | 20000619 | |
16 | CO_KEY_CUT | Constant | Public | Type reference (TYPE) | I | 6 | CTRL-X Key | 20000619 | |
17 | CO_KEY_DELETE | Constant | Public | Type reference (TYPE) | I | 2 | Delete Key | 20000619 | |
18 | CO_KEY_ENTER | Constant | Public | Type reference (TYPE) | I | 5 | Enter Key | 20000619 | |
19 | CO_KEY_F1 | Constant | Public | Type reference (TYPE) | I | 1 | F1 Key | 20000619 | |
20 | CO_KEY_F4 | Constant | Public | Type reference (TYPE) | I | 4 | F4 Key | 20000619 | |
21 | CO_KEY_INSERT | Constant | Public | Type reference (TYPE) | I | 3 | Insert Key | 20000619 | |
22 | CO_KEY_PASTE | Constant | Public | Type reference (TYPE) | I | 8 | CTRL-V Key | 20000619 | |
23 | CO_MODE_DESIGN | Constant | Public | Type reference (TYPE) | I | 1 | Design mode | 20000619 | |
24 | CO_MODE_RUN | Constant | Public | Type reference (TYPE) | I | 0 | Run mode | 20000619 | |
25 | CO_UNIT_CH | Constant | Public | Type reference (TYPE) | TDUNIT | 'CH' | Characters per Inch | 20000720 | |
26 | CO_UNIT_CM | Constant | Public | Type reference (TYPE) | TDUNIT | 'CM' | Centimeters | 20000720 | |
27 | CO_UNIT_IN | Constant | Public | Type reference (TYPE) | TDUNIT | 'IN' | Inches | 20000720 | |
28 | CO_UNIT_LN | Constant | Public | Type reference (TYPE) | TDUNIT | 'LN' | Lines per Inch | 20000720 | |
29 | CO_UNIT_MM | Constant | Public | Type reference (TYPE) | TDUNIT | 'MM' | Millimeters | 20000720 | |
30 | CO_UNIT_NONE | Constant | Public | Type reference (TYPE) | TDUNIT | ' ' | Characters per Inch | 20000725 | |
31 | CO_UNIT_PT | Constant | Public | Type reference (TYPE) | TDUNIT | 'PT' | Points | 20000720 | |
32 | CO_UNIT_TW | Constant | Public | Type reference (TYPE) | TDUNIT | 'TW' | Twips | 20000720 | |
33 | EVENTID_BORDER_CHANGED | Constant | Public | Type reference (TYPE) | I | 3 | Event border(s) changed | 20000619 | |
34 | EVENTID_CONTEXT_MENU_REQUESTED | Constant | Public | Type reference (TYPE) | I | 1 | Event context menu requested | 20000619 | |
35 | EVENTID_CONTEXT_MENU_SELECTED | Constant | Public | Type reference (TYPE) | I | 2 | Event context menu selected | 20000619 | |
36 | EVENTID_KEY_PRESSED | Constant | Public | Type reference (TYPE) | I | 4 | Event key pressed | 20000619 | |
37 | M_BORDER | Instance attribute | Public | Type reference (TYPE) | I | Border | 20000619 | ||
38 | M_MODE | Instance attribute | Public | Type reference (TYPE) | I | Mode | 20000619 | ||
39 | M_VERSION | Instance attribute | Private | Type reference (TYPE) | I | Border Painter Control version | 20000619 |
Methods
# | Method | Level | Visibility | Method type | Description | Created on |
---|---|---|---|---|---|---|
1 | ADD_KEY_STROKE | Instance method | Public | Method | Add key stroke for event key_pressed | 20000619 |
2 | CONSTRUCTOR | Instance method | Public | Constructor | Constructor | 20000619 |
3 | CONVERT_INTERNAL_UNIT_TO_UNIT | Instance method | Protected | Method | Convert internal unit to unit | 20000720 |
4 | CONVERT_UNIT_TO_INTERNAL_UNIT | Instance method | Protected | Method | Convert unit to internal unit | 20000720 |
5 | GET_BORDER_LINE | Instance method | Public | Method | Get border line | 20000620 |
6 | INIT | Instance method | Public | Method | Initialization | 20000619 |
7 | PROCESS_CONTEXT_MENU | Instance method | Public | Method | Display and process a context menu | 20000619 |
8 | REG_BORDER_CHANGED | Instance method | Public | Method | Register event border(s) changed | 20000619 |
9 | REG_CONTEXT_MENU_REQUESTED | Instance method | Public | Method | Register event context menu requested | 20000619 |
10 | REG_CONTEXT_MENU_SELECTED | Instance method | Public | Method | Register event context menu selected | 20000619 |
11 | REG_KEY_PRESSED | Instance method | Public | Method | Register event key pressed | 20000619 |
12 | REMOVE_ALL_KEY_STROKES | Instance method | Public | Method | Remove all key strokes for event key_pressed | 20000619 |
13 | SET_BACKGROUND | Instance method | Public | Method | Set background color | 20000620 |
14 | SET_BORDER | Instance method | Public | Method | Set border | 20000619 |
15 | SET_BORDERPAINTER_MODE | Instance method | Public | Method | Toggle control between design mode and run mode | 20000619 |
16 | SET_BORDER_LINE | Instance method | Public | Method | Set border line | 20000620 |
17 | SET_BORDER_QUICKINFO | Instance method | Public | Method | Set border quickinfo | 20001006 |
18 | UNREG_BORDER_CHANGED | Instance method | Public | Method | Unregister event border(s) changed | 20000619 |
19 | UNREG_CONTEXT_MENU_REQUESTED | Instance method | Public | Method | Deregister event context menu requested | 20000619 |
20 | UNREG_CONTEXT_MENU_SELECTED | Instance method | Public | Method | Deregister event context menu selected | 20000619 |
21 | UNREG_KEY_PRESSED | Instance method | Public | Method | Unregister event key pressed | 20000619 |
Events
# | Event | Type | Visibility | Description | Created on |
---|---|---|---|---|---|
1 | BORDER_CHANGED | Instance Event (0) |
Public (2) |
One or more border(s) have changed | 20000619 |
2 | CONTEXT_MENU_REQUESTED | Instance Event (0) |
Public (2) |
Context menu requested | 20000619 |
3 | CONTEXT_MENU_SELECTED | Instance Event (0) |
Public (2) |
Context menu selected | 20000619 |
4 | KEY_PRESSED | Instance Event (0) |
Public (2) |
Key pressed on the border painter | 20000619 |
Types
Class CL_GUI_BORDERPAINTER has no local type.
Method Signatures
Method ADD_KEY_STROKE Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | KEY | Call by reference | Type reference (TYPE) | I | Key (see attributes) | 20000619 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | Control error | 20000619 | |
2 | UNKNOWN_KEY | Unknown key | 20000619 |
Method CONSTRUCTOR Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | BORDER | Call by reference | Type reference (TYPE) | I | 1 | Border | 20000619 | |
2 | Importing | LIFETIME | Call by reference | Type reference (TYPE) | I | Lifetime | 20000619 | ||
3 | Importing | MODE | Call by reference | Type reference (TYPE) | I | CO_MODE_DESIGN | Mode | 20000619 | |
4 | Importing | NAME | Value transfer | Type reference (TYPE) | STRING | Name | 20000619 | ||
5 | Importing | PARENT | Value transfer | Object reference (TYPE REF TO) | CL_GUI_CONTAINER | Parent container | 20000619 | ||
6 | Importing | SHELLSTYLE | Value transfer | Type reference (TYPE) | I | Shell style | 20000619 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | Control error | 20000619 | |
2 | GUI_TYPE_NOT_SUPPORTED | This type of GUI is not supported! | 20000619 |
Method CONVERT_INTERNAL_UNIT_TO_UNIT Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | INTERNAL_UNIT | Call by reference | Type reference (TYPE) | I | Internal unit | 20000720 | ||
2 | Exporting | UNIT | Call by reference | Type reference (TYPE) | SSFDOCSTRC-U_WLEFT | String unit | 20000720 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | UNKNOWN_UNIT | Unknown unit | 20000720 |
Method CONVERT_UNIT_TO_INTERNAL_UNIT Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Exporting | INTERNAL_UNIT | Call by reference | Type reference (TYPE) | I | Internal unit | 20000720 | ||
2 | Importing | UNIT | Call by reference | Type reference (TYPE) | SSFDOCSTRC-U_WLEFT | String unit | 20000720 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | UNKNOWN_UNIT | Unknown unit | 20000720 |
Method GET_BORDER_LINE Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | BORDER | Call by reference | Type reference (TYPE) | I | Border | 20000620 | ||
2 | Exporting | LINE | Call by reference | Type reference (TYPE) | I | Line visible? | 20000620 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | Control error | 20000620 |
Method INIT Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | BORDER | Call by reference | Type reference (TYPE) | I | 1 | Border | 20000619 | |
2 | Importing | MODE | Call by reference | Type reference (TYPE) | I | CO_MODE_DESIGN | Mode | 20000619 | |
3 | Importing | TOOLBAR | Call by reference | Type reference (TYPE) | I | 1 | Toolbar | 20000619 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | Control error | 20000619 |
Method PROCESS_CONTEXT_MENU Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | CONTEXT_MENU | Call by reference | Object reference (TYPE REF TO) | CL_CTMENU | Context menu | 20000619 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | Control error | 20000619 |
Method REG_BORDER_CHANGED Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | APPL_EVENT | Call by reference | Type reference (TYPE) | CNTL_SIMPLE_EVENT-APPL_EVENT | Application event? | 20000619 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | ERROR_EVENT_CONTROL | Error while registering event | 20000619 | |
2 | EVENT_ALREADY_REGISTERED | Event already registered | 20000619 |
Method REG_CONTEXT_MENU_REQUESTED Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | APPL_EVENT | Call by reference | Type reference (TYPE) | CNTL_SIMPLE_EVENT-APPL_EVENT | Application event? | 20000619 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | ERROR_EVENT_CONTROL | Error while registering event | 20000619 | |
2 | EVENT_ALREADY_REGISTERED | Event already registered | 20000619 |
Method REG_CONTEXT_MENU_SELECTED Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | APPL_EVENT | Call by reference | Type reference (TYPE) | CNTL_SIMPLE_EVENT-APPL_EVENT | Application event? | 20000619 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | ERROR_EVENT_CONTROL | Error while registering event | 20000619 | |
2 | EVENT_ALREADY_REGISTERED | Event already registered | 20000619 |
Method REG_KEY_PRESSED Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | APPL_EVENT | Call by reference | Type reference (TYPE) | CNTL_SIMPLE_EVENT-APPL_EVENT | Application event? | 20000619 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | ERROR_EVENT_CONTROL | Error while registering event | 20000619 | |
2 | EVENT_ALREADY_REGISTERED | Event already registered | 20000619 |
Method REMOVE_ALL_KEY_STROKES Signature
Method REMOVE_ALL_KEY_STROKES on class CL_GUI_BORDERPAINTER has no parameter.
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | Control error | 20000619 |
Method SET_BACKGROUND Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | BLUE | Call by reference | Type reference (TYPE) | I | Blue | 20000620 | ||
2 | Importing | GREEN | Call by reference | Type reference (TYPE) | I | Green | 20000620 | ||
3 | Importing | RED | Call by reference | Type reference (TYPE) | I | Red | 20000620 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | Control error | 20000620 |
Method SET_BORDER Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | BORDER | Call by reference | Type reference (TYPE) | I | Border | 20000619 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | Control error | 20000619 |
Method SET_BORDERPAINTER_MODE Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | MODE | Call by reference | Type reference (TYPE) | I | Mode | 20000619 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | Control Error | 20000619 |
Method SET_BORDER_LINE Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | BLUE | Call by reference | Type reference (TYPE) | I | Blue | 20000620 | ||
2 | Importing | BORDER | Call by reference | Type reference (TYPE) | I | Border | 20000620 | ||
3 | Importing | DISTANCE | Call by reference | Type reference (TYPE) | SSFNEWLINE-DISTANCE | Distance | 20000720 | ||
4 | Importing | DISTANCE_UNIT | Call by reference | Type reference (TYPE) | SSFNEWLINE-DISTANCEU | Unit of distance | 20000720 | ||
5 | Importing | GREEN | Call by reference | Type reference (TYPE) | I | Green | 20000620 | ||
6 | Importing | LINE | Call by reference | Type reference (TYPE) | I | Is border line visible? | 20000620 | ||
7 | Importing | RED | Call by reference | Type reference (TYPE) | I | Red | 20000620 | ||
8 | Importing | THICKNESS | Call by reference | Type reference (TYPE) | SSFNEWLINE-THICKNESS | Thickness | 20000720 | ||
9 | Importing | THICKNESS_UNIT | Call by reference | Type reference (TYPE) | SSFNEWLINE-THICKNESSU | Unit of thickness | 20000720 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | Control error | 20000620 | |
2 | UNKNOWN_UNIT | Unknown unit | 20000720 |
Method SET_BORDER_QUICKINFO Signature
# | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | Importing | BORDER | Call by reference | Type reference (TYPE) | I | Border | 20001006 | ||
2 | Importing | QUICKINFO | Call by reference | Type reference (TYPE) | ICONQUICK | Quickinfo | 20001006 |
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | CNTL_ERROR | Control error | 20001006 |
Method UNREG_BORDER_CHANGED Signature
Method UNREG_BORDER_CHANGED on class CL_GUI_BORDERPAINTER has no parameter.
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | ERROR_EVENT_CONTROL | Error while unregistering event | 20000619 | |
2 | EVENT_NOT_REGISTERED | Event not registered | 20000619 |
Method UNREG_CONTEXT_MENU_REQUESTED Signature
Method UNREG_CONTEXT_MENU_REQUESTED on class CL_GUI_BORDERPAINTER has no parameter.
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | ERROR_EVENT_CONTROL | Error while unregistering event | 20000619 | |
2 | EVENT_NOT_REGISTERED | Event not registered | 20000619 |
Method UNREG_CONTEXT_MENU_SELECTED Signature
Method UNREG_CONTEXT_MENU_SELECTED on class CL_GUI_BORDERPAINTER has no parameter.
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | ERROR_EVENT_CONTROL | Error while unregistering event | 20000619 | |
2 | EVENT_NOT_REGISTERED | Event not registered | 20000619 |
Method UNREG_KEY_PRESSED Signature
Method UNREG_KEY_PRESSED on class CL_GUI_BORDERPAINTER has no parameter.
# | Exception | Resumable | Description | Created on |
---|---|---|---|---|
1 | ERROR_EVENT_CONTROL | Error while unregistering event | 20000619 | |
2 | EVENT_NOT_REGISTERED | Event not registered | 20000619 |
Event Signatures
Event BORDER_CHANGED Signature
Event BORDER_CHANGED on class CL_GUI_BORDERPAINTER has no parameter.
Event CONTEXT_MENU_REQUESTED Signature
Event CONTEXT_MENU_REQUESTED on class CL_GUI_BORDERPAINTER has no parameter.
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 | FCode of selected menu item | 20000619 |
Event KEY_PRESSED Signature
# | Parameter | Type | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
---|---|---|---|---|---|---|---|---|---|
1 | KEY | Exporting | Value transfer | Type reference (TYPE) | I | Key | 20000619 |
History
Last changed by/on | SAP | 20000619 |
SAP Release Created in | 50A |