Package 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, IFeedbackContributor, IConverterLocator, IGenericComponent<T,Radio<T>>, IMetadataContext<Serializable,Component>, ILabelProvider<String>, IHeaderContributor, IRequestableComponent, org.apache.wicket.util.IHierarchical<Component>, org.apache.wicket.util.io.IClusterable

public class Radio<T>
extends LabeledWebMarkupContainer
implements IGenericComponent<T,Radio<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_RESERVED1, FLAG_RESERVED2, FLAG_RESERVED3, FLAG_RESERVED4, FLAG_RESERVED5, FLAG_RESERVED8, PARENT_PATH, PATH_SEPARATOR, RENDER, RFLAG_CONTAINER_DEQUEING, RFLAG_CONTAINER_HAS_REMOVALS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected RadioGroup<T>	getGroup()
protected boolean	getStatelessHint()	Returns whether the component can be stateless.
String	getValue()	Form submission value used for the Html value attribute of the input tag.
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}.

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

getLabel, onDetach

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

getWebApplication, getWebPage, getWebRequest, getWebResponse, getWebSession

Methods inherited from class org.apache.wicket.MarkupContainer

add, addDequeuedComponent, addOrReplace, autoAdd, canDequeueTag, contains, dequeue, dequeue, dequeuePreamble, findChildComponent, findComponentToDequeue, get, getAssociatedMarkup, getAssociatedMarkupStream, getMarkup, getMarkupType, getRegionMarkup, internalAdd, internalInitialize, iterator, iterator, newDequeueContext, onComponentTagBody, onInitialize, onRender, queue, remove, remove, removeAll, renderAll, renderAssociatedMarkup, renderNext, replace, setDefaultModel, size, stream, streamChildren, toString, toString, visitChildren, visitChildren

Methods inherited from class org.apache.wicket.Component

add, addStateChange, beforeRender, canCallListener, canCallListenerAfterExpiry, checkComponentTag, checkComponentTagAttribute, checkHierarchyChange, clearOriginalDestination, configure, continueToOriginalDestination, createConverter, 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, getMarkupTag, 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, internalRenderComponent, internalRenderHead, isActionAuthorized, isAuto, isBehaviorAccepted, isEnableAllowed, isEnabled, isEnabledInHierarchy, isIgnoreAttributeModifier, isInitialized, isRenderAllowed, isRendering, isStateless, isVersioned, isVisibilityAllowed, isVisible, isVisibleInHierarchy, markRendering, modelChanged, modelChanging, newMarkupSourcingStrategy, onAfterRender, onBeforeRender, onConfigure, onEvent, onModelChanged, onModelChanging, onReAdd, onRemove, redirectToInterceptPage, remove, remove, render, renderComponentTag, rendered, renderHead, renderPart, renderPlaceholderTag, replaceComponentTagBody, replaceWith, sameInnermostModel, sameInnermostModel, send, setAuto, setDefaultModelObject, setEnabled, setEscapeModelStrings, setFlag, setIgnoreAttributeModifier, setMarkup, setMarkupId, setMarkupIdImpl, setMetaData, setOutputMarkupId, setOutputMarkupPlaceholderTag, setParent, setRenderBodyOnly, setResponsePage, setResponsePage, setResponsePage, setVersioned, setVisibilityAllowed, setVisible, success, urlFor, urlFor, urlFor, urlForListener, urlForListener, visitParents, visitParents, warn, wrap

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.wicket.IGenericComponent

getDefaultModel, getDefaultModelObject, getModel, getModelObject, setDefaultModel, setDefaultModelObject, setModel, setModelObject

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Radio

public Radio(String id)

See Also:

WebMarkupContainer(String)

Radio

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

Parameters:

id -

model -

See Also:

WebMarkupContainer(String, IModel)

Radio

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

Parameters:

id -

group - parent RadioGroup

See Also:

WebMarkupContainer(String)

Radio

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

Parameters:

id -

model -

group - parent RadioGroup

See Also:

WebMarkupContainer(String, IModel)

Method Detail

getValue

public String getValue()

Form submission value used for the Html value attribute of the input tag.

If Radios are recreated on each render of their RadioGroup, this method should be overridden to return a 'stable' value, otherwise its selection will be lost after a Form was submitted and resulted in Form.hasError().

Returns:

input 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

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