SAP ABAP Interface IF_FDT_WD_TOOLBAR_EXTENSION (Extend the toolbar of FDT workbench tools)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-SRV-BR (Application Component) BRFplus - ABAP-Based Business Rules
⤷
SFDT_WD_TOOLS (Package) BRFplus: Tools in Web Dynpro UI
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-SRV-BR (Application Component) BRFplus - ABAP-Based Business Rules⤷
SFDT_WD_TOOLS (Package) BRFplus: Tools in Web Dynpro UI
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_FDT_WD_TOOLBAR_EXTENSION | Extend the toolbar of FDT workbench tools | 20100721 |
Properties
| Interface | IF_FDT_WD_TOOLBAR_EXTENSION | |
| Short Description | Extend the toolbar of FDT workbench tools |
General Data
| Package | SFDT_WD_TOOLS | BRFplus: Tools in Web Dynpro UI |
| Created | 20100721 | SAP |
| Last changed | 20130531 | SAP |
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | ABAP | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
| 2 | IF_FDT_TYPES | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
| 3 | IF_FDT_WD_TOOLBAR_EXTENSION | Forward declaration interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
Interfaces
Interface IF_FDT_WD_TOOLBAR_EXTENSION has no interface.
Friends
Interface IF_FDT_WD_TOOLBAR_EXTENSION has no friend.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | GC_ACTION_BACK | Constant | Public | Type reference (TYPE) | STRING | 'Back' | Constant for action "Back" | 20100722 | |
| 2 | GC_ACTION_BRFPLUS_HELP | Constant | Public | Type reference (TYPE) | STRING | 'BRFPlus_Help' | Constant for action "BRFPlus Help" | 20100723 | |
| 3 | GC_ACTION_CONTEXT_HELP | Constant | Public | Type reference (TYPE) | STRING | 'Context_Help' | Constant for action "Context Help" | 20101108 | |
| 4 | GC_ACTION_LEGEND | Constant | Public | Type reference (TYPE) | STRING | 'Legend' | Constant for action "Legend" | 20100723 | |
| 5 | GC_ACTION_MASS_CHANGE_TOOL | Constant | Public | Type reference (TYPE) | STRING | 'Mass_Change' | Constant for action to go to Mass Change Tool | 20111219 | |
| 6 | GC_ACTION_NAME | Constant | Public | Type reference (TYPE) | STRING | 'Action_Name' | Constant for the name of the executed toolbar action | 20100722 | |
| 7 | GC_ACTION_OBJECT_DOCU | Constant | Public | Type reference (TYPE) | STRING | 'Object_Docu' | Constant for action "Context Help" | 20111202 | |
| 8 | GC_ACTION_PERSONALIZE | Constant | Public | Type reference (TYPE) | STRING | 'Personalize' | Constant for action "Personalize" | 20100722 | |
| 9 | GC_ACTION_PING_WORKBENCH | Constant | Public | Type reference (TYPE) | STRING | 'Ping_Workbench' | Constant for the action to ping the workbench | 20100726 | |
| 10 | GC_ACTION_SYSTEM_INFO | Constant | Public | Type reference (TYPE) | STRING | 'System_Info' | Constant for action "System Info" | 20100723 | |
| 11 | GC_ACTION_TOGGLE_EXPLANATION | Constant | Public | Type reference (TYPE) | STRING | 'Toggle_Explanation' | Constant for action "Toggle Explanation" | 20100723 | |
| 12 | GC_CALLER_ACTION_POPUP | Constant | Public | Type reference (TYPE) | STRING | 'Action_Popup' | Constant for workbench as caller of the tool | 20120117 | |
| 13 | GC_CALLER_MASS_CHANGE | Constant | Public | Type reference (TYPE) | STRING | 'Mass_Change' | Constant for Mass Change as caller of the tool | 20100723 | |
| 14 | GC_CALLER_WORKBENCH | Constant | Public | Type reference (TYPE) | STRING | 'Workbench' | Constant for workbench as caller of the tool | 20100722 | |
| 15 | GC_EXTENDED_TOOLBAR_ACTIVE | Constant | Public | Type reference (TYPE) | STRING | 'Extension_Toolbar_Active' | Context parameter: Extension of toolbar is active | 20100723 | |
| 16 | GC_MESSAGE_NAME | Constant | Public | Type reference (TYPE) | STRING | 'Messages' | Constant for messages | 20100723 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | EXTEND_TOOLBAR |
Instance method | Public | Method | Extend a provided toolbar | 20100721 |
| 2 | REACT_ON_ACTION |
Instance method | Public | Method | React on all actions coming from toolbar extension | 20100722 |
Events
Interface IF_FDT_WD_TOOLBAR_EXTENSION has no event.
Types
Interface IF_FDT_WD_TOOLBAR_EXTENSION has no local type.
Method Signatures
Method EXTEND_TOOLBAR Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Exporting |
ET_MESSAGE | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>T_MESSAGE | Messages | 20100722 | ||
| 2 | Exporting |
EV_TOOLBAR_EXTENDED | Call by reference | Type reference (TYPE) | ABAP_BOOL | True: Toolbar was extended | 20100726 | ||
| 3 |  Importing |
IO_VIEW | Call by reference | Object reference (TYPE REF TO) | IF_WD_VIEW | Web Dynpro: API of a View | 20100721 | ||
| 4 | Importing |
IV_ACTION_HANDLER | Call by reference | Type reference (TYPE) | STRING | 'EXECUTE_ACTION' | View action that is called when a toolbar entry is selected | 20100721 | |
| 5 | Importing |
IV_BACK_BUTTON_TEXT | Call by reference | Type reference (TYPE) | STRING | Text for the button 'Back' | 20100727 | ||
| 6 | Importing |
IV_SHOW_BACK_BUTTON | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Show BACK Button | 20120517 | |
| 7 | Importing |
IV_SHOW_IN_POP_UP | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | True: Current WD component is shown in pop up | 20100722 | |
| 8 | Importing |
IV_SHOW_PERSONALIZATION | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_FALSE | True: Current WD component shall show button personalization | 20100722 | |
| 9 | Importing |
IV_TOOLBAR_ID | Call by reference | Type reference (TYPE) | STRING | ID of the toolbar in the view | 20100721 | ||
| 10 | Importing |
IV_WORKBENCH_ATTAINABLY | Call by reference | Type reference (TYPE) | ABAP_BOOL | ABAP_TRUE | Workbench component can be reached | 20100726 |
Method EXTEND_TOOLBAR on Interface IF_FDT_WD_TOOLBAR_EXTENSION has no exception.
Method REACT_ON_ACTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EO_EVENT_UI_CONTEXT | Call by reference | Object reference (TYPE REF TO) | IF_FDT_WD_UI_CONTEXT | Additional parameters for events | 20100722 | ||
| 2 | Exporting |
EV_EVENT_ACTION_NAME | Call by reference | Type reference (TYPE) | STRING | Action name | 20100722 | ||
| 3 | Importing |
IO_WDEVENT | Call by reference | Object reference (TYPE REF TO) | CL_WD_CUSTOM_EVENT | Application-Defined Event | 20100722 | ||
| 4 | Importing |
IT_MESSAGE | Call by reference | Type reference (TYPE) | IF_FDT_TYPES=>T_MESSAGE | Messages | 20100723 |
Method REACT_ON_ACTION on Interface IF_FDT_WD_TOOLBAR_EXTENSION has no exception.
History
| Last changed by/on | SAP | 20130531 |
| SAP Release Created in | 703 |
