Class RadioChoice<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.FormComponent<T>
-
- org.apache.wicket.markup.html.form.AbstractChoice<T,T>
-
- org.apache.wicket.markup.html.form.AbstractSingleSelectChoice<T>
-
- org.apache.wicket.markup.html.form.RadioChoice<T>
-
- Type Parameters:
T- The model object type
- All Implemented Interfaces:
java.io.Serializable,java.lang.Iterable<Component>,IEventSink,IEventSource,IFeedbackContributor,IConverterLocator,IGenericComponent<T,FormComponent<T>>,IMetadataContext<java.io.Serializable,Component>,IFormModelUpdateListener,IFormVisitorParticipant,ILabelProvider<java.lang.String>,IHeaderContributor,IRequestableComponent,org.apache.wicket.util.IHierarchical<Component>,org.apache.wicket.util.io.IClusterable
public class RadioChoice<T> extends AbstractSingleSelectChoice<T>
A choice subclass that shows choices in radio style.Java:
List SITES = Arrays.asList(new String[] { "The Server Side", "Java Lobby", "Java.Net" }); // Add a radio choice component that uses Input's 'site' property to designate the // current selection, and that uses the SITES list for the available options. form.add(new RadioChoice("site", SITES));HTML:<span style="vertical-align: top;" wicket:id="site"> <input type="radio">site 1</input> <input type="radio">site 2</input> </span>- Author:
- Jonathan Locke, Igor Vaynberg (ivaynberg)
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.wicket.markup.html.form.AbstractChoice
AbstractChoice.LabelPosition
-
-
Field Summary
-
Fields inherited from class org.apache.wicket.markup.html.form.FormComponent
FLAG_CONVERT_EMPTY_INPUT_STRING_TO_NULL, VALUE_SEPARATOR
-
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
-
-
Constructor Summary
Constructors Constructor Description RadioChoice(java.lang.String id)ConstructorRadioChoice(java.lang.String id, java.util.List<? extends T> choices)ConstructorRadioChoice(java.lang.String id, java.util.List<? extends T> choices, IChoiceRenderer<? super T> renderer)ConstructorRadioChoice(java.lang.String id, IModel<? extends java.util.List<? extends T>> choices)ConstructorRadioChoice(java.lang.String id, IModel<? extends java.util.List<? extends T>> choices, IChoiceRenderer<? super T> renderer)ConstructorRadioChoice(java.lang.String id, IModel<T> model, java.util.List<? extends T> choices)ConstructorRadioChoice(java.lang.String id, IModel<T> model, java.util.List<? extends T> choices, IChoiceRenderer<? super T> renderer)ConstructorRadioChoice(java.lang.String id, IModel<T> model, IModel<? extends java.util.List<? extends T>> choices)ConstructorRadioChoice(java.lang.String id, IModel<T> model, IModel<? extends java.util.List<? extends T>> choices, IChoiceRenderer<? super T> renderer)Constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidappendOptionHtml(org.apache.wicket.util.string.AppendingStringBuffer buffer, T choice, int index, java.lang.String selected)Generates and appends html for a single choice into the provided bufferprotected org.apache.wicket.util.value.IValueMapgetAdditionalAttributes(int index, T choice)You may subclass this method to provide additional attributes to the <input ..> tag.protected org.apache.wicket.util.value.IValueMapgetAdditionalAttributesForLabel(int index, T choice)You may subclass this method to provide additional attributes to the <label ..> tag.protected java.lang.CharSequencegetDefaultChoice(java.lang.String selectedValue)Not supported - does nothing.java.lang.StringgetPrefix()protected java.lang.StringgetPrefix(int index, T choice)java.lang.StringgetSuffix()protected java.lang.StringgetSuffix(int index, T choice)protected voidonComponentTag(ComponentTag tag)Processes the component tag.RadioChoice<T>setLabelPosition(AbstractChoice.LabelPosition labelPosition)Sets the preferred position of the <label> for each choiceRadioChoice<T>setPrefix(java.lang.String prefix)RadioChoice<T>setSuffix(java.lang.String suffix)-
Methods inherited from class org.apache.wicket.markup.html.form.AbstractSingleSelectChoice
convertChoiceIdToChoice, convertValue, getModelValue, getNullKey, getNullKeyDisplayValue, getNullValidDisplayValue, getNullValidKey, isNullValid, isSelected, setNullValid
-
Methods inherited from class org.apache.wicket.markup.html.form.AbstractChoice
detachModel, escapeOptionHtml, getChoiceRenderer, getChoices, getChoicesModel, isDisabled, localizeDisplayValues, onComponentTagBody, onDetach, setChoiceRenderer, setChoices, setChoices, setOptionAttributes, setType
-
Methods inherited from class org.apache.wicket.markup.html.form.FormComponent
add, add, checkRequired, clearInput, convertInput, error, getConvertedInput, getDefaultLabel, getDefaultLabel, getForm, getInput, getInputAsArray, getInputName, getRawInput, getType, getValidatorKeyPrefix, getValidators, getValue, hasRawInput, inputAsInt, inputAsInt, inputAsIntArray, inputChanged, internalOnModelChanged, invalid, isInputNullable, isMultiPart, isRequired, isValid, newValidatable, newValidationError, onDisabled, onInvalid, onValid, processChildren, processInput, remove, reportRequiredError, setConvertedInput, setLabel, setModelValue, setRequired, shouldTrimInput, trim, updateAutoLabels, updateCollectionModel, updateModel, valid, validate, validateRequired, validateValidators, visitComponentsPostOrder, visitFormComponentsPostOrder
-
Methods inherited from class org.apache.wicket.markup.html.form.LabeledWebMarkupContainer
getLabel
-
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, 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, 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, getStatelessHint, getString, getString, getString, getStyle, getVariation, hasBeenRendered, hasErrorMessage, hasFeedbackMessage, info, initModel, 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
-
-
-
-
Constructor Detail
-
RadioChoice
public RadioChoice(java.lang.String id)
Constructor- Parameters:
id- See Component- See Also:
Component(String),AbstractChoice(String)
-
RadioChoice
public RadioChoice(java.lang.String id, java.util.List<? extends T> choices)Constructor- Parameters:
id- See Componentchoices- The list of choices in the radio choice- See Also:
Component(String),AbstractChoice(String, List)
-
RadioChoice
public RadioChoice(java.lang.String id, java.util.List<? extends T> choices, IChoiceRenderer<? super T> renderer)Constructor- Parameters:
id- See Componentrenderer- The rendering enginechoices- The list of choices in the radio choice- See Also:
Component(String),AbstractChoice(String, List,IChoiceRenderer)
-
RadioChoice
public RadioChoice(java.lang.String id, IModel<T> model, java.util.List<? extends T> choices)Constructor- Parameters:
id- See Componentmodel- See Componentchoices- The list of choices in the radio choice- See Also:
Component(String, IModel),AbstractChoice(String, IModel, List)
-
RadioChoice
public RadioChoice(java.lang.String id, IModel<T> model, java.util.List<? extends T> choices, IChoiceRenderer<? super T> renderer)Constructor- Parameters:
id- See Componentmodel- See Componentchoices- The list of choices in the radio choicerenderer- The rendering engine- See Also:
Component(String, IModel),AbstractChoice(String, IModel, List,IChoiceRenderer)
-
RadioChoice
public RadioChoice(java.lang.String id, IModel<? extends java.util.List<? extends T>> choices)Constructor- Parameters:
id- See Componentchoices- The list of choices in the radio choice- See Also:
Component(String),AbstractChoice(String, IModel)
-
RadioChoice
public RadioChoice(java.lang.String id, IModel<T> model, IModel<? extends java.util.List<? extends T>> choices)Constructor- Parameters:
id- See Componentmodel- The model that is updated with changes in this component. See Componentchoices- The list of choices in the radio choice- See Also:
AbstractChoice(String, IModel,IModel),Component(String, IModel)
-
RadioChoice
public RadioChoice(java.lang.String id, IModel<? extends java.util.List<? extends T>> choices, IChoiceRenderer<? super T> renderer)Constructor- Parameters:
id- See Componentchoices- The list of choices in the radio choicerenderer- The rendering engine- See Also:
AbstractChoice(String, IModel,IChoiceRenderer),Component(String)
-
RadioChoice
public RadioChoice(java.lang.String id, IModel<T> model, IModel<? extends java.util.List<? extends T>> choices, IChoiceRenderer<? super T> renderer)Constructor- Parameters:
id- See Componentmodel- The model that is updated with changes in this component. See Componentchoices- The list of choices in the radio choicerenderer- The rendering engine- See Also:
Component(String, IModel),AbstractChoice(String, IModel, IModel,IChoiceRenderer)
-
-
Method Detail
-
onComponentTag
protected void onComponentTag(ComponentTag tag)
Description copied from class:FormComponentProcesses the component tag.- Overrides:
onComponentTagin classFormComponent<T>- Parameters:
tag- Tag to modify- See Also:
FormComponent.onComponentTag(org.apache.wicket.markup.ComponentTag)
-
getPrefix
public java.lang.String getPrefix()
- Returns:
- Prefix to use before choice
-
getPrefix
protected java.lang.String getPrefix(int index, T choice)- Parameters:
index- index of the choicechoice- the choice itself- Returns:
- Prefix to use before choice. The default implementation just returns
getPrefix(). Override to have a prefix dependent on the choice item.
-
getSuffix
protected java.lang.String getSuffix(int index, T choice)- Parameters:
index- index of the choicechoice- the choice itself- Returns:
- Separator to use between radio options. The default implementation just returns
getSuffix(). Override to have a prefix dependent on the choice item.
-
setPrefix
public final RadioChoice<T> setPrefix(java.lang.String prefix)
- Parameters:
prefix- Prefix to use before choice- Returns:
- this
-
getSuffix
public java.lang.String getSuffix()
- Returns:
- Separator to use between radio options
-
setSuffix
public final RadioChoice<T> setSuffix(java.lang.String suffix)
- Parameters:
suffix- Separator to use between radio options- Returns:
- this
-
setLabelPosition
public RadioChoice<T> setLabelPosition(AbstractChoice.LabelPosition labelPosition)
Sets the preferred position of the <label> for each choice- Parameters:
labelPosition- The preferred position for the label- Returns:
thisinstance, for chaining
-
getDefaultChoice
protected java.lang.CharSequence getDefaultChoice(java.lang.String selectedValue)
Not supported - does nothing.- Overrides:
getDefaultChoicein classAbstractSingleSelectChoice<T>- Parameters:
selectedValue- The currently selected value- Returns:
- Any default choice, such as "Choose One", depending on the subclass
- See Also:
AbstractSingleSelectChoice.getNullValidKey(),AbstractSingleSelectChoice.getNullKey(),AbstractChoice.getDefaultChoice(String)
-
appendOptionHtml
protected void appendOptionHtml(org.apache.wicket.util.string.AppendingStringBuffer buffer, T choice, int index, java.lang.String selected)Generates and appends html for a single choice into the provided buffer- Overrides:
appendOptionHtmlin classAbstractChoice<T,T>- Parameters:
buffer- Appending string buffer that will have the generated html appendedchoice- Choice objectindex- The index of this optionselected- The currently selected string value
-
getAdditionalAttributesForLabel
protected org.apache.wicket.util.value.IValueMap getAdditionalAttributesForLabel(int index, T choice)You may subclass this method to provide additional attributes to the <label ..> tag.- Parameters:
index- index of the choicechoice- the choice itself- Returns:
- tag attribute name/value pairs.
-
getAdditionalAttributes
protected org.apache.wicket.util.value.IValueMap getAdditionalAttributes(int index, T choice)You may subclass this method to provide additional attributes to the <input ..> tag.- Parameters:
index- index of the choicechoice- the choice itself- Returns:
- tag attribute name/value pairs.
-
-