com.sap.ui.commons.client
Class RadioButtonGroup

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.RadioButtonGroup

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

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

a group of RadioButtons to hande as one UI element.

• Properties
  • width : String
    Width of the RadioButtonGroup.
  • columns : int
    Number of RadioButtons displayed in one Line.
  • visible : boolean
    Visibility of Group
  • editable : boolean
    Specifies whether the user can choose a radio button.
  • valueState : com.sap.ui.core.client.ValueState
    The value state to be displayed.
  • selectedIndex : int
    Index of the selected/checked RadioButton.
• Aggregations
  • items : com.sap.ui.core.client.Item
    RadioButtons of this RadioButtonGroup
• Associations
• Events
  • select Event is fired when selection is changed by user interaction.

Version:

0.18.0-SNAPSHOT

Author:

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

Constructor Summary

protected

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

Method Summary

RadioButtonGroup	addItem(com.sap.ui.core.client.Item item) Appends a item to the aggregation items.
RadioButtonGroup	attachSelectEvent(com.sap.ui.core.client.event.EventListener listener) attach an EventListener Event is fired when selection is changed by user interaction.
RadioButtonGroup	bindItems(String path, com.sap.ui.core.client.Element template) Binder for aggregation items.
static RadioButtonGroup	create() creates a new instance of the class RadioButtonGroup
static RadioButtonGroup	create(String idOrConfig) creates a new instance of the class RadioButtonGroup
static RadioButtonGroup	create(String id, String config) creates a new instance of the class RadioButtonGroup
RadioButtonGroup	destroyItems() Destroys all the items in the Items-aggregation.
RadioButtonGroup	detachSelectEvent(com.sap.ui.core.client.event.EventListener listener) detach an EventListener Event is fired when selection is changed by user interaction.
int	getColumns() Getter for property columns Number of RadioButtons displayed in one Line.
com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Item>	getItems() Getter for aggregation items RadioButtons of this RadioButtonGroup
int	getSelectedIndex() Getter for property selectedIndex Index of the selected/checked RadioButton.
com.sap.ui.core.client.Item	getSelectedItem() Returns selected item.
com.sap.ui.core.client.ValueState	getValueState() Getter for property valueState The value state to be displayed.
String	getWidth() Getter for property width Width of the RadioButtonGroup.
int	indexOfItem(com.sap.ui.core.client.Item item) Checks for the provided com.sap.ui.core.client.Item in the items-aggregation and returns its index if found or -1 otherwise.
RadioButtonGroup	insertItem(com.sap.ui.core.client.Item item, int index) Inserts some item into the aggregation named items.
boolean	isEditable() Getter for property editable Specifies whether the user can choose a radio button.
boolean	isVisible() Getter for property visible Visibility of Group
com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Item>>	removeAllItems() Removes all the items in the items-aggregation.
com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Item>	removeItem(int index) Removes a item from the aggregation named items.
RadioButtonGroup	setColumns(int value) Setter for property columns Default value is: 1
RadioButtonGroup	setEditable(boolean value) Setter for property editable Default value is: true
RadioButtonGroup	setSelectedIndex(int value) Setter for property selectedIndex Default value is: 0
void	setSelectedItem(com.sap.ui.core.client.Item item) Sets the item as seleced and removs the selection from the old one.
RadioButtonGroup	setValueState(com.sap.ui.core.client.ValueState value) Setter for property valueState Default value is: None
RadioButtonGroup	setVisible(boolean value) Setter for property visible Default value is: true
RadioButtonGroup	setWidth(String value) Setter for property width
RadioButtonGroup	unbindItems() Unbinder for aggregation items.

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

RadioButtonGroup

protected RadioButtonGroup()

constructs the class RadioButtonGroup
hidden due to JavaScriptObject restriction

Method Detail

create

public static RadioButtonGroup create()

creates a new instance of the class RadioButtonGroup

create

public static RadioButtonGroup create(String idOrConfig)

creates a new instance of the class RadioButtonGroup

Parameters:

id - id of the RadioButtonGroup or configuration JSON string

create

public static RadioButtonGroup create(String id,
                                      String config)

creates a new instance of the class RadioButtonGroup

Parameters:

id - id of the RadioButtonGroup

config - configuration JSON string

getWidth

public final String getWidth()

Getter for property width Width of the RadioButtonGroup.

Returns:

the value of property width

setWidth

public final RadioButtonGroup setWidth(String value)

Setter for property width

Parameters:

value - String

Returns:

this to allow method chaining

getColumns

public final int getColumns()

Getter for property columns Number of RadioButtons displayed in one Line.

Returns:

the value of property columns

setColumns

public final RadioButtonGroup setColumns(int value)

Setter for property columns
Default value is: 1

Parameters:

value - int

Returns:

this to allow method chaining

isVisible

public final boolean isVisible()

Getter for property visible Visibility of Group

Returns:

the value of property visible

setVisible

public final RadioButtonGroup setVisible(boolean value)

Setter for property visible
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 RadioButtonGroup setEditable(boolean value)

Setter for property editable
Default value is: true

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 RadioButtonGroup 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

getSelectedIndex

public final int getSelectedIndex()

Getter for property selectedIndex Index of the selected/checked RadioButton.

Returns:

the value of property selectedIndex

setSelectedIndex

public final RadioButtonGroup setSelectedIndex(int value)

Setter for property selectedIndex
Default value is: 0

Parameters:

value - int

Returns:

this to allow method chaining

getItems

public final com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Item> getItems()

Getter for aggregation items RadioButtons of this RadioButtonGroup

Returns:

com.sap.ui.core.client.Item[]

insertItem

public final RadioButtonGroup insertItem(com.sap.ui.core.client.Item item,
                                         int index)

Inserts some item into the aggregation named items.

Parameters:

item - the item to insert

index - int the 0-based index the item should be inserted at.

Returns:

this to allow method chaining

addItem

public final RadioButtonGroup addItem(com.sap.ui.core.client.Item item)

Appends a item to the aggregation items.

Parameters:

item - com.sap.ui.core.client.Item the item to add

Returns:

this to allow method chaining

removeItem

public final com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Item> removeItem(int index)

Removes a item from the aggregation named items.

Parameters:

index - int the position of the item to remove.

Returns:

reference to this instance

removeAllItems

public final com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.js.JsArray<com.sap.ui.core.client.Item>> removeAllItems()

Removes all the items in the items-aggregation.

Returns:

an array of the removed elements (might be empty)

indexOfItem

public final int indexOfItem(com.sap.ui.core.client.Item item)

Checks for the provided com.sap.ui.core.client.Item in the items-aggregation and returns its index if found or -1 otherwise.

Parameters:

item - the item whose index is looked for.

Returns:

the index of the provided control in the aggregation.

destroyItems

public final RadioButtonGroup destroyItems()

Destroys all the items in the Items-aggregation.

Returns:

this to allow method chaining

bindItems

public final RadioButtonGroup bindItems(String path,
                                        com.sap.ui.core.client.Element template)

Binder for aggregation items.

Parameters:

path - path to a list in the model

template - the template Element for this aggregation

Returns:

this to allow method chaining

unbindItems

public final RadioButtonGroup unbindItems()

Unbinder for aggregation items.

Returns:

this to allow method chaining

attachSelectEvent

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

attach an EventListener Event is fired when selection is changed by user interaction.

Event Parameters:

{sap.ui.core/int} selectedIndex Index of the selected RadioButton.

Parameters:

listener - reference to the EventListener

Returns:

this to allow method chaining

detachSelectEvent

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

detach an EventListener Event is fired when selection is changed by user interaction.

Parameters:

listener - reference to the EventListener

Returns:

this to allow method chaining

getSelectedItem

public final com.sap.ui.core.client.Item getSelectedItem()

Returns selected item. When no item is selected, "null" is returned. When multi-selection is enabled and multiple items are selected, only the first selected item is returned.

setSelectedItem

public final void setSelectedItem(com.sap.ui.core.client.Item item)

Sets the item as seleced and removs the selection from the old one.

Parameters:

item - Selected item.