wicket.markup.html.form
Class RadioGroup

java.lang.Object
  wicket.Component
      wicket.MarkupContainer
          wicket.markup.html.WebMarkupContainer
              wicket.markup.html.form.FormComponent
                  wicket.markup.html.form.RadioGroup

All Implemented Interfaces:

java.io.Serializable, IRequestListener, IOnChangeListener

public class RadioGroup
extends FormComponent
implements IOnChangeListener

Component used to connect instances of Radio components into a group. Instances of Radio have to be in the component hierarchy somewhere below the group component. The model object of the group is set to the model object of the selected radio component or null if none selected. ie

      <span wicket:id="radiochoicegroup">
        ...
        <input type="radio" wicket:id="singleradiochoice1">choice 1</input>
        ...
        <input type="radio" wicket:id="singleradiochoice2">choice 2</input>
        ...
      </span>
 

Author:

Igor Vaynberg (ivaynberg@users.sf.net), Sven Meier (svenmeier)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class wicket.markup.html.form.FormComponent

FormComponent.IVisitor

Nested classes/interfaces inherited from class wicket.Component

Component.ComponentModelChange, Component.EnabledChange, Component.VisibilityChange

Field Summary

Fields inherited from class wicket.markup.html.form.FormComponent

FLAG_CONVERT_EMPTY_INPUT_STRING_TO_NULL, VALUE_SEPARATOR

Fields inherited from class wicket.Component

ENABLE, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED6, FLAG_RESERVED7, FLAG_RESERVED8, PATH_SEPARATOR, RENDER

Fields inherited from interface wicket.markup.html.form.IOnChangeListener

INTERFACE

Constructor Summary

RadioGroup(java.lang.String id)

RadioGroup(java.lang.String id, IModel model)

Method Summary

protected java.lang.Object	convertValue(java.lang.String[] input) Subclasses should overwrite this if the conversion is not done through the type field and the IConverter.
void	onSelectionChanged() Called when a selection changes.
protected void	onSelectionChanged(java.lang.Object newSelection) Template method that can be overriden by clients that implement IOnChangeListener to be notified by onChange events of a select element.
protected boolean	supportsPersistence() Radio group does not support persistence through cookies
protected boolean	wantOnSelectionChangedNotifications()

Methods inherited from class wicket.markup.html.form.FormComponent

add, checkRequired, clearInput, convert, error, getConvertedInput, getForm, getInput, getInputAsArray, getInputName, getLabel, getModelValue, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputAsStringArray, inputChanged, internalOnModelChanged, invalid, isInputNullable, isMultiPart, isPersistent, isRequired, isValid, isValidated, onComponentTag, onDetach, onDisabled, onInvalid, onValid, processInput, setLabel, setModelValue, setModelValue, setPersistent, setRequired, setType, updateModel, valid, validate, validateRequired, validateValidators

Methods inherited from class wicket.markup.html.WebMarkupContainer

getMarkupType, getWebPage

Methods inherited from class wicket.MarkupContainer

add, autoAdd, contains, findMarkupStream, get, getAssociatedMarkupStream, getMarkupStream, internalAdd, internalAttach, internalDetach, isTransparentResolver, iterator, iterator, newMarkupResourceStream, onComponentTagBody, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderComponentTagBody, replace, setMarkupStream, setModel, size, toString, toString, visitChildren, visitChildren

Methods inherited from class wicket.Component

add, addStateChange, checkComponentTag, checkComponentTagAttribute, continueToOriginalDestination, debug, detachBehaviors, detachModel, detachModels, error, exceptionMessage, fatal, findPage, findParent, findParentWithAssociatedMarkup, getApplication, getApplicationPages, getApplicationSettings, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getEscapeModelStrings, getFeedbackMessage, getFlag, getFlag, getId, getLocale, getLocalizer, getMarkupAttributes, getMarkupId, getMetaData, getModel, getModelComparator, getModelObject, getModelObjectAsString, getOutputMarkupId, getPage, getPageFactory, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getResponse, getSession, getSizeInBytes, getString, getString, getString, getStyle, getVariation, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnAttach, internalOnDetach, isActionAuthorized, isAncestorOf, isBehaviorAccepted, isEnableAllowed, isEnabled, isHeadRendered, isIgnoreAttributeModifier, isRenderAllowed, isVersioned, isVisible, isVisibleInHierarchy, modelChanged, modelChanging, newPage, newPage, onAfterRender, onAttach, onBeforeRender, onBeginRequest, onEndRequest, onModelChanged, onModelChanging, onRender, redirectToInterceptPage, remove, render, render, renderComponent, renderComponent, renderComponentTag, rendered, renderedBehaviors, renderHead, replaceComponentTagBody, replaceWith, resetHeadRendered, sameRootModel, sameRootModel, setAuto, setEnabled, setEscapeModelStrings, setFlag, setFlag, setIgnoreAttributeModifier, setMetaData, setModelObject, setOutputMarkupId, setRedirect, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisible, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, warn

Methods inherited from class java.lang.Object

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

Constructor Detail

RadioGroup

public RadioGroup(java.lang.String id)

See Also:

WebMarkupContainer.WebMarkupContainer(String)

RadioGroup

public RadioGroup(java.lang.String id,
                  IModel model)

See Also:

WebMarkupContainer.WebMarkupContainer(String, IModel)

Method Detail

wantOnSelectionChangedNotifications

protected boolean wantOnSelectionChangedNotifications()

convertValue

protected java.lang.Object convertValue(java.lang.String[] input)
                                 throws ConversionException

Description copied from class: FormComponent

Subclasses should overwrite this if the conversion is not done through the type field and the IConverter. WARNING: this method may be removed in future versions. If conversion fails then a ConversionException should be thrown

Overrides:

convertValue in class FormComponent

Parameters:

input - The value can be the getInput() or through a cookie

Returns:

The converted value. default returns just the given value

Throws:

ConversionException - If input can't be converted

See Also:

FormComponent.convertValue(String[])

onSelectionChanged

public final void onSelectionChanged()

Called when a selection changes.

Specified by:

onSelectionChanged in interface IOnChangeListener

onSelectionChanged

protected void onSelectionChanged(java.lang.Object newSelection)

Template method that can be overriden by clients that implement IOnChangeListener to be notified by onChange events of a select element. This method does nothing by default.

Called when a option is selected of a dropdown list that wants to be notified of this event. This method is to be implemented by clients that want to be notified of selection events.

Parameters:

newSelection - The newly selected object of the backing model NOTE this is the same as you would get by calling getModelObject() if the new selection were current

supportsPersistence

protected final boolean supportsPersistence()

Radio group does not support persistence through cookies

Overrides:

supportsPersistence in class FormComponent

Returns:

True if this type of FormComponent can be persisted.

See Also:

FormComponent.supportsPersistence()