org.apache.wicket.markup.html.form
Class Radio<T>

java.lang.Object
  org.apache.wicket.Component
      org.apache.wicket.MarkupContainer
          org.apache.wicket.markup.html.WebMarkupContainer
              org.apache.wicket.markup.html.form.LabeledWebMarkupContainer
                  org.apache.wicket.markup.html.form.Radio<T>

Type Parameters:

T - The model object type

All Implemented Interfaces:

Serializable, Iterable<Component>, IEventSink, IEventSource, IConverterLocator, IGenericComponent<T>, ILabelProvider<String>, IHeaderContributor, IRequestableComponent, IHierarchical<Component>, IClusterable

public class Radio<T>
extends LabeledWebMarkupContainer
implements IGenericComponent<T>

Component representing a single radio choice in a org.apache.wicket.markup.html.form.RadioGroup. Must be attached to an <input type="radio" ... > markup.

STATELESS NOTES: By default this component cannot be used inside a stateless form. If it is desirable to use this inside a stateless form then

• override #getValue() and return some stateless value to uniquely identify this radio (eg relative component path from group to this radio)
• override getStatelessHint() and return true

Author:

Igor Vaynberg, Sven Meier (svenmeier)

See Also:

RadioGroup, Serialized Form

Field Summary

Fields inherited from class org.apache.wicket.Component

ENABLE, FLAG_INITIALIZED, FLAG_REMOVING_FROM_HIERARCHY, FLAG_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER

Constructor Summary

Radio(String id)

Radio(String id, IModel<T> model)

Radio(String id, IModel<T> model, RadioGroup<T> group)

Radio(String id, RadioGroup<T> group)

Method Summary

protected RadioGroup<T>	getGroup()
IModel<T>	getModel() Typesafe getter for the model
T	getModelObject() Typesafe getter for the model's object
protected boolean	getStatelessHint() Returns whether the component can be stateless.
String	getValue() Form submission value used for this radio component.
protected void	onComponentTag(ComponentTag tag) Processes the component tag.
Radio<T>	setLabel(IModel<String> labelModel) The value will be made available to the validator property by means of ${label}.
void	setModel(IModel<T> model) Typesafe setter for the model
void	setModelObject(T object) Typesafe setter for the model object

Methods inherited from class org.apache.wicket.markup.html.form.LabeledWebMarkupContainer

getLabel, onDetach

Methods inherited from class org.apache.wicket.markup.html.WebMarkupContainer

getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addOrReplace, autoAdd, contains, get, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, internalAdd, internalInitialize, iterator, iterator, onAfterRenderChildren, onComponentTagBody, onRender, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, swap, toString, toString, visitChildren, visitChildren, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, afterRender, beforeRender, canCallListenerInterface, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, debug, detach, detachModel, detachModels, determineVisibility, error, exceptionMessage, fatal, findMarkupStream, findPage, findParent, findParentWithAssociatedMarkup, getAjaxRegionMarkupId, getApplication, getBehaviorById, getBehaviorId, getBehaviors, getBehaviors, getClassRelativePath, getConverter, getDefaultModel, getDefaultModelObject, getDefaultModelObjectAsString, getDefaultModelObjectAsString, getEscapeModelStrings, getFeedbackMessages, getFlag, getId, getInnermostModel, getInnermostModel, getLocale, getLocalizer, getMarkup, getMarkupAttributes, getMarkupId, getMarkupId, getMarkupIdFromMarkup, getMarkupIdImpl, getMarkupSourcingStrategy, getMetaData, getModelComparator, getOutputMarkupId, getOutputMarkupPlaceholderTag, getPage, getPageRelativePath, getParent, getPath, getRenderBodyOnly, getRequest, getRequestCycle, getRequestFlag, getResponse, getSession, getSizeInBytes, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, internalOnModelChanged, internalPrepareForRender, internalRenderComponent, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isRenderAllowed, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onBeforeRender, onConfigure, onEvent, onInitialize, onModelChanged, onModelChanging, onRemove, prepareForRender, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderHead, renderHead, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setRequestFlag, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlFor, urlFor, visitParents, visitParents, warn, wrap

Methods inherited from class java.lang.Object

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

Constructor Detail

Radio

public Radio(String id)

See Also:

WebMarkupContainer.WebMarkupContainer(String)

Radio

public Radio(String id,
             IModel<T> model)

Parameters:

id -

model -

See Also:

WebMarkupContainer.WebMarkupContainer(String, IModel)

Radio

public Radio(String id,
             RadioGroup<T> group)

Parameters:

id -

group - parent RadioGroup

See Also:

WebMarkupContainer.WebMarkupContainer(String)

Radio

public Radio(String id,
             IModel<T> model,
             RadioGroup<T> group)

Parameters:

id -

model -

group - parent RadioGroup

See Also:

WebMarkupContainer.WebMarkupContainer(String, IModel)

Method Detail

getValue

public String getValue()

Form submission value used for this radio component. This string will appear as the value of the value html attribute for the input tag.

Returns:

form submission value

getGroup

protected RadioGroup<T> getGroup()

Returns:

The associated radio group Component

onComponentTag

protected void onComponentTag(ComponentTag tag)

Description copied from class: Component

Processes the component tag. Overrides of this method most likely should call the super implementation.

Overrides:

onComponentTag in class Component

Parameters:

tag - the abstraction representing html tag of this component

See Also:

Component.onComponentTag(ComponentTag)

setLabel

public Radio<T> setLabel(IModel<String> labelModel)

The value will be made available to the validator property by means of ${label}. It does not have any specific meaning to Radio itself.

Overrides:

setLabel in class LabeledWebMarkupContainer

Parameters:

labelModel -

Returns:

this for chaining

getModel

public final IModel<T> getModel()

Description copied from interface: IGenericComponent

Typesafe getter for the model

Specified by:

getModel in interface IGenericComponent<T>

Returns:

the model

setModel

public final void setModel(IModel<T> model)

Description copied from interface: IGenericComponent

Typesafe setter for the model

Specified by:

setModel in interface IGenericComponent<T>

Parameters:

model - the new model

getModelObject

public final T getModelObject()

Description copied from interface: IGenericComponent

Typesafe getter for the model's object

Specified by:

getModelObject in interface IGenericComponent<T>

Returns:

the model object

setModelObject

public final void setModelObject(T object)

Description copied from interface: IGenericComponent

Typesafe setter for the model object

Specified by:

setModelObject in interface IGenericComponent<T>

Parameters:

object - the new model object

getStatelessHint

protected boolean getStatelessHint()

Returns whether the component can be stateless. Also the component behaviors must be stateless, otherwise the component will be treat as stateful. In order for page to be stateless (and not to be stored in session), all components (and component behaviors) must be stateless.

Overrides:

getStatelessHint in class Component

Returns:

whether the component can be stateless