com.sap.ui.commons.client
Class RadioButtonGroupWidget

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.sap.ui.core.client.ControlWidget
              com.sap.ui.commons.client.RadioButtonGroupWidget

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.IsWidget

public class RadioButtonGroupWidget
extends com.sap.ui.core.client.ControlWidget

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: )

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

	RadioButtonGroupWidget() constructs the class RadioButtonGroupWidget
protected	RadioButtonGroupWidget(RadioButtonGroup control) constructs the class RadioButtonGroupWidget
	RadioButtonGroupWidget(String id) constructs the class RadioButtonGroupWidget

Method Summary

void	addItem(com.sap.ui.core.client.Item item) Appends some item to the items-aggregation.
void	attachSelectEvent(com.sap.ui.core.client.event.EventListener listener) attach an EventListener Event is fired when selection is changed by user interaction.
void	bindItems(String path, com.sap.ui.core.client.Element template) Binder for aggregation items.
void	destroyItems() Destroys all the items in the Items-aggregation.
void	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.
RadioButtonGroup	getControl() returns the reference to the Phoenix Control
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.
void	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
void	removeAllItems() Removes all the items in the items-aggregation.
void	removeItem(int index) Removes the item at position index in the items-aggregation named.
void	setColumns(int value) Setter for property columns Default value is: 1
void	setEditable(boolean value) Setter for property editable Default value is: true
void	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.
void	setValueState(com.sap.ui.core.client.ValueState value) Setter for property valueState Default value is: None
void	setVisible(boolean value) Setter for property visible Default value is: true
void	setWidth(String value) Setter for property width
void	unbindItems() Unbinder for aggregation items.

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

destroy, doAttachChildren, doDetachChildren, isDesignTime, wrap

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RadioButtonGroupWidget

public RadioButtonGroupWidget()

constructs the class RadioButtonGroupWidget

RadioButtonGroupWidget

public RadioButtonGroupWidget(String id)

constructs the class RadioButtonGroupWidget

Parameters:

id - id of the RadioButtonGroupWidget

RadioButtonGroupWidget

protected RadioButtonGroupWidget(RadioButtonGroup control)

constructs the class RadioButtonGroupWidget

Parameters:

control - reference to an existing RadioButtonGroup

Method Detail

getControl

public RadioButtonGroup getControl()

returns the reference to the Phoenix Control

Overrides:

getControl in class com.sap.ui.core.client.ControlWidget

Returns:

reference to the Phoenix Control

getWidth

public String getWidth()

Getter for property width Width of the RadioButtonGroup.

Returns:

the value of property width

setWidth

public void setWidth(String value)

Setter for property width

Overrides:

setWidth in class com.google.gwt.user.client.ui.UIObject

Parameters:

value - String

getColumns

public int getColumns()

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

Returns:

the value of property columns

setColumns

public void setColumns(int value)

Setter for property columns
Default value is: 1

Parameters:

value - int

isVisible

public boolean isVisible()

Getter for property visible Visibility of Group

Overrides:

isVisible in class com.google.gwt.user.client.ui.UIObject

Returns:

the value of property visible

setVisible

public void setVisible(boolean value)

Setter for property visible
Default value is: true

Overrides:

setVisible in class com.google.gwt.user.client.ui.UIObject

Parameters:

value - boolean

isEditable

public boolean isEditable()

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

Returns:

the value of property editable

setEditable

public void setEditable(boolean value)

Setter for property editable
Default value is: true

Parameters:

value - boolean

getValueState

public 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 void setValueState(com.sap.ui.core.client.ValueState value)

Setter for property valueState
Default value is: None

Parameters:

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

getSelectedIndex

public int getSelectedIndex()

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

Returns:

the value of property selectedIndex

setSelectedIndex

public void setSelectedIndex(int value)

Setter for property selectedIndex
Default value is: 0

Parameters:

value - int

getItems

public 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 void 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.

addItem

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

Appends some item to the items-aggregation.

Parameters:

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

removeItem

public void removeItem(int index)

Removes the item at position index in the items-aggregation named.

Parameters:

index - int the position of the item to remove.

removeAllItems

public void removeAllItems()

Removes all the items in the items-aggregation.

indexOfItem

public 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 void destroyItems()

Destroys all the items in the Items-aggregation.

bindItems

public final void 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

unbindItems

public final void unbindItems()

Unbinder for aggregation items.

attachSelectEvent

public void 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

detachSelectEvent

public void 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

getSelectedItem

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