com.github.ilyes4j.gwt.mdl.components.toggles

Class RadioButton

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.github.ilyes4j.gwt.mdl.components.toggles.CheckboxBase<RadioStyle>

com.github.ilyes4j.gwt.mdl.components.toggles.RadioButton

All Implemented Interfaces:

IUpgrade, HasRipple, com.google.gwt.editor.client.IsEditor<com.google.gwt.editor.client.LeafValueEditor<Boolean>>, com.google.gwt.event.dom.client.HasAllDragAndDropHandlers, com.google.gwt.event.dom.client.HasAllFocusHandlers, com.google.gwt.event.dom.client.HasAllGestureHandlers, com.google.gwt.event.dom.client.HasAllKeyHandlers, com.google.gwt.event.dom.client.HasAllMouseHandlers, com.google.gwt.event.dom.client.HasAllTouchHandlers, com.google.gwt.event.dom.client.HasBlurHandlers, com.google.gwt.event.dom.client.HasClickHandlers, com.google.gwt.event.dom.client.HasDoubleClickHandlers, com.google.gwt.event.dom.client.HasDragEndHandlers, com.google.gwt.event.dom.client.HasDragEnterHandlers, com.google.gwt.event.dom.client.HasDragHandlers, com.google.gwt.event.dom.client.HasDragLeaveHandlers, com.google.gwt.event.dom.client.HasDragOverHandlers, com.google.gwt.event.dom.client.HasDragStartHandlers, com.google.gwt.event.dom.client.HasDropHandlers, com.google.gwt.event.dom.client.HasFocusHandlers, com.google.gwt.event.dom.client.HasGestureChangeHandlers, com.google.gwt.event.dom.client.HasGestureEndHandlers, com.google.gwt.event.dom.client.HasGestureStartHandlers, com.google.gwt.event.dom.client.HasKeyDownHandlers, com.google.gwt.event.dom.client.HasKeyPressHandlers, com.google.gwt.event.dom.client.HasKeyUpHandlers, com.google.gwt.event.dom.client.HasMouseDownHandlers, com.google.gwt.event.dom.client.HasMouseMoveHandlers, com.google.gwt.event.dom.client.HasMouseOutHandlers, com.google.gwt.event.dom.client.HasMouseOverHandlers, com.google.gwt.event.dom.client.HasMouseUpHandlers, com.google.gwt.event.dom.client.HasMouseWheelHandlers, com.google.gwt.event.dom.client.HasTouchCancelHandlers, com.google.gwt.event.dom.client.HasTouchEndHandlers, com.google.gwt.event.dom.client.HasTouchMoveHandlers, com.google.gwt.event.dom.client.HasTouchStartHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasValueChangeHandlers<Boolean>, com.google.gwt.event.shared.HasHandlers, com.google.gwt.i18n.shared.HasDirectionEstimator, com.google.gwt.safehtml.client.HasSafeHtml, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.TakesValue<Boolean>, com.google.gwt.user.client.ui.Focusable, com.google.gwt.user.client.ui.HasDirectionalSafeHtml, com.google.gwt.user.client.ui.HasDirectionalText, com.google.gwt.user.client.ui.HasEnabled, com.google.gwt.user.client.ui.HasFocus, com.google.gwt.user.client.ui.HasHTML, com.google.gwt.user.client.ui.HasName, com.google.gwt.user.client.ui.HasText, com.google.gwt.user.client.ui.HasValue<Boolean>, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWordWrap, com.google.gwt.user.client.ui.IsWidget, com.google.gwt.user.client.ui.SourcesClickEvents, com.google.gwt.user.client.ui.SourcesFocusEvents, com.google.gwt.user.client.ui.SourcesKeyboardEvents, com.google.gwt.user.client.ui.SourcesMouseEvents

public class RadioButton
extends CheckboxBase<RadioStyle>

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.

Built-in Bidi Text Support

This widget is capable of automatically adjusting its direction according to its content. This feature is controlled by CheckboxBase.setDirectionEstimator(boolean) or passing a DirectionEstimator parameter to the constructor, and is off by default.

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

Constructors

Constructor and Description
RadioButton(String name) Creates a new radio associated with a particular group name.
RadioButton(String name, com.google.gwt.safehtml.shared.SafeHtml label) Creates a new radio associated with a particular group, and initialized with the given HTML label.
RadioButton(String name, com.google.gwt.safehtml.shared.SafeHtml label, com.google.gwt.i18n.shared.DirectionEstimator directionEstimator)
RadioButton(String name, com.google.gwt.safehtml.shared.SafeHtml label, com.google.gwt.i18n.client.HasDirection.Direction dir)
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).
RadioButton(String name, String label, com.google.gwt.i18n.shared.DirectionEstimator directionEstimator)
RadioButton(String name, String label, com.google.gwt.i18n.client.HasDirection.Direction dir)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	ensureDomEventHandlers() No-op.
void	onBrowserEvent(com.google.gwt.user.client.Event event) Overridden to send ValueChangeEvents only when appropriate.
void	setName(String name) Change the group name of this radio button.

Methods inherited from class com.github.ilyes4j.gwt.mdl.components.toggles.CheckboxBase

addValueChangeHandler, asEditor, getContainer, getDirectionEstimator, getFormValue, getHTML, getInput, getLabel, getName, getRipple, getTabIndex, getText, getTextDirection, getToggle, getValue, getWordWrap, isChecked, isEnabled, isUpgraded, onEnsureDebugId, onLoad, onUnload, replaceInputElement, replaceInputElement, setAccessKey, setChecked, setDirectionEstimator, setDirectionEstimator, setEnabled, setFocus, setFormValue, setHTML, setHTML, setRipple, setTabIndex, setText, setText, setValue, setValue, setWordWrap, upgrade

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

setHTML

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

addBlurHandler, addClickHandler, addClickListener, addDoubleClickHandler, addDragEndHandler, addDragEnterHandler, addDragHandler, addDragLeaveHandler, addDragOverHandler, addDragStartHandler, addDropHandler, addFocusHandler, addFocusListener, addGestureChangeHandler, addGestureEndHandler, addGestureStartHandler, addKeyboardListener, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addMouseDownHandler, addMouseListener, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseUpHandler, addMouseWheelHandler, addMouseWheelListener, addTouchCancelHandler, addTouchEndHandler, addTouchMoveHandler, addTouchStartHandler, getFocusImpl, onAttach, removeClickListener, removeFocusListener, removeKeyboardListener, removeMouseListener, removeMouseWheelListener

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onDetach, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

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, isVisible, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Methods inherited from interface com.google.gwt.safehtml.client.HasSafeHtml

setHTML

Constructor Detail

RadioButton

@UiConstructor
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

RadioButton

public RadioButton(String name,
           com.google.gwt.safehtml.shared.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

RadioButton

public RadioButton(String name,
           com.google.gwt.safehtml.shared.SafeHtml label,
           com.google.gwt.i18n.client.HasDirection.Direction dir)

Parameters:

name - the group name with which to associate the radio button

label - this radio button's html label

dir - the text's direction. Note that DEFAULT means direction should be inherited from the widget's parent element.

See Also:

RadioButton(String, SafeHtml)

RadioButton

public RadioButton(String name,
           com.google.gwt.safehtml.shared.SafeHtml label,
           com.google.gwt.i18n.shared.DirectionEstimator directionEstimator)

Parameters:

name - the group name with which to associate the radio button

label - this radio button's html label

directionEstimator - A DirectionEstimator object used for automatic direction adjustment.

See Also:

RadioButton(String, SafeHtml)

RadioButton

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

RadioButton

public RadioButton(String name,
           String label,
           com.google.gwt.i18n.client.HasDirection.Direction dir)

Parameters:

name - the group name with which to associate the radio button

label - this radio button's label

dir - the text's direction. Note that DEFAULT means direction should be inherited from the widget's parent element.

See Also:

RadioButton(String, SafeHtml)

RadioButton

public RadioButton(String name,
           String label,
           com.google.gwt.i18n.shared.DirectionEstimator directionEstimator)

Parameters:

name - the group name with which to associate the radio button

label - this radio button's label

directionEstimator - A DirectionEstimator object used for automatic direction adjustment.

See Also:

RadioButton(String, SafeHtml)

RadioButton

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

Method Detail

onBrowserEvent

public void onBrowserEvent(com.google.gwt.user.client.Event event)

Overridden to send ValueChangeEvents only when appropriate.

Specified by:

onBrowserEvent in interface com.google.gwt.user.client.EventListener

Overrides:

onBrowserEvent in class com.google.gwt.user.client.ui.Widget

setName

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.

Specified by:

setName in interface com.google.gwt.user.client.ui.HasName

Overrides:

setName in class CheckboxBase<RadioStyle>

Parameters:

name - name the group with which to associate the radio button

ensureDomEventHandlers

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(com.google.gwt.user.client.Event)

Overrides:

ensureDomEventHandlers in class CheckboxBase<RadioStyle>