CheckBox  

The 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.

Definition

The Web Dynpro class Checkbox which implements the IWDCheckBox interface is the base class of checkboxes.

Description of UI Element Properties

●      activateAccessKey

Indicates whether access key for this control is activated.

More information: Enabling Access Keys

●      checked

Specifies whether or not a checkbox is selected. The Boolean value true indicates that the option is selected. A checkmark appears in the graphic that is displayed on the screen.

Short Description	Visual Display
The checkbox UI element that is displayed with the value true.
The checkbox UI element that is displayed with the value false.

●      explanation

specifies the explanation text. More information: Explanation

●      readOnly

Specifies whether or not the user can check the checkbox.

●      state

Describes the error status of the UI element. The data type of this property corresponds to the enumeration type WDState. You can use the following values in the application:

normal	Describes the default state of the UI element.
required	Specifies whether the entered value is required.

●      text

Specifies the text that is associated with the checkbox graphic and displayed to the right of the box.

●      textDirection

Specifies the text direction and allows you to use a checkBox for texts in languages which require a specific text direction. The textDirection property can take the following values and is represented by the enumeration type WDTextDirection.

inherit	The text direction is inherited from the parent element. Therefore, the text direction is identical to the one of the parent element.
ltr	The text runs from left to right.
rtl	The text runs from right to left.

The default value for this property is inherit.

Properties Overview

Name	Interface	Type	Initial Value	Bindable
activateAccessKey	IWDAbstractToggle	boolean	false	not bindable
checked	IWDAbstractToggle	boolean	false	bindable_mandatory
enabled	IWDUIElement	boolean	true	bindable
explanation	IWDCheckBox	String		not_bindable
readOnly	IWDCheckBox	boolean	false	bindable
state	IWDCheckBox	WDState	normal	bindable
text	IWDAbstractToggle	String (TranslatableText)		bindable
textDirection	IWDAbstractToggle	WDTextDirection	inherit	bindable
tooltip	IWDUIElement	String (TranslatableText)		bindable
visible	IWDUIElement	WDVisibility	visible	bindable

Events

●      onToggle (boolean checked)

The onToggle event is triggered when the user clicks the CheckBox. The parameter is the new status.