public class

RadioButton

extends CheckBox

java.lang.Object
↳	com.google.gwt.user.client.ui.UIObject
	↳	com.google.gwt.user.client.ui.Widget
		↳	com.google.gwt.user.client.ui.FocusWidget
			↳	com.google.gwt.user.client.ui.ButtonBase
				↳	com.google.gwt.user.client.ui.CheckBox
					↳	com.google.gwt.user.client.ui.RadioButton

Class Overview

A mutually-exclusive selection radio button widget. Fires ClickEvents when the radio button is clicked, and ValueChangeEvents when the button becomes checked. Note, however, that browser limitations prevent ValueChangeEvents from being sent when the radio button is cleared as a side effect of another in the group being clicked.

CSS Style Rules

.gwt-RadioButton: the outer element

Example

{@example com.google.gwt.examples.RadioButtonExample}

Summary

[Expand]

Inherited Constants

From class com.google.gwt.user.client.ui.UIObject

Public Constructors
	RadioButton(String name) Creates a new radio associated with a particular group name.
	RadioButton(String name, SafeHtml label) Creates a new radio associated with a particular group, and initialized with the given HTML label.
	RadioButton(String name, String label) Creates a new radio associated with a particular group, and initialized with the given HTML label.
	RadioButton(String name, String label, boolean asHTML) Creates a new radio button associated with a particular group, and initialized with the given label (optionally treated as HTML).

Public Methods
void	onBrowserEvent(Event event) Overridden to send ValueChangeEvents only when appropriate.
void	setName(String name) Change the group name of this radio button.
void	sinkEvents(int eventBitsToAdd) Overridden to defer the call to super.sinkEvents until the first time this widget is attached to the dom, as a performance enhancement.

Protected Methods
void	ensureDomEventHandlers() No-op.

[Expand]

Inherited Methods

From class com.google.gwt.user.client.ui.CheckBox

HandlerRegistration	addValueChangeHandler(ValueChangeHandler<Boolean> handler)
LeafValueEditor<Boolean>	asEditor() Returns the Editor encapsulated by the view object.
void	ensureDomEventHandlers()
String	getFormValue() Returns the value property of the input element that backs this widget.
String	getHTML() Gets this object's contents as HTML.
String	getName() Gets the widget's name.
int	getTabIndex() Gets the tab index.
String	getText() Gets this object's text.
Boolean	getValue() Determines whether this check box is currently checked.
boolean	getWordWrap() Gets whether word-wrapping is enabled.
boolean	isChecked() This method is deprecated. Use `getValue()` instead
boolean	isEnabled() Gets whether this widget is enabled.
void	onEnsureDebugId(String baseID) Affected Elements: -label = label next to checkbox.
void	onLoad() This method is called when a widget is attached to the browser's document.
void	onUnload() This method is called when a widget is detached from the browser's document.
void	replaceInputElement(Element elem) Replace the current input element with a new one.
void	setAccessKey(char key) Sets the widget's 'access key'.
void	setChecked(boolean checked) This method is deprecated. Use `setValue(Boolean)` instead
void	setEnabled(boolean enabled) Sets whether this widget is enabled.
void	setFocus(boolean focused) Explicitly focus/unfocus this widget.
void	setFormValue(String value) Set the value property on the input element that backs this widget.
void	setHTML(String html) Sets this object's contents via HTML.
void	setName(String name) Sets the widget's name.
void	setTabIndex(int index) Sets the widget's position in the tab index.
void	setText(String text) Sets this object's text.
void	setValue(Boolean value, boolean fireEvents) Checks or unchecks the check box, firing `ValueChangeEvent` if appropriate.
void	setValue(Boolean value) Checks or unchecks the check box.
void	setWordWrap(boolean wrap) Sets whether word-wrapping is enabled.
void	sinkEvents(int eventBitsToAdd) Overridden to defer the call to super.sinkEvents until the first time this widget is attached to the dom, as a performance enhancement.

From class com.google.gwt.user.client.ui.ButtonBase

From class com.google.gwt.user.client.ui.FocusWidget

From class com.google.gwt.user.client.ui.Widget

HandlerRegistration	addAttachHandler(AttachEvent.Handler handler) Adds an `AttachEvent` handler.
final <H extends EventHandler> HandlerRegistration	addDomHandler(H handler, Type<H> type) Adds a native event handler to the widget and sinks the corresponding native event.
final <H extends EventHandler> HandlerRegistration	addHandler(H handler, Type<H> type) Adds this handler to the widget.
Widget	asWidget() Returns the `Widget` aspect of the receiver.
static Widget	asWidgetOrNull(IsWidget w) This convenience method makes a null-safe call to `asWidget()`.
HandlerManager	createHandlerManager() Creates the `HandlerManager` used by this Widget.
void	delegateEvent(Widget target, GwtEvent<?> event) Fires an event on a child widget.
void	doAttachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call `onAttach()` for each of its child widgets.
void	doDetachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call `onDetach()` for each of its child widgets.
void	fireEvent(GwtEvent<?> event) Fires the given event to the handlers listening to the event's type.
int	getHandlerCount(Type<?> type) Gets the number of handlers listening to the event type.
Object	getLayoutData() Gets the panel-defined layout data associated with this widget.
Widget	getParent() Gets this widget's parent panel.
boolean	isAttached() Determines whether this widget is currently attached to the browser's document (i.e., there is an unbroken chain of widgets between this widget and the underlying browser document).
final boolean	isOrWasAttached() Has this widget ever been attached?
void	onAttach() This method is called when a widget is attached to the browser's document.
void	onBrowserEvent(Event event) Fired whenever a browser event is received.
void	onDetach() This method is called when a widget is detached from the browser's document.
void	onLoad() This method is called immediately after a widget becomes attached to the browser's document.
void	onUnload() This method is called immediately before a widget will be detached from the browser's document.
void	removeFromParent() Removes this widget from its parent widget, if one exists.
void	setLayoutData(Object layoutData) Sets the panel-defined layout data associated with this widget.
void	sinkEvents(int eventBitsToAdd) Overridden to defer the call to super.sinkEvents until the first time this widget is attached to the dom, as a performance enhancement.

From class com.google.gwt.user.client.ui.UIObject

void	addStyleDependentName(String styleSuffix) Adds a dependent style name by specifying the style name's suffix.
void	addStyleName(String style) Adds a secondary or dependent style name to this object.
static void	ensureDebugId(Element elem, String baseID, String id) Set the debug id of a specific element.
final void	ensureDebugId(String id) Ensure that the main `Element` for this `UIObject` has an ID property set, which allows it to integrate with third-party libraries and test tools.
static void	ensureDebugId(Element elem, String id) Ensure that elem has an ID property set, which allows it to integrate with third-party libraries and test tools.
int	getAbsoluteLeft() Gets the object's absolute left position in pixels, as measured from the browser window's client area.
int	getAbsoluteTop() Gets the object's absolute top position in pixels, as measured from the browser window's client area.
Element	getElement() Gets a handle to the object's underlying DOM element.
int	getOffsetHeight() Gets the object's offset height in pixels.
int	getOffsetWidth() Gets the object's offset width in pixels.
Element	getStyleElement() Template method that returns the element to which style names will be applied.
String	getStyleName() Gets all of the object's style names, as a space-separated list.
static String	getStyleName(Element elem) Gets all of the element's style names, as a space-separated list.
String	getStylePrimaryName() Gets the primary style name associated with the object.
static String	getStylePrimaryName(Element elem) Gets the element's primary style name.
String	getTitle() Gets the title associated with this object.
boolean	isVisible() Determines whether or not this object is visible.
static boolean	isVisible(Element elem)
void	onEnsureDebugId(String baseID) Called when the user sets the id using the `ensureDebugId(String)` method.
void	removeStyleDependentName(String styleSuffix) Removes a dependent style name by specifying the style name's suffix.
void	removeStyleName(String style) Removes a style name.
final void	setElement(Element elem) Sets this object's browser element.
void	setElement(Element elem) Sets this object's browser element.
void	setHeight(String height) Sets the object's height.
void	setPixelSize(int width, int height) Sets the object's size, in pixels, not including decorations such as border, margin, and padding.
void	setSize(String width, String height) Sets the object's size.
void	setStyleDependentName(String styleSuffix, boolean add) Adds or removes a dependent style name by specifying the style name's suffix.
static void	setStyleName(Element elem, String styleName) Clears all of the element's style names and sets it to the given style.
static void	setStyleName(Element elem, String style, boolean add) This convenience method adds or removes a style name for a given element.
void	setStyleName(String style) Clears all of the object's style names and sets it to the given style.
void	setStyleName(String style, boolean add) Adds or removes a style name.
void	setStylePrimaryName(String style) Sets the object's primary style name and updates all dependent style names.
static void	setStylePrimaryName(Element elem, String style) Sets the element's primary style name and updates all dependent style names.
void	setTitle(String title) Sets the title associated with this object.
void	setVisible(boolean visible) Sets whether this object is visible.
static void	setVisible(Element elem, boolean visible)
void	setWidth(String width) Sets the object's width.
void	sinkEvents(int eventBitsToAdd) Adds a set of events to be sunk by this object.
String	toString() This method is overridden so that any object can be viewed in the debugger as an HTML snippet.
void	unsinkEvents(int eventBitsToRemove) Removes a set of events from this object's event list.

From class java.lang.Object

From interface com.google.gwt.editor.client.IsEditor

From interface com.google.gwt.event.dom.client.HasBlurHandlers

From interface com.google.gwt.event.dom.client.HasClickHandlers

From interface com.google.gwt.event.dom.client.HasDoubleClickHandlers

From interface com.google.gwt.event.dom.client.HasFocusHandlers

From interface com.google.gwt.event.dom.client.HasGestureChangeHandlers

From interface com.google.gwt.event.dom.client.HasGestureEndHandlers

From interface com.google.gwt.event.dom.client.HasGestureStartHandlers

From interface com.google.gwt.event.dom.client.HasKeyDownHandlers

From interface com.google.gwt.event.dom.client.HasKeyPressHandlers

From interface com.google.gwt.event.dom.client.HasKeyUpHandlers

From interface com.google.gwt.event.dom.client.HasMouseDownHandlers

From interface com.google.gwt.event.dom.client.HasMouseMoveHandlers

From interface com.google.gwt.event.dom.client.HasMouseOutHandlers

From interface com.google.gwt.event.dom.client.HasMouseOverHandlers

From interface com.google.gwt.event.dom.client.HasMouseUpHandlers

From interface com.google.gwt.event.dom.client.HasMouseWheelHandlers

From interface com.google.gwt.event.dom.client.HasTouchCancelHandlers

From interface com.google.gwt.event.dom.client.HasTouchEndHandlers

From interface com.google.gwt.event.dom.client.HasTouchMoveHandlers

From interface com.google.gwt.event.dom.client.HasTouchStartHandlers

From interface com.google.gwt.event.logical.shared.HasAttachHandlers

From interface com.google.gwt.event.logical.shared.HasValueChangeHandlers

From interface com.google.gwt.event.shared.HasHandlers

From interface com.google.gwt.safehtml.client.HasSafeHtml

From interface com.google.gwt.user.client.EventListener

From interface com.google.gwt.user.client.TakesValue

From interface com.google.gwt.user.client.ui.Focusable

From interface com.google.gwt.user.client.ui.HasEnabled

From interface com.google.gwt.user.client.ui.HasHTML

From interface com.google.gwt.user.client.ui.HasName

From interface com.google.gwt.user.client.ui.HasText

From interface com.google.gwt.user.client.ui.HasValue

From interface com.google.gwt.user.client.ui.HasWordWrap

From interface com.google.gwt.user.client.ui.IsWidget

From interface com.google.gwt.user.client.ui.SourcesClickEvents

From interface com.google.gwt.user.client.ui.SourcesFocusEvents

From interface com.google.gwt.user.client.ui.SourcesKeyboardEvents

From interface com.google.gwt.user.client.ui.SourcesMouseEvents

Public Constructors

public RadioButton (String name)

Creates a new radio associated with a particular group name. All radio buttons associated with the same group name belong to a mutually-exclusive set. Radio buttons are grouped by their name attribute, so changing their name using the setName() method will also change their associated group.

Parameters

name	the group name with which to associate the radio button

public RadioButton (String name, SafeHtml label)

Creates a new radio associated with a particular group, and initialized with the given HTML label. All radio buttons associated with the same group name belong to a mutually-exclusive set. Radio buttons are grouped by their name attribute, so changing their name using the setName() method will also change their associated group.

Parameters

name	the group name with which to associate the radio button
label	this radio button's html label

public RadioButton (String name, String label)

Creates a new radio associated with a particular group, and initialized with the given HTML label. All radio buttons associated with the same group name belong to a mutually-exclusive set. Radio buttons are grouped by their name attribute, so changing their name using the setName() method will also change their associated group.

Parameters

name	the group name with which to associate the radio button
label	this radio button's label

public RadioButton (String name, String label, boolean asHTML)

Creates a new radio button associated with a particular group, and initialized with the given label (optionally treated as HTML). All radio buttons associated with the same group name belong to a mutually-exclusive set. Radio buttons are grouped by their name attribute, so changing their name using the setName() method will also change their associated group.

Parameters

name	name the group with which to associate the radio button
label	this radio button's label
asHTML	`true` to treat the specified label as HTML

Public Methods

public void onBrowserEvent (Event event)

Overridden to send ValueChangeEvents only when appropriate.

Parameters

event	the event received

public void setName (String name)

Change the group name of this radio button. Radio buttons are grouped by their name attribute, so changing their name using the setName() method will also change their associated group. If changing this group name results in a new radio group with multiple radio buttons selected, this radio button will remain selected and the other radio buttons will be unselected.

Parameters

name	name the group with which to associate the radio button

public void sinkEvents (int eventBitsToAdd)

Overridden to defer the call to super.sinkEvents until the first time this widget is attached to the dom, as a performance enhancement. Subclasses wishing to customize sinkEvents can preserve this deferred sink behavior by putting their implementation behind a check of isOrWasAttached():

 @Override
 public void sinkEvents(int eventBitsToAdd) {
   if (isOrWasAttached()) {
     /* customized sink code goes here */
   } else {
     super.sinkEvents(eventBitsToAdd);
  }
}

Parameters

eventBitsToAdd	a bitfield representing the set of events to be added to this element's event set

Protected Methods

protected void ensureDomEventHandlers ()

No-op. CheckBox's click handler is no good for radio button, so don't use it. Our event handling is all done in onBrowserEvent(Event)

Interfaces

Classes

Annotations

Enums

Exceptions

RadioButton

Class Overview

CSS Style Rules

Example

Summary

Public Constructors

public RadioButton (String name)

Parameters

public RadioButton (String name, SafeHtml label)

Parameters

public RadioButton (String name, String label)

Parameters

public RadioButton (String name, String label, boolean asHTML)

Parameters

Public Methods

public void onBrowserEvent (Event event)

Parameters

public void setName (String name)

Parameters

public void sinkEvents (int eventBitsToAdd)

Parameters

Protected Methods

protected void ensureDomEventHandlers ()