CheckBoxGroup API 

Definition

The checkbox group enables the user to select one element from a set of options checking it. The CheckBoxGroup UI element lists the checkboxes as a table. As opposed to the RadioButtonGroup, you can check multiple fields.

Visual Display

Description of UI Element Properties

·        accessibilityDescription
When accessibility is activated, the assigned text is added to the tooltip. This description provides semantic details of the UI element and is only read by the screen reader if the user focuses the complete Ul element.

·        colCount
Specifies the number of columns in which the CheckBox elements are grouped.

·        readOnly
Specifies whether or not the user can check the checkbox in the checkbox group.

·        state
Describes the status of the UI element. The data type of this property corresponds to the enumeration type WDErrorState. 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.

·        textDirection
Specifies the text direction and allows you to use a checkbox group for texts in languages which require a specific text direction. The textDirection property can be filled with 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.

·        texts
Specifies the path of the context attribute within a context node whose node elements provide the texts of the individual checkboxes at runtime.

·        width
Specifies the minimum width of the CheckBoxGroup UI element. You can specify the width in CSS units like em, ex, pixel, or percentage.

Overview of Inherited and Additional Properties

Name	Interface	Type	Initial Value	Bindable	Value Required
accessibilityDescription	IWDCheckBoxGroup	String (TranslatableText)		bindable	No
enabled	IWDUIElement	boolean	true	bindable	No
colCount	IWDCheckBoxGroup	int	1	bindable	No
readOnly	IWDCheckBoxGroup	boolean	false	bindable	No
state	IWDCheckBoxGroup	WDState	normal	bindable	No
textDirection	IWDCheckBoxGroup	WDTextDirection	inherit	bindable	No
texts	IWDCheckBoxGroup	String (TranslatableText)		bindable_mandatory	Yes
tooltip	IWDUIElement	String (TranslatableText)		bindable	No
visible	IWDUIElement	WDVisibility	visible	bindable	No
width	IWDCheckBoxGroup	String		bindable	No

Events

·        onToggle
Describes the action that is executed when the user checks a checkbox in the CheckBox group.

Event parameters	Type	Description
checked	boolean	The new value of the checkbox.
index	int	Index (0..n) of the selected checkbox.

See Parameter Mapping.

Data Binding

A checkbox group is a multiple selection displayed as a group of checkboxes on the screen.

The view context must provide the node X that can contain 0 to n values (X.cardinality=0..n). The context node must contain an attribute y that provides the texts for the checkbox fields. The data type of the context attribute y can be any simple data type – for example, String, int, and so on. The number of checkboxes equals the number of node elements. The selection of the checkboxes is determined by the multiple selection of the node. The textsproperty of the CheckBoxGroup UI element is bound to the attribute y by assigning the context path of the context y to the texts property.

For further information about the context structures, refer to Context Description; for information about the data binding model, refer to Data Binding Within Web Dynpro.