ToolBarToggleButton (SAP Library - Web Dynpro for ABAP)

ToolBarToggleButton

This UI element makes a toggle button available in a ToolBar.

Example of the Visual Display

This graphic is explained in the accompanying text

Note

To enable the development of accessible applications, the tooltip property is checked during the syntax check if the property text has not been set.

Runtime Class

CL_WD_TOOLBAR_TOGGLE_BTN

Properties in the View Designer

Name	Type	Initial Value	Bindable
id	STRING	(automatic)	No
activateAccessKey	WDY_BOOLEAN	false	No
checked	WDY_BOOLEAN	false	Mandatory
checkedImageSource	STRING		Yes
collapsible	WDY_BOOLEAN	false	Yes
contextMenuBehaviour	WDUI_CONTEXT_MENU_BEHAVIOUR	inherit	No
contextMenuId	WDY_MD_UI_ELEMENT_REFERENCE		No
design	WDUI_TOGGLE_BUTTON_DESIGN	standard	Yes
enabled	WDY_BOOLEAN	true	Yes
imageFirst	WDY_BOOLEAN	true	Yes
imageSource	STRING		Yes
text	Translatable text		Yes
textDirection	WDUI_TEXT_DIRECTION	inherit	Yes
tooltip	Translatable text		Yes
visible	WDUI_VISIBILITY	visible	Yes
width	STRING		Yes

Events in the View Designer

Name

onToggle

Note

Other properties that can be inherited are defined in the associated higher-level classes. The associated UI elements are:

● AbstractToggleButton

● AbstractToggle

● UIElement

● ContextMenuProvider

● ViewElement

Dynamic Programming

For dynamic programming, the same properties, events, and aggregations as in the View Designer are available. Bear in mind the different spellings.

Dynamic Programming of Properties

View Designer Name	Runtime Name	Type
activateAccessKey	ACTIVATE_ACCESS_KEY	WDY_BOOLEAN
checked	CHECKED	WDY_BOOLEAN
checkedImageSource	CHECKED_IMAGE_SOURCE	STRING
collapsible	COLLAPSIBLE	WDY_BOOLEAN
contextMenuBehaviour	CONTEXT_MENU_BEHAVIOUR	WDUI_CONTEXT_MENU_BEHAVIOUR
contextMenuBehaviour: inherit	CL_WD_TOOLBAR_TOGGLE_BTN=>E_CONTEXT_MENU_BEHAVIOUR-INHERIT
contextMenuBehaviour: provide	CL_WD_TOOLBAR_TOGGLE_BTN=>E_CONTEXT_MENU_BEHAVIOUR-PROVIDE
contextMenuBehaviour: suppress	CL_WD_TOOLBAR_TOGGLE_BTN=>E_CONTEXT_MENU_BEHAVIOUR-SUPPRESS
contextMenuId	CONTEXT_MENU_ID	WDY_MD_UI_ELEMENT_REFERENCE
design	DESIGN	WDUI_TOGGLE_BUTTON_DESIGN
design: standard	CL_WD_TOOLBAR_TOGGLE_BTN=>E_DESIGN-STANDARD
design: toggle	CL_WD_TOOLBAR_TOGGLE_BTN=>E_DESIGN-TOGGLE
enabled	ENABLED	WDY_BOOLEAN
imageFirst	IMAGE_FIRST	WDY_BOOLEAN
imageSource	IMAGE_SOURCE	STRING
text	TEXT	WDY_MD_TRANSLATABLE_TEXT
textDirection	TEXT_DIRECTION	WDUI_TEXT_DIRECTION
textDirection inherit	CL_WD_TOOLBAR_TOGGLE_BTN=>E_TEXT_DIRECTION-INHERIT
textDirection ltr	CL_WD_TOOLBAR_TOGGLE_BTN=>E_TEXT_DIRECTION-LTR
textDirection rtl	CL_WD_TOOLBAR_TOGGLE_BTN=>E_TEXT_DIRECTION-RTL
tooltip	TOOLTIP	WDY_MD_TRANSLATABLE_TEXT
visible	VISIBLE	WDUI_VISIBILITY
visible: none	CL_WD_TOOLBAR_TOGGLE_BTN=>E_VISIBLE-NONE
visible: visible	CL_WD_TOOLBAR_TOGGLE_BTN=>E_VISIBLE-VISIBLE
width	WIDTH	STRING

Dynamic Programming of Events

View Designer Name	Runtime Name
onToggle	ON_TOGGLE

Example

You can find an example of this UI element in the system in the WDR_TEST_UI_ELEMENTS Web Dynpro application.