Entering content frame

Background documentation CheckBox Locate the document in its SAP Library structure

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

If the properties text and label have not been set, the property tooltip is checked during the design time to ensure Accessibility.

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 Display

This graphic is explained in the accompanying text

Note

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

Runtime Class

CL_WD_CHECKBOX

 

Properties in the View Designer

Name

Type

Initial Value

Bindable

ID

STRING

(automatic)

No

checked

WDY_BOOLEAN

false

mandatory

enabled

WDY_BOOLEAN

true

Yes

explanation

Text

 

No

readOnly

WDY_BOOLEAN

false

Yes

text

Text

 

Yes

textDirection

WDUI_TEXT_DIRECTION

inherit

Yes

tooltip

Text

 

Yes

visible

WDUI_VISIBILITY

visible

Yes

 

Events in the View Designer

Name

onToggle

 

Note

Further properties that can be inherited are defined in the associated higher-level class.  The associated interface elements are:

·         AbstractToggle

·         UIElement

·         ViewElement

Dynamic Programming

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

Dynamic Programming of Properties

View Designer Name

Runtime Name

Type

checked

CHECKED

WDY_BOOLEAN

enabled

ENABLED

WDY_BOOLEAN

explanation

EXPLANATION

WDY_MD_TRANSLATABLE_TEXT

readOnly

READ_ONLY

WDY_BOOLEAN

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.

 

 

 

Leaving content frame