RadioButton is a control similar to CheckBox, but it allows the user to choose only one of the predefined set of options.
Usually, RadioButton is used in a group with other RadioButtons (with the groupName property or by using sap.ui.commons.RadioButtonGroup), thus providing a limited choice for the user. An event is triggered when the user makes a change of the selection.
Deprecated API:Since version 1.38. Instead, use the sap.m.RadioButton control.
Event Summary
select(oControlEvent)Triggers when the user makes a change on the RadioButton. Method Summary
sap.ui.commons.RadioButton.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.commons.RadioButton with name sClassName and enriches it with the information contained in oClassInfo. addAriaDescribedBy(vAriaDescribedBy)Adds some ariaDescribedBy into the association ariaDescribedBy. addAriaLabelledBy(vAriaLabelledBy)Adds some ariaLabelledBy into the association ariaLabelledBy. attachSelect(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the select event of this sap.ui.commons.RadioButton. detachSelect(fnFunction, oListener)Detaches event handler fnFunction from the select event of this sap.ui.commons.RadioButton. fireSelect(mArguments?)Fires event select to attached listeners. getAriaDescribedBy()Returns array of IDs of the elements which are the current targets of the association ariaDescribedBy. getAriaLabelledBy()Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy. getEnabled()Gets current value of property enabled. getKey()Gets current value of property key. getText()Gets current value of property text. getWidth()Gets current value of property width. removeAriaDescribedBy(vAriaDescribedBy)Removes an ariaDescribedBy from the association named ariaDescribedBy. removeAriaLabelledBy(vAriaLabelledBy)Removes an ariaLabelledBy from the association named ariaLabelledBy. setEditable(bEditable)Sets a new value for property editable. setEnabled(bEnabled)Sets a new value for property enabled. setGroupName(sGroupName)Sets a new value for property groupName. setKey(sKey)Sets a new value for property key. setSelected(bSelected)Sets a new value for property selected. setText(sText)Sets a new value for property text. setValueState(sValueState)Sets a new value for property valueState. setWidth(sWidth)Sets a new value for property width. addStyleClass,
allowTextSelection,
attachBrowserEvent,
attachValidateFieldGroup,
checkFieldGroupIds,
clone,
detachBrowserEvent,
detachValidateFieldGroup,
fireValidateFieldGroup,
getAccessibilityInfo,
getBusy,
getBusyIndicatorDelay,
getControlsByFieldGroupId,
getFieldGroupIds,
getIdForLabel,
getRenderer,
getVisible,
hasStyleClass,
invalidate,
isBusy,
onAfterRendering,
onBeforeRendering,
placeAt,
removeStyleClass,
rerender,
setBusy,
setBusyIndicatorDelay,
setFieldGroupIds,
setVisible,
toggleStyleClass,
triggerValidateFieldGroup $,
addCustomData,
addDependent,
addEventDelegate,
applyFocusInfo,
bindElement,
data,
destroy,
destroyCustomData,
destroyDependents,
destroyLayoutData,
destroyTooltip,
enhanceAccessibilityState,
exit,
findElements,
fireEvent,
focus,
getCustomData,
getDependents,
getDomRef,
getElementBinding,
getFocusDomRef,
getFocusInfo,
getInterface,
getLayoutData,
getMetadata,
getTooltip,
getTooltip_AsString,
getTooltip_Text,
indexOfCustomData,
indexOfDependent,
init,
insertCustomData,
insertDependent,
prop,
removeAllCustomData,
removeAllDependents,
removeCustomData,
removeDependent,
removeEventDelegate,
setLayoutData,
setTooltip,
toString,
unbindElement addAggregation,
addAssociation,
applySettings,
attachFormatError,
attachModelContextChange,
attachParseError,
attachValidationError,
attachValidationSuccess,
bindAggregation,
bindContext,
bindObject,
bindProperty,
destroyAggregation,
detachFormatError,
detachModelContextChange,
detachParseError,
detachValidationError,
detachValidationSuccess,
findAggregatedObjects,
fireFormatError,
fireModelContextChange,
fireParseError,
fireValidationError,
fireValidationSuccess,
getAggregation,
getAssociation,
getBinding,
getBindingContext,
getBindingInfo,
getBindingPath,
getEventingParent,
getId,
getModel,
getObjectBinding,
getOriginInfo,
getParent,
getProperty,
hasModel,
indexOfAggregation,
insertAggregation,
isBound,
isInvalidateSuppressed,
isTreeBinding,
propagateMessages,
removeAggregation,
removeAllAggregation,
removeAllAssociation,
removeAssociation,
setAggregation,
setAssociation,
setBindingContext,
setModel,
setProperty,
unbindAggregation,
unbindContext,
unbindObject,
unbindProperty,
validateAggregation,
validateProperty Constructor Detail
new sap.ui.commons.RadioButton(sId?, mSettings?)
Constructor for a new RadioButton.
Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject for a general description of the syntax of the settings object.
The supported settings are:
- Properties
- Events
- select : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]
In addition, all settings applicable to the base type sap.ui.core.Control can be used as well.
Parameters:
| {string} | sId? | ID for the new control, generated automatically if no ID is given |
| {object} | mSettings? | Initial settings for the new control |
- Deprecated:
- Since version 1.38. Instead, use the
sap.m.RadioButton control.
Event Detail
select(oControlEvent)
Triggers when the user makes a change on the RadioButton.
Parameters:
Method Detail
sap.ui.commons.RadioButton.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.commons.RadioButton with name
sClassName and enriches it with the information contained in
oClassInfo.
oClassInfo might contain the same kind of information as described in sap.ui.core.Control.extend.
Parameters:
| {string} | sClassName | Name of the class being created |
| {object} | oClassInfo? | Object literal with information about the class |
| {function} | FNMetaImpl? | Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata |
Returns:
| {function} | Created class / constructor function |
Returns a metadata object for class sap.ui.commons.RadioButton.
Returns:
Adds some ariaDescribedBy into the association ariaDescribedBy.
Parameters:
| {string|sap.ui.core.Control} | vAriaDescribedBy | the ariaDescribedBy to add; if empty, nothing is inserted |
Returns:
Adds some ariaLabelledBy into the association ariaLabelledBy.
Parameters:
| {string|sap.ui.core.Control} | vAriaLabelledBy | the ariaLabelledBy to add; if empty, nothing is inserted |
Returns:
Attaches event handler
fnFunction to the
select event of this
sap.ui.commons.RadioButton.
When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.commons.RadioButton itself.
Triggers when the user makes a change on the RadioButton.
Parameters:
| {object} | oData? | An application-specific payload object that will be passed to the event handler along with the event object when firing the event |
| {function} | fnFunction | The function to be called when the event occurs |
| {object} | oListener? | Context object to call the event handler with. Defaults to this sap.ui.commons.RadioButton itself |
Returns:
Detaches event handler
fnFunction from the
select event of this
sap.ui.commons.RadioButton.
The passed function and listener object must match the ones used for event registration.
Parameters:
| {function} | fnFunction | The function to be called, when the event occurs |
| {object} | oListener | Context object on which the given function had to be called |
Returns:
Fires event select to attached listeners.
Parameters:
| {Map} | mArguments? | The arguments to pass along with the event |
Returns:
Returns array of IDs of the elements which are the current targets of the association ariaDescribedBy.
Returns:
Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.
Returns:
getEditable(): boolean
Gets current value of property
editable.
Specifies whether the user can select the RadioButton.
Default value is true.
Returns:
| {boolean} | Value of property editable |
getEnabled(): boolean
Gets current value of property
enabled.
Displays the disabled controls in another color, depending on the customer settings.
Default value is true.
Returns:
| {boolean} | Value of property enabled |
getGroupName(): string
Gets current value of property
groupName.
Defines the name of the RadioButtonGroup, in which the current RadioButton belongs to. You can define a new name for the group. If no new name is specified, the default is sapUiRbDefaultGroup. By default, when one of the RadioButtons in a group is selected, all others are unselected.
Default value is sapUiRbDefaultGroup.
Returns:
| {string} | Value of property groupName |
getKey(): string
Gets current value of property
key.
Can be used for subsequent actions.
Returns:
| {string} | Value of property key |
getSelected(): boolean
Gets current value of property
selected.
Specifies the select state of the RadioButton.
Default value is false.
Returns:
| {boolean} | Value of property selected |
getText(): string
Gets current value of property
text.
Defines the text displayed next to the RadioButton.
Returns:
| {string} | Value of property text |
Gets current value of property
textDirection.
Defines the text direction - options are left-to-right (LTR) and right-to-left (RTL). Alternatively, the control can inherit the text direction from its parent container.
Default value is Inherit.
Returns:
Gets current value of property
valueState.
Enumeration sap.ui.core.ValueState provides state values Error, Success, Warning and None.
Default value is None.
Returns:
Gets current value of property
width.
Determines the control width. By default, it depends on the text length. Alternatively, CSS sizes in % or px can be set.
Returns:
Removes all the controls in the association named ariaDescribedBy.
Returns:
Removes all the controls in the association named ariaLabelledBy.
Returns:
Removes an ariaDescribedBy from the association named ariaDescribedBy.
Parameters:
| {int|string|sap.ui.core.Control} | vAriaDescribedBy | The ariaDescribedByto be removed or its index or ID |
Returns:
Removes an ariaLabelledBy from the association named ariaLabelledBy.
Parameters:
| {int|string|sap.ui.core.Control} | vAriaLabelledBy | The ariaLabelledByto be removed or its index or ID |
Returns:
Sets a new value for property
editable.
Specifies whether the user can select the RadioButton.
When called with a value of null or undefined, the default value of the property will be restored.
Default value is true.
Parameters:
| {boolean} | bEditable | New value for property editable |
Returns:
Sets a new value for property
enabled.
Displays the disabled controls in another color, depending on the customer settings.
When called with a value of null or undefined, the default value of the property will be restored.
Default value is true.
Parameters:
| {boolean} | bEnabled | New value for property enabled |
Returns:
Sets a new value for property
groupName.
Defines the name of the RadioButtonGroup, in which the current RadioButton belongs to. You can define a new name for the group. If no new name is specified, the default is sapUiRbDefaultGroup. By default, when one of the RadioButtons in a group is selected, all others are unselected.
When called with a value of null or undefined, the default value of the property will be restored.
Default value is sapUiRbDefaultGroup.
Parameters:
| {string} | sGroupName | New value for property groupName |
Returns:
Sets a new value for property
key.
Can be used for subsequent actions.
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
| {string} | sKey | New value for property key |
Returns:
Sets a new value for property
selected.
Specifies the select state of the RadioButton.
When called with a value of null or undefined, the default value of the property will be restored.
Default value is false.
Parameters:
| {boolean} | bSelected | New value for property selected |
Returns:
Sets a new value for property
text.
Defines the text displayed next to the RadioButton.
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
| {string} | sText | New value for property text |
Returns:
Sets a new value for property
textDirection.
Defines the text direction - options are left-to-right (LTR) and right-to-left (RTL). Alternatively, the control can inherit the text direction from its parent container.
When called with a value of null or undefined, the default value of the property will be restored.
Default value is Inherit.
Parameters:
Returns:
Sets a new value for property
valueState.
Enumeration sap.ui.core.ValueState provides state values Error, Success, Warning and None.
When called with a value of null or undefined, the default value of the property will be restored.
Default value is None.
Parameters:
Returns:
Sets a new value for property
width.
Determines the control width. By default, it depends on the text length. Alternatively, CSS sizes in % or px can be set.
When called with a value of null or undefined, the default value of the property will be restored.
Parameters:
Returns: