Hierarchy
⤷
⤷
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 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) | |
| 2 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) | |
| 3 | 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 | Constant | Public | Type reference (TYPE) | I | 8 | Bottom border | 20000620 | ||
| 2 | Constant | Public | Type reference (TYPE) | I | 1 | Left border | 20000620 | ||
| 3 | Constant | Public | Type reference (TYPE) | I | 0 | No border | 20000620 | ||
| 4 | Constant | Public | Type reference (TYPE) | I | 16 | Outer border | 20001006 | ||
| 5 | Constant | Public | Type reference (TYPE) | I | 4 | Right border | 20000620 | ||
| 6 | Constant | Public | Type reference (TYPE) | I | 2 | Top border | 20000620 | ||
| 7 | Constant | Protected | Type reference (TYPE) | I | 0 | Characters per Inch | 20000720 | ||
| 8 | Constant | Protected | Type reference (TYPE) | I | 1 | Centimeters | 20000720 | ||
| 9 | Constant | Protected | Type reference (TYPE) | I | 2 | Inches | 20000720 | ||
| 10 | Constant | Protected | Type reference (TYPE) | I | 3 | Lines per Inch | 20000720 | ||
| 11 | Constant | Protected | Type reference (TYPE) | I | 4 | Millimeters | 20000720 | ||
| 12 | Constant | Protected | Type reference (TYPE) | I | -1 | Characters per Inch | 20000725 | ||
| 13 | Constant | Protected | Type reference (TYPE) | I | 5 | Points | 20000720 | ||
| 14 | Constant | Protected | Type reference (TYPE) | I | 6 | Twips | 20000720 | ||
| 15 | Constant | Public | Type reference (TYPE) | I | 7 | CTRL-C Key | 20000619 | ||
| 16 | Constant | Public | Type reference (TYPE) | I | 6 | CTRL-X Key | 20000619 | ||
| 17 | Constant | Public | Type reference (TYPE) | I | 2 | Delete Key | 20000619 | ||
| 18 | Constant | Public | Type reference (TYPE) | I | 5 | Enter Key | 20000619 | ||
| 19 | Constant | Public | Type reference (TYPE) | I | 1 | F1 Key | 20000619 | ||
| 20 | Constant | Public | Type reference (TYPE) | I | 4 | F4 Key | 20000619 | ||
| 21 | Constant | Public | Type reference (TYPE) | I | 3 | Insert Key | 20000619 | ||
| 22 | Constant | Public | Type reference (TYPE) | I | 8 | CTRL-V Key | 20000619 | ||
| 23 | Constant | Public | Type reference (TYPE) | I | 1 | Design mode | 20000619 | ||
| 24 | Constant | Public | Type reference (TYPE) | I | 0 | Run mode | 20000619 | ||
| 25 | Constant | Public | Type reference (TYPE) | TDUNIT | 'CH' | Characters per Inch | 20000720 | ||
| 26 | Constant | Public | Type reference (TYPE) | TDUNIT | 'CM' | Centimeters | 20000720 | ||
| 27 | Constant | Public | Type reference (TYPE) | TDUNIT | 'IN' | Inches | 20000720 | ||
| 28 | Constant | Public | Type reference (TYPE) | TDUNIT | 'LN' | Lines per Inch | 20000720 | ||
| 29 | Constant | Public | Type reference (TYPE) | TDUNIT | 'MM' | Millimeters | 20000720 | ||
| 30 | Constant | Public | Type reference (TYPE) | TDUNIT | ' ' | Characters per Inch | 20000725 | ||
| 31 | Constant | Public | Type reference (TYPE) | TDUNIT | 'PT' | Points | 20000720 | ||
| 32 | Constant | Public | Type reference (TYPE) | TDUNIT | 'TW' | Twips | 20000720 | ||
| 33 | Constant | Public | Type reference (TYPE) | I | 3 | Event border(s) changed | 20000619 | ||
| 34 | Constant | Public | Type reference (TYPE) | I | 1 | Event context menu requested | 20000619 | ||
| 35 | Constant | Public | Type reference (TYPE) | I | 2 | Event context menu selected | 20000619 | ||
| 36 | Constant | Public | Type reference (TYPE) | I | 4 | Event key pressed | 20000619 | ||
| 37 | Instance attribute | Public | Type reference (TYPE) | I | Border | 20000619 | |||
| 38 | Instance attribute | Public | Type reference (TYPE) | I | Mode | 20000619 | |||
| 39 | Instance attribute | Private | Type reference (TYPE) | I | Border Painter Control version | 20000619 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Add key stroke for event key_pressed | 20000619 | |
| 2 | Instance method | Public | Constructor | Constructor | 20000619 | |
| 3 | Instance method | Protected | Method | Convert internal unit to unit | 20000720 | |
| 4 | Instance method | Protected | Method | Convert unit to internal unit | 20000720 | |
| 5 | Instance method | Public | Method | Get border line | 20000620 | |
| 6 | Instance method | Public | Method | Initialization | 20000619 | |
| 7 | Instance method | Public | Method | Display and process a context menu | 20000619 | |
| 8 | Instance method | Public | Method | Register event border(s) changed | 20000619 | |
| 9 | Instance method | Public | Method | Register event context menu requested | 20000619 | |
| 10 | Instance method | Public | Method | Register event context menu selected | 20000619 | |
| 11 | Instance method | Public | Method | Register event key pressed | 20000619 | |
| 12 | Instance method | Public | Method | Remove all key strokes for event key_pressed | 20000619 | |
| 13 | Instance method | Public | Method | Set background color | 20000620 | |
| 14 | Instance method | Public | Method | Set border | 20000619 | |
| 15 | Instance method | Public | Method | Toggle control between design mode and run mode | 20000619 | |
| 16 | Instance method | Public | Method | Set border line | 20000620 | |
| 17 | Instance method | Public | Method | Set border quickinfo | 20001006 | |
| 18 | Instance method | Public | Method | Unregister event border(s) changed | 20000619 | |
| 19 | Instance method | Public | Method | Deregister event context menu requested | 20000619 | |
| 20 | Instance method | Public | Method | Deregister event context menu selected | 20000619 | |
| 21 | 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 | KEY | Call by reference | Type reference (TYPE) | I | Key (see attributes) | 20000619 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Control error | 20000619 | ||
| 2 | Unknown key | 20000619 |
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | BORDER | Call by reference | Type reference (TYPE) | I | 1 | Border | 20000619 | ||
| 2 | LIFETIME | Call by reference | Type reference (TYPE) | I | Lifetime | 20000619 | |||
| 3 | MODE | Call by reference | Type reference (TYPE) | I | CO_MODE_DESIGN | Mode | 20000619 | ||
| 4 | NAME | Value transfer | Type reference (TYPE) | STRING | Name | 20000619 | |||
| 5 | PARENT | Value transfer | Object reference (TYPE REF TO) | CL_GUI_CONTAINER | Parent container | 20000619 | |||
| 6 | SHELLSTYLE | Value transfer | Type reference (TYPE) | I | Shell style | 20000619 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Control error | 20000619 | ||
| 2 | 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 | INTERNAL_UNIT | Call by reference | Type reference (TYPE) | I | Internal unit | 20000720 | |||
| 2 | UNIT | Call by reference | Type reference (TYPE) | SSFDOCSTRC-U_WLEFT | String unit | 20000720 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 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 | INTERNAL_UNIT | Call by reference | Type reference (TYPE) | I | Internal unit | 20000720 | |||
| 2 | UNIT | Call by reference | Type reference (TYPE) | SSFDOCSTRC-U_WLEFT | String unit | 20000720 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Unknown unit | 20000720 |
Method GET_BORDER_LINE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | BORDER | Call by reference | Type reference (TYPE) | I | Border | 20000620 | |||
| 2 | LINE | Call by reference | Type reference (TYPE) | I | Line visible? | 20000620 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Control error | 20000620 |
Method INIT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | BORDER | Call by reference | Type reference (TYPE) | I | 1 | Border | 20000619 | ||
| 2 | MODE | Call by reference | Type reference (TYPE) | I | CO_MODE_DESIGN | Mode | 20000619 | ||
| 3 | TOOLBAR | Call by reference | Type reference (TYPE) | I | 1 | Toolbar | 20000619 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Control error | 20000619 |
Method PROCESS_CONTEXT_MENU Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | CONTEXT_MENU | Call by reference | Object reference (TYPE REF TO) | CL_CTMENU | Context menu | 20000619 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Control error | 20000619 |
Method REG_BORDER_CHANGED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | APPL_EVENT | Call by reference | Type reference (TYPE) | CNTL_SIMPLE_EVENT-APPL_EVENT | Application event? | 20000619 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Error while registering event | 20000619 | ||
| 2 | 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 | APPL_EVENT | Call by reference | Type reference (TYPE) | CNTL_SIMPLE_EVENT-APPL_EVENT | Application event? | 20000619 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Error while registering event | 20000619 | ||
| 2 | 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 | APPL_EVENT | Call by reference | Type reference (TYPE) | CNTL_SIMPLE_EVENT-APPL_EVENT | Application event? | 20000619 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Error while registering event | 20000619 | ||
| 2 | Event already registered | 20000619 |
Method REG_KEY_PRESSED Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | APPL_EVENT | Call by reference | Type reference (TYPE) | CNTL_SIMPLE_EVENT-APPL_EVENT | Application event? | 20000619 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Error while registering event | 20000619 | ||
| 2 | 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 | Control error | 20000619 |
Method SET_BACKGROUND Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | BLUE | Call by reference | Type reference (TYPE) | I | Blue | 20000620 | |||
| 2 | GREEN | Call by reference | Type reference (TYPE) | I | Green | 20000620 | |||
| 3 | RED | Call by reference | Type reference (TYPE) | I | Red | 20000620 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Control error | 20000620 |
Method SET_BORDER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | BORDER | Call by reference | Type reference (TYPE) | I | Border | 20000619 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Control error | 20000619 |
Method SET_BORDERPAINTER_MODE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | MODE | Call by reference | Type reference (TYPE) | I | Mode | 20000619 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Control Error | 20000619 |
Method SET_BORDER_LINE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | BLUE | Call by reference | Type reference (TYPE) | I | Blue | 20000620 | |||
| 2 | BORDER | Call by reference | Type reference (TYPE) | I | Border | 20000620 | |||
| 3 | DISTANCE | Call by reference | Type reference (TYPE) | SSFNEWLINE-DISTANCE | Distance | 20000720 | |||
| 4 | DISTANCE_UNIT | Call by reference | Type reference (TYPE) | SSFNEWLINE-DISTANCEU | Unit of distance | 20000720 | |||
| 5 | GREEN | Call by reference | Type reference (TYPE) | I | Green | 20000620 | |||
| 6 | LINE | Call by reference | Type reference (TYPE) | I | Is border line visible? | 20000620 | |||
| 7 | RED | Call by reference | Type reference (TYPE) | I | Red | 20000620 | |||
| 8 | THICKNESS | Call by reference | Type reference (TYPE) | SSFNEWLINE-THICKNESS | Thickness | 20000720 | |||
| 9 | THICKNESS_UNIT | Call by reference | Type reference (TYPE) | SSFNEWLINE-THICKNESSU | Unit of thickness | 20000720 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Control error | 20000620 | ||
| 2 | Unknown unit | 20000720 |
Method SET_BORDER_QUICKINFO Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | BORDER | Call by reference | Type reference (TYPE) | I | Border | 20001006 | |||
| 2 | QUICKINFO | Call by reference | Type reference (TYPE) | ICONQUICK | Quickinfo | 20001006 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | 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 while unregistering event | 20000619 | ||
| 2 | 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 while unregistering event | 20000619 | ||
| 2 | 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 while unregistering event | 20000619 | ||
| 2 | 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 while unregistering event | 20000619 | ||
| 2 | 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 |