com.extjs.gxt.ui.client.widget.form
Class RadioGroup

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.extjs.gxt.ui.client.widget.Component
              extended by com.extjs.gxt.ui.client.widget.BoxComponent
                  extended by com.extjs.gxt.ui.client.widget.form.Field<D>
                      extended by com.extjs.gxt.ui.client.widget.form.MultiField<Radio>
                          extended by com.extjs.gxt.ui.client.widget.form.RadioGroup
All Implemented Interfaces:
Observable, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener

public class RadioGroup
extends MultiField<Radio>

A group of Radio's.

Events:
Change : FieldEvent(field, value, oldValue)
Fires after a child radio is selected.


Nested Class Summary
 class RadioGroup.RadioGroupMessages
          TextField Messages.
 
Nested classes/interfaces inherited from class com.extjs.gxt.ui.client.widget.form.Field
Field.FieldImages, Field.FieldMessages
 
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
RadioGroup()
          Creates a new radio group.
RadioGroup(java.lang.String name)
          Creates a new radio group.
 
Method Summary
 void add(Radio radio)
           
 RadioGroup.RadioGroupMessages getMessages()
          Returns the field's messages.
 Radio getValue()
          Returns the selected radio.
 boolean isSelectionRequired()
          Returns true if a selection is required.
 boolean isValid(boolean preventMark)
          Returns whether or not the field value is currently valid.
 void setSelectionRequired(boolean selectionRequired)
          Sets whether a selection is required when validating the group (defaults to false).
 void setValue(Radio value)
          Sets a data value into the field and validates it.
 
Methods inherited from class com.extjs.gxt.ui.client.widget.form.MultiField
add, disable, enable, get, getAll, getOrientation, getSpacing, getValidator, isResizeFields, onBrowserEvent, onComponentEvent, reset, setOrientation, setReadOnly, setResizeFields, setSpacing, setValidator
 
Methods inherited from class com.extjs.gxt.ui.client.widget.form.Field
addInputStyleName, addKeyListener, clearInvalid, focus, forceInvalid, getAutoValidate, getEmptyText, getErrorMessage, getFieldLabel, getImages, getLabelSeparator, getLabelStyle, getMessageTarget, getName, getOriginalValue, getPropertyEditor, getRawValue, getValidateOnBlur, getValidationDelay, isDirty, isFireChangeEventOnSetValue, isHideLabel, isInEditor, isReadOnly, isValid, markInvalid, removeInputStyleName, removeKeyListener, setAutoValidate, setEmptyText, setFieldLabel, setFireChangeEventOnSetValue, setHideLabel, setImages, setInEditor, setLabelSeparator, setLabelStyle, setMessages, setMessageTarget, setName, setOriginalValue, setPropertyEditor, setRawValue, setTabIndex, setValidateOnBlur, setValidationDelay, updateOriginalValue, validate, validate
 
Methods inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
getBounds, getHeight, getHeight, getPosition, getShadow, getShadowOffset, getShadowPosition, getSize, getWidth, getWidth, isAutoHeight, isAutoWidth, isDeferHeight, isShim, setAutoHeight, setAutoWidth, setBounds, setBounds, setDeferHeight, setHeight, setHeight, setPagePosition, setPagePosition, setPixelSize, setPosition, setShadow, setShadowOffset, setShadowPosition, setShim, setSize, setSize, setWidth, setWidth, sync, syncSize
 
Methods inherited from class com.extjs.gxt.ui.client.widget.Component
addListener, addPlugin, addStyleName, addWidgetListener, clearState, disableEvents, disableTextSelection, el, enableEvents, fireEvent, fireEvent, fireEvent, fly, getBaseStyle, getBorders, getContextMenu, getData, getElement, getHideMode, getId, getItemId, getListeners, getModel, getState, getStateId, getToolTip, hasListeners, hasListeners, hide, hideToolTip, isDisabledEvents, isEnabled, isRendered, isStateful, isVisible, mask, mask, mask, recalculate, removeAllListeners, removeFromParent, removeListener, removeStyleName, removeSwallow, removeToolTip, removeWidgetListener, render, render, repaint, saveState, setBorders, setContextMenu, setData, setElement, setEnabled, setHideMode, setId, setIntStyleAttribute, setItemId, setStateful, setStateId, setStyleAttribute, setStyleName, setTitle, setToolTip, setToolTip, setVisible, setZIndex, show, sinkEvents, swallowEvent, swallowEvent, toString, unmask
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
fireEvent, getParent, isAttached
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, setStylePrimaryName, setVisible, unsinkEvents
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

RadioGroup

public RadioGroup()
Creates a new radio group.


RadioGroup

public RadioGroup(java.lang.String name)
Creates a new radio group.

Parameters:
name - the group name
Method Detail

add

public void add(Radio radio)

getMessages

public RadioGroup.RadioGroupMessages getMessages()
Description copied from class: Field
Returns the field's messages.

Overrides:
getMessages in class Field<Radio>
Returns:
the messages

getValue

public Radio getValue()
Returns the selected radio.

Overrides:
getValue in class Field<Radio>
Returns:
the fields value

isSelectionRequired

public boolean isSelectionRequired()
Returns true if a selection is required.

Returns:
the selection required state

isValid

public boolean isValid(boolean preventMark)
Description copied from class: Field
Returns whether or not the field value is currently valid.

Overrides:
isValid in class MultiField<Radio>
Parameters:
preventMark - true for silent validation (no invalid event and field is not marked invalid)
Returns:
true if the value is valid, otherwise false

setSelectionRequired

public void setSelectionRequired(boolean selectionRequired)
Sets whether a selection is required when validating the group (defaults to false).

Parameters:
selectionRequired - true to require a selection

setValue

public void setValue(Radio value)
Description copied from class: Field
Sets a data value into the field and validates it. If the field is rendered, To set the value directly without validation see Field.setRawValue(java.lang.String).

Overrides:
setValue in class Field<Radio>
Parameters:
value - the value to set