Class sap.m.RadioButtonModule: sap/m/RadioButton

extends Control

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.m.RadioButtonGroup), thus providing a limited choice for the user. An event is triggered when the user makes a change of the selection.

Constructor Summary
new sap.m.RadioButton(sId?, mSettings?)Constructor for a new RadioButton.
Event Summary
select(oControlEvent)Event is triggered when the user makes a change on the radio button (selecting or unselecting it).
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.m.RadioButton.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.m.RadioButton with name sClassName and enriches it with the information contained in oClassInfo.
sap.m.RadioButton.getMetadata()Returns a metadata object for class sap.m.RadioButton.
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.m.RadioButton.
detachSelect(fnFunction, oListener)Detaches event handler fnFunction from the select event of this sap.m.RadioButton.
exit()Destroys all related objects to the RadioButton
fireSelect(mArguments?)Fires event select to attached listeners.
getActiveHandling()Gets current value of property activeHandling.
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.
getEditable()Gets current value of property editable.
getEnabled()Gets current value of property enabled.
getGroupName()Gets current value of property groupName.
getSelected()Gets current value of property selected.
getText()Gets current value of property text.
getTextAlign()Gets current value of property textAlign.
getTextDirection()Gets current value of property textDirection.
getValueState()Gets current value of property valueState.
getWidth()Gets current value of property width.
onsapselect(oEvent)Pseudo event for pseudo 'select' event.
removeAllAriaDescribedBy()Removes all the controls in the association named ariaDescribedBy.
removeAllAriaLabelledBy()Removes all the controls in the association named ariaLabelledBy.
removeAriaDescribedBy(vAriaDescribedBy)Removes an ariaDescribedBy from the association named ariaDescribedBy.
removeAriaLabelledBy(vAriaLabelledBy)Removes an ariaLabelledBy from the association named ariaLabelledBy.
setActiveHandling(bActiveHandling)Sets a new value for property activeHandling.
setActiveState(bActive)Method to set a RadioButton's state to active or inactive.
setEditable(bEditable)Sets a new value for property editable.
setEnabled(bEnabled)Sets a new value for property enabled.
setGroupName(sGroupName)Sets RadioButton's groupName.
setSelected(bSelected)Sets the state of the RadioButton to selected.
setText(sText)Sets the text for the RadioButton's label.
setTextAlign(sTextAlign)Sets a new value for property textAlign.
setTextDirection(sDirection)Sets the text direction for the RadioButton's label.
setValueState(sValueState)Sets a new value for property valueState.
setWidth(sWidth)Sets the width for the RadioButton's label.
Methods borrowed from class sap.ui.core.Control
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
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, 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
Methods borrowed from class sap.ui.base.ManagedObject
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
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.m.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
Event Detail
select(oControlEvent)
Event is triggered when the user makes a change on the radio button (selecting or unselecting it).
Parameters:
{sap.ui.base.Event}oControlEvent
{sap.ui.base.EventProvider}oControlEvent.getSource
{object}oControlEvent.getParameters
{boolean}oControlEvent.getParameters.selected Checks whether the RadioButton is active or not.
Method Detail
sap.m.RadioButton.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.m.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
sap.m.RadioButton.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.m.RadioButton.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
addAriaDescribedBy(vAriaDescribedBy): sap.m.RadioButton
Adds some ariaDescribedBy into the association ariaDescribedBy.
Parameters:
{string|sap.ui.core.Control}vAriaDescribedBy the ariaDescribedBy to add; if empty, nothing is inserted
Returns:
{sap.m.RadioButton} Reference to this in order to allow method chaining
addAriaLabelledBy(vAriaLabelledBy): sap.m.RadioButton
Adds some ariaLabelledBy into the association ariaLabelledBy.
Parameters:
{string|sap.ui.core.Control}vAriaLabelledBy the ariaLabelledBy to add; if empty, nothing is inserted
Returns:
{sap.m.RadioButton} Reference to this in order to allow method chaining
attachSelect(oData?, fnFunction, oListener?): sap.m.RadioButton
Attaches event handler fnFunction to the select event of this sap.m.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.m.RadioButton itself.

Event is triggered when the user makes a change on the radio button (selecting or unselecting it).

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.m.RadioButton itself
Returns:
{sap.m.RadioButton} Reference to this in order to allow method chaining
detachSelect(fnFunction, oListener): sap.m.RadioButton
Detaches event handler fnFunction from the select event of this sap.m.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:
{sap.m.RadioButton} Reference to this in order to allow method chaining
exit()
Destroys all related objects to the RadioButton
fireSelect(mArguments?): sap.m.RadioButton
Fires event select to attached listeners.

Expects the following event parameters:

  • selected of type booleanChecks whether the RadioButton is active or not.
Parameters:
{Map}mArguments? The arguments to pass along with the event
Returns:
{sap.m.RadioButton} Reference to this in order to allow method chaining
getActiveHandling(): boolean
Gets current value of property activeHandling.

This is a flag to switch on activeHandling. When it is switched off, there will not be visual changes on active state. Default value is 'true'

Default value is true.

Returns:
{boolean} Value of property activeHandling
getAriaDescribedBy(): sap.ui.core.Control[]
Returns array of IDs of the elements which are the current targets of the association ariaDescribedBy.
Returns:
{sap.ui.core.Control[]}
getAriaLabelledBy(): sap.ui.core.Control[]
Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.
Returns:
{sap.ui.core.Control[]}
getEditable(): boolean
Gets current value of property editable.

Specifies whether the user can select the radio button.

Default value is true.

Since:
1.25
Returns:
{boolean} Value of property editable
getEnabled(): boolean
Gets current value of property enabled.

Specifies if the radio button is disabled.

Default value is true.

Returns:
{boolean} Value of property enabled
getGroupName(): string
Gets current value of property groupName.

Name of the radio button group the current radio button belongs to. You can define a new name for the group. If no new name is specified, this radio button belongs to the sapMRbDefaultGroup per default. Default behavior of a radio button in a group is that when one of the radio buttons in a group is selected, all others are unselected.

Default value is sapMRbDefaultGroup.

Returns:
{string} Value of property groupName
getSelected(): boolean
Gets current value of property selected.

Specifies the select state of the radio button

Default value is false.

Returns:
{boolean} Value of property selected
getText(): string
Gets current value of property text.

Specifies the text displayed next to the RadioButton

Returns:
{string} Value of property text
getTextAlign(): sap.ui.core.TextAlign
Gets current value of property textAlign.

Specifies the alignment of the radio button. Available alignment settings are "Begin", "Center", "End", "Left", and "Right".

Default value is Begin.

Since:
1.28
Returns:
{sap.ui.core.TextAlign} Value of property textAlign
getTextDirection(): sap.ui.core.TextDirection
Gets current value of property textDirection.

Options for the text direction are RTL and LTR. Alternatively, the control can inherit the text direction from its parent container.

Default value is Inherit.

Returns:
{sap.ui.core.TextDirection} Value of property textDirection
getValueState(): sap.ui.core.ValueState
Gets current value of property valueState.

Enumeration sap.ui.core.ValueState provides state values Error, Success, Warning, None

Default value is None.

Since:
1.25
Returns:
{sap.ui.core.ValueState} Value of property valueState
getWidth(): sap.ui.core.CSSSize
Gets current value of property width.

Width of the Label

Default value is .

Returns:
{sap.ui.core.CSSSize} Value of property width
onsapselect(oEvent)
Pseudo event for pseudo 'select' event... space, enter, ... without modifiers (Ctrl, Alt or Shift)
Parameters:
{object}oEvent provides information for the event
removeAllAriaDescribedBy(): sap.ui.core.Control[]
Removes all the controls in the association named ariaDescribedBy.
Returns:
{sap.ui.core.Control[]} An array of the removed elements (might be empty)
removeAllAriaLabelledBy(): sap.ui.core.Control[]
Removes all the controls in the association named ariaLabelledBy.
Returns:
{sap.ui.core.Control[]} An array of the removed elements (might be empty)
removeAriaDescribedBy(vAriaDescribedBy): sap.ui.core.Control
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:
{sap.ui.core.Control} the removed ariaDescribedBy or null
removeAriaLabelledBy(vAriaLabelledBy): sap.ui.core.Control
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:
{sap.ui.core.Control} the removed ariaLabelledBy or null
setActiveHandling(bActiveHandling): sap.m.RadioButton
Sets a new value for property activeHandling.

This is a flag to switch on activeHandling. When it is switched off, there will not be visual changes on active state. Default value is 'true'

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:
{boolean}bActiveHandling New value for property activeHandling
Returns:
{sap.m.RadioButton} Reference to this in order to allow method chaining
setActiveState(bActive): void
Method to set a RadioButton's state to active or inactive.
Parameters:
{boolean}bActive Sets the active state to true or false
setEditable(bEditable): sap.m.RadioButton
Sets a new value for property editable.

Specifies whether the user can select the radio button.

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
Since:
1.25
Returns:
{sap.m.RadioButton} Reference to this in order to allow method chaining
setEnabled(bEnabled): sap.m.RadioButton
Sets a new value for property enabled.

Specifies if the radio button is disabled.

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:
{sap.m.RadioButton} Reference to this in order to allow method chaining
setGroupName(sGroupName): sap.m.RadioButton
Sets RadioButton's groupName. Only one radioButton from the same group can be selected
Parameters:
{string}sGroupName Name of the group to which the RadioButton will belong.
Returns:
{sap.m.RadioButton} Reference to the control instance for chaining
setSelected(bSelected): sap.m.RadioButton
Sets the state of the RadioButton to selected.
Parameters:
{boolean}bSelected defines if the radio button is selected
Returns:
{sap.m.RadioButton} Reference to the control instance for chaining
setText(sText): sap.m.RadioButton
Sets the text for the RadioButton's label.
Parameters:
{string}sText The text to be set
Returns:
{sap.m.RadioButton} Reference to the control instance for chaining
setTextAlign(sTextAlign): sap.m.RadioButton
Sets a new value for property textAlign.

Specifies the alignment of the radio button. Available alignment settings are "Begin", "Center", "End", "Left", and "Right".

When called with a value of null or undefined, the default value of the property will be restored.

Default value is Begin.

Parameters:
{sap.ui.core.TextAlign}sTextAlign New value for property textAlign
Since:
1.28
Returns:
{sap.m.RadioButton} Reference to this in order to allow method chaining
setTextDirection(sDirection): sap.m.RadioButton
Sets the text direction for the RadioButton's label.
Parameters:
{string}sDirection Text direction to be set to RadioButton's label
Returns:
{sap.m.RadioButton} Reference to the control instance for chaining
setValueState(sValueState): sap.m.RadioButton
Sets a new value for property valueState.

Enumeration sap.ui.core.ValueState provides state values Error, Success, Warning, None

When called with a value of null or undefined, the default value of the property will be restored.

Default value is None.

Parameters:
{sap.ui.core.ValueState}sValueState New value for property valueState
Since:
1.25
Returns:
{sap.m.RadioButton} Reference to this in order to allow method chaining
setWidth(sWidth): sap.m.RadioButton
Sets the width for the RadioButton's label.
Parameters:
{string}sWidth CSS size to be set as width of the label
Returns:
{sap.m.RadioButton} Reference to the control instance for chaining