CheckBox (SAP Library - Web Dynpro for ABAP)

CheckBox

With a CheckBox, you can implement a single on/off switch. A checkbox enables the user to select a Boolean value (TRUE/FALSE). The UI element consists of a graphic with text. The checkmark in the box indicates that the option is selected and the value is set to TRUE.

Note

To enable the development of accessible applications, the tooltip property is checked during the syntax check if the text and label properties are not set.

A tooltip does not necessarily have to be set for this UI element, but it could make sense to set it if it contains detailed semantic information.

Example of the Visual Display

This graphic is explained in the accompanying text

Note

If you want to offer a group of logically related checkboxes, use the CheckBoxGroup UI element.

Runtime Class

CL_WD_CHECKBOX

Properties in View Designer

Name	Type	Initial Value	Bindable
ID	STRING	(automatic)	No
activateAccessKey	WDY_BOOLEAN	false	No
checked	WDY_BOOLEAN	false	Mandatory
contextMenuBehaviour	WDUI_CONTEXT_MENU_BEHAVIOUR	inherit	No
contextMenuId	WDY_MD_UI_ELEMENT_REFERENCE		No
enabled	WDY_BOOLEAN	true	Yes
explanation	Translatable text		No
readOnly	WDY_BOOLEAN	false	Yes
state	WDUI_STATE	normal	Yes
text	Translatable text		Yes
textDirection	WDUI_TEXT_DIRECTION	inherit	Yes
tooltip	Translatable text		Yes
visible	WDUI_VISIBILITY	visible	Yes

Events in View Designer

Name

onToggle

Note

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

● 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
contextMenuBehaviour	CONTEXT_MENU_BEHAVIOUR	WDUI_CONTEXT_MENU_BEHAVIOUR
contextMenuBehaviour: inherit	CL_WD_CHECKBOX=>E_CONTEXT_MENU_BEHAVIOUR-INHERIT
contextMenuBehaviour: provide	CL_WD_CHECKBOX=>E_CONTEXT_MENU_BEHAVIOUR-PROVIDE
contextMenuBehaviour: suppress	CL_WD_CHECKBOX=>E_CONTEXT_MENU_BEHAVIOUR-SUPPRESS
contextMenuId	CONTEXT_MENU_ID	WDY_MD_UI_ELEMENT_REFERENCE
enabled	ENABLED	WDY_BOOLEAN
explanation	EXPLANATION	WDY_MD_TRANSLATABLE_TEXT
readOnly	READ_ONLY	WDY_BOOLEAN
state	STATE	WDUI_STATE
state: normal	CL_WD_CHECKBOX=>E_STATE-NORMAL
state: required	CL_WD_CHECKBOX=>E_STATE-REQUIRED
text	TEXT	WDY_MD_TRANSLATABLE_TEXT
textDirection	TEXT_DIRECTION	WDUI_TEXT_DIRECTION
textDirection inherit	CL_WD_CHECKBOX=>E_TEXT_DIRECTION-INHERIT
textDirection ltr	CL_WD_CHECKBOX=>E_TEXT_DIRECTION-LTR
textDirection rtl	CL_WD_CHECKBOX=>E_TEXT_DIRECTION-RTL
tooltip	TOOLTIP	WDY_MD_TRANSLATABLE_TEXT
visible	VISIBLE	WDUI_VISIBILITY
visible: none	CL_WD_CHECKBOX=>E_VISIBLE-NONE
visible: visible	CL_WD_CHECKBOX=>E_VISIBLE-VISIBLE

Dynamic Programming of Events

View Designer Name	Runtime Name
onToggle	ON_TOGGLE

Example

You can find examples of this interface element in the system in the Web Dynpro application WDR_TEST_UI_ELEMENTS, and in the component WDR_TEST_EVENTS in the view checkbox.