Web Dynpro CheckBoxGroup API - IWDCheckBoxGroup 

Definition

The checkbox group enables the user to select one element from a set of options checking it. The CheckBoxGroup UI element displays the checkboxes as a table.

Display

Description of the 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.

·        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, pixels, 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
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 Parameter	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 texts property 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.

Mobile Characteristics

The UI element CheckBoxGroup supports the development of mobile applications for pocket PCs and BlackBerry wireless handhelds (see Mobile Web Dynpro).

However, several properties supported in the desktop browser cannot be used. These include:

Variances of the properties

Properties	Pocket PC	BlackBerry wireless handheld
readOnly	ignored	ignored
state	ignored	ignored
tooltip	ignored	ignored
enabled	ignored	ignored

Methods in the Web Dynpro IWDCheckBoxGroup API

Method Name	Parameter	Return Value	Description
bindAccessibilityDescription	(String path)		Binds the accessibilityDescription property to the context node specified by a path.
bindColCount	(String path)		Binds the colCount property to the context node specified by a path.
bindingOfAccessibilityDescription		String	Returns the path of the context element to which the accessibilityDescription property is bound. Returns NULL if no binding exists.
bindingOfColCount		String	Returns the path of the context element to which the colCount property is bound. Returns NULL if no binding exists.
bindingOfReadOnly		String	Returns the path of the context element to which the readOnly property is bound. Returns NULL if no binding exists.
bindingOfState		String	Returns the path of the context element to which the state property is bound. Returns NULL if no binding exists.
bindingOfTexts		String	Returns the path of the context element to which the texts property is bound. Returns NULL if no binding exists.
bindingOfWidth		String	Returns the path of the context element to which the width property is bound. Returns NULL if no binding exists.
bindReadOnly	(String path)		Binds the readOnly property to the context node specified by a path.
bindState	(String path)		Binds the state property to the context node specified by a path.
bindTexts	(String path)		Binds the texts property to the context node specified by a path.
bindWidth	(String path)		Binds the value of the width property to the context element specified by the path.
getAccessibilityDescription		String	Returns the value of the accessibilityDescription property.
getColCount		int	Returns the value of the colCount property.
getOnToggle		IWDAction	Returns the action that is executed when the onToggle event is triggered.
getReadOnly		boolean	Returns the value of the readOnly property.
getState		WDState	Returns the value of the state property.
getWidth		String	Returns the value of the width property.
mappingOfOnToggle		IWDParameterMapping	Returns the parameter mapping for the onToggle action.
setAccessibilityDescription	(String accessibilityDescription)		Sets the value of the accessibilityDescription property.
setColCount	(int colCount)		Sets the value of the colCount property.
setOnToggle	(IWDAction action)		Sets the action that is executed when the onToggle event is triggered.
setReadOnly	(boolean value)		Sets the value of the readOnly property.
setState	(WDState state)		Sets the value of the state property.
setWidth	(String width)		Sets the value of the width property.

 

Additional methods described in the following APIs are available using inheritance: IWDUIElement, IWDViewElement.

For detailed documentation of all inherited methods, see the documentation for the relevant APIs.