SAP CL_GUI_TOOLBAR OO Class - Toolbar Control
CL_GUI_TOOLBAR is a standard SAP object class available within R/3 SAP systems depending on your version and release level. You can view/maintain the class details by entering its name into the relevant SAP transactions such as SE24, SE80 or even SE84. Below is the documentation available for class CL_GUI_TOOLBAR including details of:
- Interface class implementations
- Inheritance details
- Methods defined within class ( including link to full details )
- Attributes ( including initial values )
- Class Events
Inheritance
This OO class has a superclass assigned to it, which means it will inherit its objects and methods. The superclass for CL_GUI_TOOLBAR is CL_GUI_CONTROLMethod list of CL_GUI_TOOLBAR SAP class
A method is a coding block that performs a certain procedure (i.e. ABAP functionality) on an object within the overall SAP class. In simple terms if the object is an SAP database table a method could be the procedure to add a record or to delete a record. If you are new to OO in many respects, the implementation of a method is similar to a function module and can be called in a very similar way using CALL METHOD.
Instead of "CALL FUNCTION", Methods are referenced using the following syntax: CALL METHOD =>methodname EXPORTING/IMPORTING...
| Method Name | Description | Visability |
| ADD_BUTTON | Adds a New Pushbutton | Public |
| CALL METHOD cl_gui_toolbar=>ADD_BUTTON...more details | ||
| ADD_BUTTON_GROUP | Adds a List of Pushbuttons | Public |
| CALL METHOD cl_gui_toolbar=>ADD_BUTTON_GROUP...more details | ||
| ASSIGN_STATIC_CTXMENU_TABLE | Sets the Static Context Menus for Several Pushbuttons | Public |
| CALL METHOD cl_gui_toolbar=>ASSIGN_STATIC_CTXMENU_TABLE...more details | ||
| CHECK_UNIQUE_FCODE | Checks if an F Code is Already Available in m_table_button | Private |
| CALL METHOD cl_gui_toolbar=>CHECK_UNIQUE_FCODE...more details | ||
| CONSTRUCTOR | Constructor | Public |
| CALL METHOD cl_gui_toolbar=>CONSTRUCTOR...more details | ||
| DELETE_ALL_BUTTONS | Deletes all Pushbuttons | Public |
| CALL METHOD cl_gui_toolbar=>DELETE_ALL_BUTTONS...more details | ||
|
| ||
| DELETE_BUTTON | Deletes a Pushbutton | Public |
| CALL METHOD cl_gui_toolbar=>DELETE_BUTTON...more details | ||
| FILL_BUTTONS_DATA_TABLE | Fills the Table for Creating Several Pushbuttons | Public |
| CALL METHOD cl_gui_toolbar=>FILL_BUTTONS_DATA_TABLE...more details | ||
| ON_CTXMENU_CHANGED | Event Handler for Context Menu | Private |
| CALL METHOD cl_gui_toolbar=>ON_CTXMENU_CHANGED...more details | ||
| SET_BUTTON_INFO | Sets the Information for Changing Icon, Text or Tooltip | Public |
| CALL METHOD cl_gui_toolbar=>SET_BUTTON_INFO...more details | ||
| SET_BUTTON_STATE | Sets the State of a Single Pushbutton | Public |
| CALL METHOD cl_gui_toolbar=>SET_BUTTON_STATE...more details | ||
| SET_BUTTON_VISIBLE | Sets the State of a Single Pushbutton | Public |
| CALL METHOD cl_gui_toolbar=>SET_BUTTON_VISIBLE...more details | ||
| SET_STATIC_CTXMENU | Sets the Static Context Menu for a Pushbutton | Public |
| CALL METHOD cl_gui_toolbar=>SET_STATIC_CTXMENU...more details | ||
| SET_WEBGUI_MENU_LOCAL_RELOAD | WEBGUI: Dynamic Menu Loaded Locally | Public |
| CALL METHOD cl_gui_toolbar=>SET_WEBGUI_MENU_LOCAL_RELOAD...more details | ||
| TRACK_CONTEXT_MENU | Displays a Context Menu | Public |
| CALL METHOD cl_gui_toolbar=>TRACK_CONTEXT_MENU...more details | ||
| UPDATE_TABLE_BUTTON | Updates the Configuration Table of the Pushbuttons | Private |
| CALL METHOD cl_gui_toolbar=>UPDATE_TABLE_BUTTON...more details | ||
| UPDATE_TABLE_CTXMENU | Updates the Table of the Static Context Menu | Private |
| CALL METHOD cl_gui_toolbar=>UPDATE_TABLE_CTXMENU...more details | ||
CL_GUI_TOOLBAR attributes
List of attributes within class CL_ABAP_CHAR_UTILITIES. These can be referenced using the following syntax CL_ABAP_CHAR_UTILITIES=>. Although depending on where you are inserting the ABAP code you do need to check if the attribute is public or private.
| Name | Level | Description | Initial Value | Type | Visability |
| M_CHECKED | Instance Attribute | Button state | 1 | LIKE I | Private |
| M_ENABLED | Instance Attribute | Button state | 1 | LIKE I | Private |
| M_FCODE | Instance Attribute | Function Code | LIKE UI_FUNC | Private | |
| M_ID_DROPDOWN_CLICKED | Constant | Event ID | 2 | LIKE I | Public |
| M_ID_DROPMENU_CLICKED | Instance Attribute | Event ID | 3 | LIKE I | Public |
| M_ID_FUNCTION_SELECTED | Constant | Event ID | 1 | LIKE I | Public |
| M_MODE_HORIZONTAL | Constant | Horizontal Display | 0 | LIKE I | Public |
| M_MODE_VERTICAL | Constant | Horizontal Display | 1 | LIKE I | Public |
| M_POSX | Instance Attribute | Coordinate X | LIKE I | Private | |
| M_POSY | Instance Attribute | Coordinate Y | LIKE I | Private | |
| M_RESULT | Instance Attribute | Return Value | LIKE I | Public | |
| M_SEPARATOR_ID | Instance Attribute | Separator ID | 0 | LIKE CNTB_UNIQUE_ID | Private |
| M_TABLE_BUTTON | Instance Attribute | Assignment of Pushbuttons | LIKE TTB_BUTTON | Public | |
| M_TABLE_CTXMENU | Instance Attribute | Assignment of Static Context Menu | LIKE TTB_BTNMNU | Public | |
| M_VERSION | Instance Attribute | Version number | 0 | LIKE I | Public |
| M_VISIBLE | Instance Attribute | Visibility | 1 | LIKE I | Private |
| M_WRAPABLE | Instance Attribute | Style | 1 | LIKE I | Private |
Events of Class CL_GUI_TOOLBAR
Events are created within your class using special event handler methods. These must be registered at runtime for the event and can then be triggered using the ABAP syntax: RAISE EVENT EXPOTING... DROPDOWN_CLICKED - if a Dropdown or Menu Pushbutton is ClickedFUNCTION_SELECTED - if a Pushbutton or a Menu Entry is Selected
Links to Related Class(s)
CL_GUI_T...Full list of available SAP object classes
Search for further information about these or an SAP related objects