SAP ABAP Class CL_BTP_WD_HELPBOX (BTP Assistance Helpbox)
Hierarchy
☛
DMIS (Software Component) DMIS 2011_1
⤷
CA-EUR (Application Component) European Monetary Union: Euro
⤷
BTP_WD (Package) BTP Web Dynpro Layer
⤷
⤷
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Inheritance (c INHERITING FROM c_ref) | CL_BTP_WD_ASSIST | BTP Assistance Super Class | 20091230 |
Properties
| Class | CL_BTP_WD_HELPBOX | |
| Short Description | BTP Assistance Helpbox | |
| Super Class | CL_BTP_WD_ASSIST | BTP Assistance Super Class |
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | BTP_WD | BTP Web Dynpro Layer |
| Created | 20091229 | SAP |
| Last change | 20141030 | |
| 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) |
Interfaces
Class CL_BTP_WD_HELPBOX has no interface implemented.
Friends
Class CL_BTP_WD_HELPBOX has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Instance attribute | Public | Type reference (TYPE) | CNV_MBT_SCENARIO | MBT PCL: Scenario | 20121105 | |||
| 2 | Instance attribute | Private | Object reference (TYPE REF TO) | CL_BTP_DL_DOCU | BTP Portfolio Item Documentation Object | 20100305 | |||
| 3 | Instance attribute | Private | Type reference (TYPE) | BTP_DL_T_REF_DOCU | BTP Portfolio Item Documentation Object | 20100305 | |||
| 4 | Instance attribute | Private | Type reference (TYPE) | I | 0 | 20100305 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Add docu to the history table | 20100305 | |
| 2 | Instance method | Public | Constructor | CONSTRUCTOR | 20091230 | |
| 3 | Instance method | Public | Method | Gets help docu objects for all currently regist components | 20100105 | |
| 4 | Instance method | Public | Method | Returns index of the currently displayed docu | 20100305 | |
| 5 | Instance method | Public | Method | Return size of history table | 20100305 | |
| 6 | Instance method | Private | Method | Get help documentation recursively for a view and children | 20100105 | |
| 7 | Instance method | Public | Method | Get next docu in the history | 20100305 | |
| 8 | Instance method | Public | Method | Get previous docu in the history | 20100305 | |
| 9 | Instance method | Public | Method | Return currently selected docu, to be displayed in the popup | 20100305 | |
| 10 | Instance method | Public | Method | Set currently selected docu, to be displayed in the popup | 20100305 |
Events
Class CL_BTP_WD_HELPBOX has no event.
Types
Class CL_BTP_WD_HELPBOX has no local type.
Method Signatures
Method ADD_NEW_DOCU Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IR_DOCU | Call by reference | Object reference (TYPE REF TO) | CL_BTP_DL_DOCU | BTP Portfolio Item Documentation Object | 20100305 |
Method ADD_NEW_DOCU on class CL_BTP_WD_HELPBOX has no exception.
Method CONSTRUCTOR Signature
Method CONSTRUCTOR on class CL_BTP_WD_HELPBOX has no parameter.
Method CONSTRUCTOR on class CL_BTP_WD_HELPBOX has no exception.
Method GET_ACTIVE_HELP_DOCU Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IR_VIEW | Call by reference | Object reference (TYPE REF TO) | CL_WDR_VIEW | Web Dynpro View Controller | 20100726 | |||
| 2 | RT_DOCU | Value transfer | Type reference (TYPE) | BTP_DL_T_REF_DOCU | BTP References to Documentation Objects | 20100105 |
Method GET_ACTIVE_HELP_DOCU on class CL_BTP_WD_HELPBOX has no exception.
Method GET_CURRENT_DOCU_INDEX Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_CURRENT_DOCU_INDEX | Value transfer | Type reference (TYPE) | I | 20100305 |
Method GET_CURRENT_DOCU_INDEX on class CL_BTP_WD_HELPBOX has no exception.
Method GET_DOCU_HISTORY_SIZE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_SIZE | Value transfer | Type reference (TYPE) | I | 20100305 |
Method GET_DOCU_HISTORY_SIZE on class CL_BTP_WD_HELPBOX has no exception.
Method GET_HELP_DOCU Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IR_VIEW | Call by reference | Object reference (TYPE REF TO) | CL_WDR_VIEW | Web Dynpro View Controller | 20100105 | |||
| 2 | XT_DOCU | Call by reference | Type reference (TYPE) | BTP_DL_T_REF_DOCU | BTP References to Documentation Objects | 20100105 |
Method GET_HELP_DOCU on class CL_BTP_WD_HELPBOX has no exception.
Method GET_NEXT_DOCU Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_NEXT_DOCU | Value transfer | Object reference (TYPE REF TO) | CL_BTP_DL_DOCU | BTP Portfolio Item Documentation Object | 20100305 |
Method GET_NEXT_DOCU on class CL_BTP_WD_HELPBOX has no exception.
Method GET_PREVIOUS_DOCU Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_PREVIOUS_DOCU | Value transfer | Object reference (TYPE REF TO) | CL_BTP_DL_DOCU | BTP Portfolio Item Documentation Object | 20100305 |
Method GET_PREVIOUS_DOCU on class CL_BTP_WD_HELPBOX has no exception.
Method GET_SELECTED_DOCU Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RR_SELECTED_DOCU | Value transfer | Object reference (TYPE REF TO) | CL_BTP_DL_DOCU | BTP Portfolio Item Documentation Object | 20100305 |
Method GET_SELECTED_DOCU on class CL_BTP_WD_HELPBOX has no exception.
Method SET_SELECTED_DOCU Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IR_SELECTED_DOCU | Value transfer | Object reference (TYPE REF TO) | CL_BTP_DL_DOCU | BTP Portfolio Item Documentation Object | 20100305 |
Method SET_SELECTED_DOCU on class CL_BTP_WD_HELPBOX has no exception.
History
| Last changed by/on | SAP | 20141030 |
| SAP Release Created in | 2006_1_700 |