com.sap.ui.commons.client
Class RadioButtonWidget

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

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 RadioButtonWidget
extends com.sap.ui.core.client.ControlWidget

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

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

	RadioButtonWidget() constructs the class RadioButtonWidget
protected	RadioButtonWidget(RadioButton control) constructs the class RadioButtonWidget
	RadioButtonWidget(String id) constructs the class RadioButtonWidget

Method Summary

void	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".
void	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".
RadioButton	getControl() returns the reference to the Phoenix Control
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.
void	setEditable(boolean value) Setter for property editable Default value is: true
void	setEnabled(boolean value) Setter for property enabled Default value is: true
void	setGroupName(String value) Setter for property groupName Default value is: 'sapUiRbDefaultGroup'
void	setKey(String value) Setter for property key
void	setSelected(boolean value) Setter for property selected Default value is: false
void	setText(String value) Setter for property text
void	setTextDirection(com.sap.ui.core.client.TextDirection value) Setter for property textDirection Default value is: Inherit
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

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

RadioButtonWidget

public RadioButtonWidget()

constructs the class RadioButtonWidget

RadioButtonWidget

public RadioButtonWidget(String id)

constructs the class RadioButtonWidget

Parameters:

id - id of the RadioButtonWidget

RadioButtonWidget

protected RadioButtonWidget(RadioButton control)

constructs the class RadioButtonWidget

Parameters:

control - reference to an existing RadioButton

Method Detail

getControl

public RadioButton getControl()

returns the reference to the Phoenix Control

Overrides:

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

Returns:

reference to the Phoenix Control

getText

public String getText()

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

Returns:

the value of property text

setText

public void setText(String value)

Setter for property text

Parameters:

value - String

isVisible

public boolean isVisible()

Getter for property visible Invisible radio buttons are not rendered.

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

isEnabled

public 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 void setEnabled(boolean value)

Setter for property enabled
Default value is: true

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

isSelected

public boolean isSelected()

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

Returns:

the value of property selected

setSelected

public void setSelected(boolean value)

Setter for property selected
Default value is: false

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

getWidth

public 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 void setWidth(String value)

Setter for property width

Overrides:

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

Parameters:

value - String

getTextDirection

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

Setter for property textDirection
Default value is: Inherit

Parameters:

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

getGroupName

public 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 void setGroupName(String value)

Setter for property groupName
Default value is: 'sapUiRbDefaultGroup'

Parameters:

value - String

getKey

public String getKey()

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

Returns:

the value of property key

setKey

public void setKey(String value)

Setter for property key

Parameters:

value - String

attachSelectEvent

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

detachSelectEvent

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