Web Dynpro RadioButtonGroupByIndex API - IWDRadioButtonGroupByIndex 

Definition

The RadioButtonGroupByIndex UI element groups multiple radio buttons in a table. Unlike the CheckBoxGroup UI element, this UI element allows the selection of one element only.

The following graphic shows how the UI element is displayed on the user interface:

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 RadioButton UI elements are displayed.

·        readOnly
Specifies whether or not the user can select a radio button within the radio button group.

·        state
Describes the status of the UI element.
The state property can be filled with the following values and is represented by the enumeration type WDState.

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

·        texts
Specifies the path to the context attribute that provides the texts of the radio buttons. The context attribute must be an attribute of a multiple context node which stores the data of der radio buttons. Each node element represents a radio button.

·        width
Determines the width of the UI element that you can specify in CSS sizes, such as em, ex, pixels or percentage values.

Overview of Inherited and Additional Properties

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

Events

·         onSelect
This property contains the action that is executed when the RadioButtonGroupByIndex UI element is selected.

Event Parameter	Type
index	int

See Parameter Mapping.

Data Binding

The context must provide a context node X that can contain 0 to n elements (X.cardinality=0..n). The context node must contain a context attribute y that is of a simple type and provides the texts for the radio buttons. For the data binding, the property texts is bound to the attribute y. Each node element represents a radio button. The selected index is specified by the lead selection of the node X. For further information, refer to Data Binding of a Dropdown List Box and Radio Button Group and Code Examples of Data Binding.

Mobile Characteristics

The UI element RadioButtonGroupByIndex 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
enabled	ignored	ignored
readOnly	ignored	ignored
state	ignored	ignored
tooltip	ignored	ignored

Methods in the Web Dynpro IWDRadioButtonGroupByIndex 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.
getOnSelect		IWDAction	Returns the action that is executed when the onSelect 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.
mappingOfOnSelect		IWDParameterMapping	Returns the parameter mapping for the onSelect action.
setAccessibilityDescription	(String accessibilityDescription)		Sets the value of the accessibilityDescription property.
setColCount	(int colCount)		Sets the value of the colCount property.
setOnSelect	(IWDAction action)		Sets the action that is executed when the onSelect 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 are available using inheritance: IWDUIElement, IWDViewElement.

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