SAP ABAP Class CL_CCM_WS_DISPLAY_CONTAINER (CIC Workspace Display Container (Appl. & Navig. Area))
Hierarchy
☛
BBPCRM (Software Component) BBPCRM
⤷
CRM-CIC (Application Component) Interaction Center WinClient
⤷
CRM_CIC_COMPONENTS (Package) Interaction Center components
⤷
⤷
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | IF_CCM_WSM_DISPLAY | Workspace manager display client | 19990920 |
Properties
| Class | CL_CCM_WS_DISPLAY_CONTAINER | |
| Short Description | CIC Workspace Display Container (Appl. & Navig. Area) | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | CRM_CIC_COMPONENTS | Interaction Center components |
| Created | 19990920 | SAP |
| Last change | 20050705 | 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) |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_CCM_WSM_DISPLAY | Workspace manager display client | 19990920 |
Friends
Class CL_CCM_WS_DISPLAY_CONTAINER has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Instance attribute | Private | Type reference (TYPE) | CIC0_DISPOPTS | Display Options (Spacers) | 19990920 | |||
| 2 | Instance attribute | Private | Type reference (TYPE) | CIC0_VARID | display variant | 19991008 | |||
| 3 | Instance attribute | Public | Object reference (TYPE REF TO) | CL_GUI_CUSTOM_CONTAINER | GUI custom container | 19990920 | |||
| 4 | Instance attribute | Private | Type reference (TYPE) | CXTAB_TABSTRIP | Tabstrip (control of appl.area screen) | 19990920 | |||
| 5 | Instance attribute | Private | Type reference (TYPE) | I | 0 | Current number of workspace displays | 19990920 | ||
| 6 | Instance attribute | Private | Type reference (TYPE) | I | 0 | Maximum number of tabs | 19990920 | ||
| 7 | Instance attribute | Private | Type reference (TYPE) | WS_DISPLAY_TAB | workspace displays | 19990920 | |||
| 8 | Instance attribute | Private | Type reference (TYPE) | WS_DISPLAY_TAB | new ws displays (for switch-method) | 19991011 | |||
| 9 | Instance attribute | Private | Object reference (TYPE REF TO) | CL_CCM_WS_DISPLAY1 | active workspace display | 19990920 | |||
| 10 | Instance attribute | Private | Type reference (TYPE) | WS_DISPLAY_TAB | activation stack | 19990920 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Constructor | CONSTRUCTOR | 19990920 | |
| 2 | Instance method | Public | Method | deletes a workspace display | 19990920 | |
| 3 | Instance method | Public | Method | executes ws callback | 19990920 | |
| 4 | Instance method | Public | Method | returns the active display's button descriptions | 19990920 | |
| 5 | Instance method | Public | Method | returns number of active workspace display | 19990920 | |
| 6 | Instance method | Public | Method | returns the active display's subscreen interface (if exist.) | 19990920 | |
| 7 | Instance method | Public | Method | gets the display options (spacers) | 19990920 | |
| 8 | Instance method | Public | Method | gets the display variant | 19991008 | |
| 9 | Instance method | Public | Method | returns gui container | 19990920 | |
| 10 | Instance method | Public | Method | returns tabstrip (and number of active workspace display) | 19990920 | |
| 11 | Instance method | Public | Method | returns a table of the current workspace displays texts | 19990920 | |
| 12 | Instance method | Public | Method | prepares PBO of application area screen | 19990920 | |
| 13 | Instance method | Public | Method | select a workspace display by number | 19990920 | |
| 14 | Instance method | Private | Method | selects a display (internal) | 19990920 | |
| 15 | Instance method | Public | Method | sets the display options (spacers) | 19990920 | |
| 16 | Instance method | Public | Method | sets the display variant | 19991008 | |
| 17 | Instance method | Public | Method | sets tabstrip | 19990920 | |
| 18 | Instance method | Private | Method | switches to active display | 19990920 |
Events
Class CL_CCM_WS_DISPLAY_CONTAINER has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | WS_DISPLAY_TAB | Private | See coding | table of workspace displays | 19990920 | |
Method Signatures
Method CONSTRUCTOR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_CONTAINER_NAME | Value transfer | Type reference (TYPE) | SCRFNAME | Name of container | 19990920 | |||
| 2 | IM_TAB_MAX | Value transfer | Type reference (TYPE) | I | Maximum number of tabs | 19990920 |
Method CONSTRUCTOR on class CL_CCM_WS_DISPLAY_CONTAINER has no exception.
Method DELETE_DISPLAY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_WS_DISPLAY | Call by reference | Object reference (TYPE REF TO) | CL_CCM_WS_DISPLAY1 | display to be deleted | 19990920 |
Method DELETE_DISPLAY on class CL_CCM_WS_DISPLAY_CONTAINER has no exception.
Method EXEC_WS_CALLBACK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_OKCODE | Value transfer | Type reference (TYPE) | SYUCOMM | okcode of pressed button | 19990920 |
Method EXEC_WS_CALLBACK on class CL_CCM_WS_DISPLAY_CONTAINER has no exception.
Method GET_ACTIVE_WSD_BUTTONS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RE_BUTTONS | Value transfer | Type reference (TYPE) | CCM_BUTTON_ATTRIBUTES_T | button descriptions | 19990920 |
Method GET_ACTIVE_WSD_BUTTONS on class CL_CCM_WS_DISPLAY_CONTAINER has no exception.
Method GET_ACTIVE_WSD_NUMBER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RE_WSD_NUMBER | Value transfer | Type reference (TYPE) | I | Number of active workspace display | 19990920 |
Method GET_ACTIVE_WSD_NUMBER on class CL_CCM_WS_DISPLAY_CONTAINER has no exception.
Method GET_ACTIVE_WSD_SUBSCREEN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RE_SUBSCREEN_WORKSPACE | Value transfer | Object reference (TYPE REF TO) | IF_CCM_SUBSCREEN_WORKSPACE | Subscreen workspace interface | 19990920 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | active display has no subscreen workspace | 19990920 | ||
| 2 | active display has no workspace | 19990920 |
Method GET_DISPLAY_OPTIONS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RE_DISPLAY_OPTIONS | Value transfer | Type reference (TYPE) | CIC0_DISPOPTS | display options | 19990920 |
Method GET_DISPLAY_OPTIONS on class CL_CCM_WS_DISPLAY_CONTAINER has no exception.
Method GET_DISPLAY_VARIANT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RE_VARID | Value transfer | Type reference (TYPE) | CIC0_VARID | Display Variant ID | 19991008 |
Method GET_DISPLAY_VARIANT on class CL_CCM_WS_DISPLAY_CONTAINER has no exception.
Method GET_GUI_CONTAINER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RE_GUI_CONTAINER | Value transfer | Object reference (TYPE REF TO) | CL_GUI_CONTAINER | gui container | 19990920 |
Method GET_GUI_CONTAINER on class CL_CCM_WS_DISPLAY_CONTAINER has no exception.
Method GET_TABSTRIP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RE_TABSTRIP | Value transfer | Type reference (TYPE) | CXTAB_TABSTRIP | tabstrip | 19990920 |
Method GET_TABSTRIP on class CL_CCM_WS_DISPLAY_CONTAINER has no exception.
Method GET_WS_TEXTS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RE_WS_TEXTS | Value transfer | Type reference (TYPE) | CCM_TAB_ATTRIBUTES_T | workspace display texts | 19990920 |
Method GET_WS_TEXTS on class CL_CCM_WS_DISPLAY_CONTAINER has no exception.
Method PREPARE_PBO Signature
Method PREPARE_PBO on class CL_CCM_WS_DISPLAY_CONTAINER has no parameter.
Method PREPARE_PBO on class CL_CCM_WS_DISPLAY_CONTAINER has no exception.
Method SELECT_DISPLAY_BY_NUMBER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_NUMBER | Call by reference | Type reference (TYPE) | I | number of display selected | 19990920 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | number of display is invalid | 19990920 |
Method SELECT_DISPLAY_INTERNAL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_WS_DISPLAY | Call by reference | Object reference (TYPE REF TO) | CL_CCM_WS_DISPLAY1 | workspace display to select | 19990920 |
Method SELECT_DISPLAY_INTERNAL on class CL_CCM_WS_DISPLAY_CONTAINER has no exception.
Method SET_DISPLAY_OPTIONS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_DISPLAY_OPTIONS | Call by reference | Type reference (TYPE) | CIC0_DISPOPTS | display options | 19990920 |
Method SET_DISPLAY_OPTIONS on class CL_CCM_WS_DISPLAY_CONTAINER has no exception.
Method SET_DISPLAY_VARIANT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_VARID | Call by reference | Type reference (TYPE) | CIC0_VARID | Display Variant ID | 19991008 |
Method SET_DISPLAY_VARIANT on class CL_CCM_WS_DISPLAY_CONTAINER has no exception.
Method SET_TABSTRIP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IM_TABSTRIP | Value transfer | Type reference (TYPE) | CXTAB_TABSTRIP | tabstrip | 19990920 |
Method SET_TABSTRIP on class CL_CCM_WS_DISPLAY_CONTAINER has no exception.
Method SWITCH_DISPLAY Signature
Method SWITCH_DISPLAY on class CL_CCM_WS_DISPLAY_CONTAINER has no parameter.
Method SWITCH_DISPLAY on class CL_CCM_WS_DISPLAY_CONTAINER has no exception.
History
| Last changed by/on | SAP | 20050705 |
| SAP Release Created in |