com.sap.ui.commons.client
Class RadioButton

java.lang.Object
  com.google.gwt.core.client.JavaScriptObject
      com.sap.ui.core.client.Element
          com.sap.ui.core.client.Control
              com.sap.ui.commons.client.RadioButton

public class RadioButton
extends com.sap.ui.core.client.Control

The class RadioButton is the GWT wrapper for the Phoenix control: sap.ui.commons.RadioButton.

Consists of a round element and a descriptive text. Generally, you would create at least two radio button controls; by this, you provide a limited choice for the user. Radio buttons can trigger events. Available value states are "Error", "None", "Success", "Warning".

• Properties
  • text : String
    Defines the text displayed next to the radio button.
  • visible : boolean
    Invisible radio buttons are not rendered.
  • enabled : boolean
    Disabled controls are displayed in another color, depending on the customer settings.
  • editable : boolean
    Specifies whether the user can choose a radio button.
  • selected : boolean
    Specifies the select state of the radio button.
  • valueState : com.sap.ui.core.client.ValueState
    The value state to be displayed.
  • width : String
    The control width depends on the text length. Alternatively, CSS-sizes in % or px can be set.
  • textDirection : com.sap.ui.core.client.TextDirection
    Available options here are LTR and RTL. Alternatively, the control can inherit the text direction from its parent container.
  • groupName : String
    Name of the radio button group the current one belongs to where you can define a new group name. All radio buttons in a page belong to the default group. When any of the radio buttons in this group is selected, all others are deselected.
  • key : String
    Can be used as input for subsequent actions.
• Aggregations
• Associations
• Events
  • select Event is triggered when user interaction causes a radio button switch from state "unselected" to "selected".

Version:

0.18.0-SNAPSHOT

Author:

GENERATOR (JavaScript control: sap.ui.commons.RadioButton)

Constructor Summary

protected

RadioButton() constructs the class RadioButton hidden due to JavaScriptObject restriction

Method Summary

RadioButton	attachSelectEvent(com.sap.ui.core.client.event.EventListener listener) attach an EventListener Event is triggered when user interaction causes a radio button switch from state "unselected" to "selected".
static RadioButton	create() creates a new instance of the class RadioButton
static RadioButton	create(String idOrConfig) creates a new instance of the class RadioButton
static RadioButton	create(String id, String config) creates a new instance of the class RadioButton
RadioButton	detachSelectEvent(com.sap.ui.core.client.event.EventListener listener) detach an EventListener Event is triggered when user interaction causes a radio button switch from state "unselected" to "selected".
String	getGroupName() Getter for property groupName Name of the radio button group the current one belongs to where you can define a new group name.
String	getKey() Getter for property key Can be used as input for subsequent actions.
String	getText() Getter for property text Defines the text displayed next to the radio button.
com.sap.ui.core.client.TextDirection	getTextDirection() Getter for property textDirection Available options here are LTR and RTL.
com.sap.ui.core.client.ValueState	getValueState() Getter for property valueState The value state to be displayed.
String	getWidth() Getter for property width The control width depends on the text length.
boolean	isEditable() Getter for property editable Specifies whether the user can choose a radio button.
boolean	isEnabled() Getter for property enabled Disabled controls are displayed in another color, depending on the customer settings.
boolean	isSelected() Getter for property selected Specifies the select state of the radio button.
boolean	isVisible() Getter for property visible Invisible radio buttons are not rendered.
RadioButton	setEditable(boolean value) Setter for property editable Default value is: true
RadioButton	setEnabled(boolean value) Setter for property enabled Default value is: true
RadioButton	setGroupName(String value) Setter for property groupName Default value is: 'sapUiRbDefaultGroup'
RadioButton	setKey(String value) Setter for property key
RadioButton	setSelected(boolean value) Setter for property selected Default value is: false
RadioButton	setText(String value) Setter for property text
RadioButton	setTextDirection(com.sap.ui.core.client.TextDirection value) Setter for property textDirection Default value is: Inherit
RadioButton	setValueState(com.sap.ui.core.client.ValueState value) Setter for property valueState Default value is: None
RadioButton	setVisible(boolean value) Setter for property visible Default value is: true
RadioButton	setWidth(String value) Setter for property width

Methods inherited from class com.sap.ui.core.client.Control

addStyleClass, hasStyleClass, invalidate, placeAt, placeAt, removeStyleClass, rerender

Methods inherited from class com.sap.ui.core.client.Element

_convertArray, _convertArray, _convertArray, _convertArray, _convertArray, attachBrowserEvent, attachEvent, bindAggregation, bindContext, bindProperty, bindProperty, destroy, detachBrowserEvent, detachEvent, getDomRef, getElementName, getId, getLibraryName, getModel, getParent, getProperty, getTooltip_AsString, getTooltip_Text, getTooltip, isActive, setModel, setProperty, setTooltip, setTooltip, unbindAggregation, unbindContext, unbindProperty

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RadioButton

protected RadioButton()

constructs the class RadioButton
hidden due to JavaScriptObject restriction

Method Detail

create

public static RadioButton create()

creates a new instance of the class RadioButton

create

public static RadioButton create(String idOrConfig)

creates a new instance of the class RadioButton

Parameters:

id - id of the RadioButton or configuration JSON string

create

public static RadioButton create(String id,
                                 String config)

creates a new instance of the class RadioButton

Parameters:

id - id of the RadioButton

config - configuration JSON string

getText

public final String getText()

Getter for property text Defines the text displayed next to the radio button.

Returns:

the value of property text

setText

public final RadioButton setText(String value)

Setter for property text

Parameters:

value - String

Returns:

this to allow method chaining

isVisible

public final boolean isVisible()

Getter for property visible Invisible radio buttons are not rendered.

Returns:

the value of property visible

setVisible

public final RadioButton setVisible(boolean value)

Setter for property visible
Default value is: true

Parameters:

value - boolean

Returns:

this to allow method chaining

isEnabled

public final boolean isEnabled()

Getter for property enabled Disabled controls are displayed in another color, depending on the customer settings.

Returns:

the value of property enabled

setEnabled

public final RadioButton setEnabled(boolean value)

Setter for property enabled
Default value is: true

Parameters:

value - boolean

Returns:

this to allow method chaining

isEditable

public final boolean isEditable()

Getter for property editable Specifies whether the user can choose a radio button.

Returns:

the value of property editable

setEditable

public final RadioButton setEditable(boolean value)

Setter for property editable
Default value is: true

Parameters:

value - boolean

Returns:

this to allow method chaining

isSelected

public final boolean isSelected()

Getter for property selected Specifies the select state of the radio button.

Returns:

the value of property selected

setSelected

public final RadioButton setSelected(boolean value)

Setter for property selected
Default value is: false

Parameters:

value - boolean

Returns:

this to allow method chaining

getValueState

public final com.sap.ui.core.client.ValueState getValueState()

Getter for property valueState The value state to be displayed.

Returns:

the value of property valueState

setValueState

public final RadioButton setValueState(com.sap.ui.core.client.ValueState value)

Setter for property valueState
Default value is: None

Parameters:

value - com.sap.ui.core.client.ValueState

Returns:

this to allow method chaining

getWidth

public final String getWidth()

Getter for property width The control width depends on the text length. Alternatively, CSS-sizes in % or px can be set.

Returns:

the value of property width

setWidth

public final RadioButton setWidth(String value)

Setter for property width

Parameters:

value - String

Returns:

this to allow method chaining

getTextDirection

public final com.sap.ui.core.client.TextDirection getTextDirection()

Getter for property textDirection Available options here are LTR and RTL. Alternatively, the control can inherit the text direction from its parent container.

Returns:

the value of property textDirection

setTextDirection

public final RadioButton setTextDirection(com.sap.ui.core.client.TextDirection value)

Setter for property textDirection
Default value is: Inherit

Parameters:

value - com.sap.ui.core.client.TextDirection

Returns:

this to allow method chaining

getGroupName

public final String getGroupName()

Getter for property groupName Name of the radio button group the current one belongs to where you can define a new group name. All radio buttons in a page belong to the default group. When any of the radio buttons in this group is selected, all others are deselected.

Returns:

the value of property groupName

setGroupName

public final RadioButton setGroupName(String value)

Setter for property groupName
Default value is: 'sapUiRbDefaultGroup'

Parameters:

value - String

Returns:

this to allow method chaining

getKey

public final String getKey()

Getter for property key Can be used as input for subsequent actions.

Returns:

the value of property key

setKey

public final RadioButton setKey(String value)

Setter for property key

Parameters:

value - String

Returns:

this to allow method chaining

attachSelectEvent

public final RadioButton attachSelectEvent(com.sap.ui.core.client.event.EventListener listener)

attach an EventListener Event is triggered when user interaction causes a radio button switch from state "unselected" to "selected".

Parameters:

listener - reference to the EventListener

Returns:

this to allow method chaining

detachSelectEvent

public final RadioButton detachSelectEvent(com.sap.ui.core.client.event.EventListener listener)

detach an EventListener Event is triggered when user interaction causes a radio button switch from state "unselected" to "selected".

Parameters:

listener - reference to the EventListener

Returns:

this to allow method chaining